Integration Flow

The figure below shows the steps you need to follow to check and download details from the CKYC database.

Follow the below steps to check and download details from the CKYC database using ZWITCH APIs.

Check CKYC Registration
Download CKYC Details

1. Check CKYC Registration

Use the below endpoint to check if an individual or entity’s is registered in the CKYC database.

Endpoint

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

Shown below is the sample request and response for a Check CKYC Registration API.

{
  "purpose": "savings_account",
  "document_type": "pan",
  "document_number": "AAAPA1111A",
  "merchant_reference_id": "1673851924",
  "consent": true,
  "metadata": {
    "key_1": "DD",
    "key_2": "XoF"
  }
}

{
  "id": "ckyc_QAA7bOJ5mOLlarj7hKvtc4x0r",
  "object": "ckyc_verification",
  "purpose": "savings_account",
  "document_type": "pan",
  "document_number": "BBBBB1234B",
  "name": "Anil Reddy",
  "fathers_name": "Sunil Reddy",
  "ckyc_number": "78216949627381",
  "registration_type": "normal",
  "ckyc_date": "22-10-2018",
  "status": "success",
  "message": "success",
  "merchant_reference_id": "1004348",
  "entity_details": [
    {
      "entity_type": "proprietorship",
      "ckyc_number": "51444032827486",
      "name": "Anil Reddy Enterprises",
      "place_of_incorporation": "Bangalore",
      "ckyc_date": "2022-08-04",
      "ckyc_updated_date": "2022-08-03"
    }
  ],
  "conssent": true,
  "metadata": {
    "key_1": "DD",
    "key_2": "XoF"
  },
  "created_at": 1678365314,
  "updated_at": 1678365314,
  "is_sandbox": true
}

Learn more about the Check CKYC Registration API.

2. Download CKYC Details

Use the below endpoint to download details from the CKYC database.

Endpoint

POST: https://api.zwitch.io/v1/kycs/ckyc/ckyc_bdHKGM7ghPBWOxw7QOsflxKqw/download

Shown below is the sample request and response to download the CKYC details for an individual.

{
  "type":"individual",
  "ckyc_number": "9122192129",
  "date_of_birth" : "2020-12-31"
}

{
  "id": "ckyc_QAA7bOJ5mOLlarj7hKvtc4x0r",
  "type": "individual",
  "object": "ckyc_download.individual",
  "name": "Anil Reddy",
  "date_of_birth": "2020-12-31",
  "fathers_name": "Sunil Reddy",
  "ckyc_number": "78216949627381",
  "mobile_number": "9876543210",
  "email": "[email protected]",
  "address": [
    {
      "type": "permanent",
      "address": "211B BAKER STREET, BANGALORE - 560005",
      "city": "BANGALORE_URBAN",
      "postal_code": "560005",
      "state_code": "KA"
    },
    {
      "type": "communication",
      "address": "211B BAKER STREET, BANGALORE - 560005",
      "city": "BANGALORE_URBAN",
      "postal_code": "560005",
      "state_code": "KA"
    }
  ],
  "registration_type": "normal",
  "status": "success",
  "message": "success",
  "consent": true,
  "is_sandbox": true,
  "created_at": 1678365314,
  "updated_at": 1678368241
}

Shown below is the sample request and response to download the CKYC details for an entity.

{
  "type":"entity",
  "ckyc_number": "9122192129",
  "date_of_incorporation": "2020-12-31"
}

{
  "id": "ckyc_QAA7bOJ5mOLlarj7hKvtc4x0r",
  "type": "entity",
  "object": "ckyc_download.entity",
  "fathers_name": null,
  "date_of_incorporation": "2020-12-31",
  "mobile_number": "7019452349",
  "email": "[email protected]",
  "address": [
    {
      "type": "permanent",
      "address": "211B BAKER STREET, BANGALORE - 560005",
      "city": "BANGALORE_URBAN",
      "postal_code": "560005",
      "state_code": "KA"
    },
    {
      "type": "communication",
      "address": "211B BAKER STREET, BANGALORE - 560005",
      "city": "BANGALORE_URBAN",
      "postal_code": "560005",
      "state_code": "KA"
    }
  ],
  "registration_type": null,
  "entity_details": {
    "entity_type": "proprietorship",
    "name": "Anil Reddy Enterprises",
    "ckyc_number": "51444032827486",
    "place_of_incorporation": "Bangalore",
    "ckyc_date": "2022-08-04",
    "ckyc_updated_date": "2022-08-03"
  },
  "status": "success",
  "message": "success",
  "consent": true,
  "is_sandbox": true,
  "created_at": 1678365314,
  "updated_at": 1678366793
}

Learn more about the Download CKYC API.