KYC ID Mobile Link Status

Introduction

The KYC ID-Mobile Link Status API is a secure and efficient tool that allows organizations to verify whether a given KYC ID number is linked to a specified mobile phone number. By giving the KYC ID number and the mobile number, the API returns a confirmation of the linkage status, aiding in seamless identity verification and enhancing security measures across various services.

API details

Endpoint

POST https://api.signzy.app/api/v3/mobile/kycid-link-status

POST https://api-preproduction.signzy.app/api/v3/mobile/kycid-link-status

Request body parameters

Parameter	Data Type	Description	Required
kycId	String	KYC ID number	Mandatory
mobileNumber	String	Mobile number linked with the given KYC ID number	Mandatory

{
    "mobileNumber": "8770610878",
    "kycId": "471309874582"
}

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/mobile/kycid-link-status' \
--header 'Content-Type: application/json' \
--data '{
    "mobileNumber": "<mobile number>",
    "kycId": "<kyc id>"
}'

Response body parameters

Parameter	Data Type	Description
result	Object	Contains the response for the input KYC ID number and mobile number.
result.message	String	Indicates whether linked or Not Linked.
result.linked	Boolean	Possible values are true or false.
reason	String	Indicates the category or cause of the response. "REQUEST_SUCCESSFUL", "BAD_REQUEST", "CONFLICT"
code	String	Response code for tracking. • "S001" — Success • "E001" — Validation or input error etc • "E401" — Upstream Down

// Passing invalid KYC ID number
{
  "result": {},
  "message": "Incorrect KYC ID format",
  "reason": "BAD_REQUEST",
  "code": "E001"
}

// Passing non-string KYC ID number
{
  "result": {},
  "message": "KYC ID must be a string",
  "reason": "BAD_REQUEST",
  "code": "E001"
}

// KYC ID is an empty string
{
  "result": {},
  "message": "KYC ID is not allowed to be an empty string",
  "reason": "BAD_REQUEST",
  "code": "E001"
}

// When kyc id is not provided in request
{
  "result": {},
  "message": "KYC ID is required",
  "reason": "BAD_REQUEST",
  "code": "E001"
}

// Passing invalid Mobile Number
{
  "result": {},
  "message": "Incorrect Mobile number format",
  "reason": "BAD_REQUEST",
  "code": "E001"
}

// Passing non-string Mobile Number
{
  "result": {},
  "message": "Mobile number must be a string",
  "reason": "BAD_REQUEST",
  "code": "E001"
}

// Mobile Number is an empty string
{
  "result": {},
  "message": "Mobile number is not allowed to be any empty string",
  "reason": "BAD_REQUEST",
  "code": "E001"
}

// When Mobile Number is not provided in request
{
  "result": {},
  "message": "Mobile number is required",
  "reason": "BAD_REQUEST",
  "code": "E001"
}

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!