KYC ID Basic verification API

Introduction

The KYC ID Basic Verification API serves as a vital tool for instantaneously verifying the validity of KYC ID numbers. It quickly determines whether the provided number is valid on a real-time basis, streamlining the process for businesses and organizations that need to authenticate identities.

API details

Endpoint

POST https://api.signzy.app/api/v3/identity/basicVerify

POST https://api-preproduction.signzy.app/api/v3/identity/basicVerify

Request body parameters

Parameter	Data Type	Description	Required
kycid	String	KYC ID number to be verified.	Mandatory
consent	String	Consent of the ID owner. Y for Yes, N for No. It should be Y for the request to be processed.	Mandatory

{
  "kycid": "XXXXXXXX445",
  "consent": "Y"
}

Request Headers

Name	Value	Required	Description
Content-type	application/json	Mandatory	The type of content that the request body contains.
Authorization	XXXXXXXXXXXXXXX	Mandatory	An authentication token to authorize the request. Reach out to the Signzy support team to get one created.

Code Samples

curl --location 'https://api-preproduction.signzy.app/api/v3/id/basicVerify' \
--header 'Content-Type: application/json' \
--header 'Authorization: <Authorization token>' \
--data '{
    "kycid": "<KYC-ID>",
    "consent":"Y/N"
}'

Response body parameters

Parameter	Data Type	Description
result	Object	Contains the response for the input KYC ID.
result.verified	String	Possible values are true or false.
result.kycid	String	Masked KYC ID
message	String	Descriptive message about the response. Possible values include: • "Success" • "Invalid kycId" • "kycId must be a string" • "kycId is not allowed to be an empty string" • "Need consent" • "consent can only be Y or N" • "consent is not allowed to be an empty string" • "Invalid input data" • "Data not found"
reason	String	Indicates the category or cause of the response. "REQUEST_SUCCESSFUL", "BAD_REQUEST", "DATA_NOT_FOUND".
code	String	Response code for tracking. • "S001" — Success • "E001" — Validation or input error etc • "E301" — No data found

{
    "result": {
        "verified": true,
        "kycId": "XXXXXXXX3445"
    },
    "message": "Success",
    "reason": "REQUEST_SUCCESSFUL",
    "code": "S001"
}

Contact Us for Any Assistance

If you have any questions or need assistance, please reach out to our customer support team. You can contact us via email at [email protected]. We strive to provide prompt and reliable assistance, ensuring your queries are addressed effectively.

We value your feedback and are committed to making your experience smooth and enjoyable. Our team is dedicated to assisting you with any needs you may have. Thank you for choosing our services. We look forward to helping you!