1. Check CKYC Registration

post

https://api.zwitch.io/v1/kycs/ckyc

Use this API to check if an individual is registered in the CKYC database.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

📘
Test Data
The table below lists the various PANs you can use to mock different scenarios in the Check CKYC Registration API.

PAN Scenario
Any PAN (in the valid format) Return individual CKYC details.
BBBBB1234B Return sole proprietorship CKYC details.
AAAAA1234A Returns failed status for the CKYC API.

PAN	Scenario
Any PAN (in the valid format)	Return individual CKYC details.
BBBBB1234B	Return sole proprietorship CKYC details.
AAAAA1234A	Returns `failed` status for the CKYC API.

Body Params

purpose

string

required

The reason you are checking if an individual or entity is registered in the CKYC database.

Possible values:

savings_account
current_account

document_type

string

required

Type of KYC document used to check if an individual or entity is registered in the CKYC database.

Possible value: pan

document_number

string

required

KYC document number used to check if an individual or entity is registered in the CKYC database.

Example: AAAPA0000A

Individual's or entity's consent to check if they are registered in the CKYC database.

Possible value: true

merchant_reference_id

string

required

Unique identifier entered when creating the request.

Only alphabets and numbers are allowed.
Minimum: 7 characters.
Maximum: 40 characters.

Example: 14096850

metadata

object

Key-value pair that can be used to store additional information about the entity.

Note:

Maximum 5 key-value pairs.
Maximum 256 characters in the metadata object.
You cannot pass a URL.
You cannot use \.

Example: "key_1": "DD"

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

📘Test Data

200200

401401

422422

📘
Test Data