Sandbox - KYC & Onboarding

This section explains how to simulate various scenarios as part of the CKYC Search API of Decentro.

CKYC Search

CKYC Search API can be used by the platform to check if they are present on the CKYC repository. The platform can access the download ONLY if the customer is present with the repository. The response of the CKYC Search API contains a 14-digit CKYC number that can be used to download the customer's KYC data by the platform.

The simulated responses in CKYC Search, Decentro provides all CKYC customers with a testbed environment that simulates all the various scenarios that are possible.

The testbed API can be accessed by prepending testbed to the CKYC Search API. So, the API for the testbed will be hosted on /testbed/v2/kyc/ckyc/search in the staging environment.

The following list details all possible scenarios along with the required request bodies and responses.

Scenarios for success_ckyc_search

1. Using PAN as input

{
    "reference_id": "DEC001",
    "document_type": "PAN",
    "id_number": "ABCDE1234A",
    "consent": true,
    "consent_purpose": "For bank account purpose"
}
{
    "decentroTxnId": "DECXXXXXXXXXXXXXXXXXXXXXXXXXXX",
    "status": "SUCCESS",
    "responseCode": "S00000",
    "data": {
        "kycStatus": "SUCCESS",
        "kycResult": {
            "ckycId": "XXXXXXXXXXXXXX",
            "fullName": "Manish Gupta",
            "age": "25",
            "kycDate": "DD-MM-YYYY",
            "updatedDate": "14-04-2020",
            "fathersFullName": "XXXXXXXXXXXXXXXXX",
            "imageType": "JPG",
            "photo": "<Base64 Image>",
            "identityDetails": {
                "identity": [
                    {
                        "status": "03",
                        "type": "PAN"
                    }
                ]
            }
        },
        "message": "KYC Details for CKYC retrieved successfully."
    },
    "responseKey": "success_ckyc_search"
}

2. Using Aadhaar as input

{
    "reference_id": "DEC001",
    "document_type": "AADHAAR",
    "id_number": "9876|CARL SMITH|29-03-1993|M",
    "consent": true,
    "consent_purpose": "For bank account purpose"
}
{
    "decentroTxnId": "DECXXXXXXXXXXXXXXXXXXXXXXXXXXX",
    "status": "SUCCESS",
    "responseCode": "S00000",
    "data": {
        "kycStatus": "SUCCESS",
        "kycResult": {
            "ckycId": "XXXXXXXXXXXXXX",
            "fullName": "MR MANISH GUPTA",
            "age": "25",
            "kycDate": "DD-MM-YYYY",
            "updatedDate": "DD-MM-YYYY",
            "fathersFullName": "XXXXXXXXXXXXXXXXXXX",
            "imageType": "jpg",
            "photo": "<Base64 Image>",
            "identityDetails": {
                "identity": [
                    {
                        "status": "03",
                        "type": "Aadhaar"
                    }
                ]
            }
        },
        "message": "KYC Details for CKYC retrieved successfully."
    },
    "responseKey": "success_ckyc_search"
}

3. Using Voter ID as input

{
    "reference_id": "DEC001",
    "document_type": "VOTERID",
    "id_number": "ABC0123456",
    "consent": true,
    "consent_purpose": "For bank account purpose"
}
{
    "decentroTxnId": "DECXXXXXXXXXXXXXXXXXXXXXXXXXXX",
    "status": "SUCCESS",
    "responseCode": "S00000",
    "data": {
        "kycStatus": "SUCCESS",
        "kycResult": {
            "ckycId": "XXXXXXXXXXXXXX",
            "fullName": "MR MANISH GUPTA",
            "age": "25",
            "kycDate": "DD-MM-YYYY",
            "updatedDate": "DD-MM-YYYY",
            "fathersFullName": "XXXXXXXXXXXXXXXXXXXX",
            "imageType": "jpg",
            "photo": "<Base64 Image>",
            "identityDetails": {
                "identity": [
                    {
                        "status": "03",
                        "type": "Aadhaar"
                    },
                    {
                        "status": "03",
                        "type": "Voter ID"
                    }
                ]
            }
        },
        "message": "KYC Details for CKYC retrieved successfully."
    },
    "responseKey": "success_ckyc_search"
}

4. Using Passport as input

{
    "reference_id": "DEC001",
    "document_type": "PASSPORT",
    "id_number": "A1111111",
    "consent": true,
    "consent_purpose": "For bank account purpose"
}
{
    "decentroTxnId": "DECXXXXXXXXXXXXXXXXXXXXXXXXXXX",
    "status": "SUCCESS",
    "responseCode": "S00000",
    "data": {
        "kycStatus": "SUCCESS",
        "kycResult": {
            "ckycId": "XXXXXXXXXXXXXX",
            "fullName": "Manish Gupta",
            "age": "25",
            "kycDate": "DD-MM-YYYY",
            "updatedDate": "14-04-2020",
            "fathersFullName": "XXXXXXXXXXXXXXXXX",
            "imageType": "JPG",
            "photo": "<Base64 Image>",
            "identityDetails": {
                "identity": [
                    {
                        "status": "03",
                        "type": "PAN"
                    }
                ]
            }
        },
        "message": "KYC Details for CKYC retrieved successfully."
    },
    "responseKey": "success_ckyc_search"
}

5. Using Driving License as input

{
    "reference_id": "DEC001",
    "document_type": "DRIVING_LICENSE",
    "id_number": "ABXXXXXXXXXXXXX",
    "consent": true,
    "consent_purpose": "For bank account purpose"
}
{
    "decentroTxnId": "DECXXXXXXXXXXXXXXXXXXXXXXXXXXX",
    "status": "SUCCESS",
    "responseCode": "S00000",
    "data": {
        "kycStatus": "SUCCESS",
        "kycResult": {
            "ckycId": "XXXXXXXXXXXXXX",
            "fullName": "MR MANISH GUPTA",
            "age": "25",
            "kycDate": "DD-MM-YYYY",
            "updatedDate": "DD-MM-YYYY",
            "fathersFullName": "XXXXXXXXXXXXXXXXXX",
            "imageType": "jpg",
            "photo": "<Base64 Image>",
            "identityDetails": {
                "identity": [
                    {
                        "status": "03",
                        "type": "Driving License"
                    }
                ]
            }
        },
        "message": "KYC Details for CKYC retrieved successfully."
    },
    "responseKey": "success_ckyc_search"
}

6. Using CKYC Number as input

{
    "reference_id": "DEC001",
    "document_type": "CKYC",
    "id_number": "0123456789123",
    "consent": true,
    "consent_purpose": "For bank account purpose"
}
{
    "decentroTxnId": "DECXXXXXXXXXXXXXXXXXXXXXXXXXXX",
    "status": "SUCCESS",
    "responseCode": "S00000",
    "data": {
        "kycStatus": "SUCCESS",
        "kycResult": {
            "ckycId": "XXXXXXXXXXXXXX",
            "fullName": "Manish Gupta",
            "age": "25",
            "kycDate": "DD-MM-YYYY",
            "updatedDate": "14-04-2020",
            "fathersFullName": "XXXXXXXXXXXXXXXXX",
            "imageType": "JPG",
            "photo": "<Base64 Image>",
            "identityDetails": {
                "identity": [
                    {
                        "status": "03",
                        "type": "PAN"
                    }
                ]
            }
        },
        "message": "KYC Details for CKYC retrieved successfully."
    },
    "responseKey": "success_ckyc_search"
}