API Docs

2. Download CKYC Details

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

Use this API to download details of an individual or entity from the CKYC database.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

📘

Test Data

The table below lists the various dates you can use to mock different scenarios in the Download CKYC API.

DateScenario
Any date (in the valid format)Successfully download CKYC details.
1900-01-01Returns 422 error for the Download CKYC Details API.
Path Params
string
required

Unique identifier of the check CKYC registration request in ZWITCH database.

Example: ckyc_y60V1ZWa4oVpShsisqTf03Gvt

Body Params
string
required

Type of CKYC details which you want to download.

Possible values"

  • individual
  • entity

string
required

CKYC number for which details should be downloaded.

Example: 12345678900987

boolean
required
Defaults to true

Consent of the individual or entity to download their details from the CKYC database.

Possible value: true

string

Mandatory when type is individual

Date of birth of the individual who's CKYC details is to be downloaded.

Possible format:YYYY-MM-DD

Has to be 10 characters.

Example: 1987-12-31

Supported characters:

  • 0-9
  • -

string

Mandatory when type is entity

Date when the entity was registered.

Possible format: YYYY-MM-DD

Has to be 10 characters.

Example: 2022-12-31

Supported characters:

  • 0-9
  • -

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated over 2 years ago

Did this page help you?
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated over 2 years ago

Did this page help you?