CKYC

Instantpay's CKYC (Central Know Your Customer) API solution streamlines the Know Your Customer process by offering businesses a comprehensive solution to verify customer identity using PAN details and the customers' date of birth. Adapt the CKYC API to enhance due diligence, ensuring seamless onboarding with verified and up-to-date KYC details

Header Parameters

NameTypeDescriptionMandatory (M) , Optional (O)Provided by INSTANTPAY (Y/N)
X-Ipay-Auth-CodeStringAuth Code is "1" (Fixed)MY
X-Ipay-Client-IdStringUnique Client Id Provided by InstantpayMY
X-Ipay-Client-SecretStringUnique Client Secret Provided by InstantpayMY
X-Ipay-Endpoint-IpStringEnd customer IP AddressMY

Request Parameters

Parameter NameTypeRequirementDescription
panNumberStringMandatoryPan Number
dobStringMandatoryDate of Birth(YYYY-MM-DD)
latitudeStringMandatoryEnd Customer Latitude.
longitudeStringMandatoryEnd Customer Longitude
externalRefStringMandatoryYour Unique Transaction id
consentStringMandatoryConsent should be
accepted by
customer

Sample Request

curl --location 'https://api.instantpay.in/identity/ckyc' \
--header 'X-Ipay-Auth-Code: {{authCode}}' \
--header 'X-Ipay-Client-Id: {{clientId}}' \
--header 'X-Ipay-Client-Secret: {{clientSecret}}' \
--header 'X-Ipay-Endpoint-Ip: {{endPointIP}}' \
--header 'X-Ipay-Request-Hash: 123456789|123456789|123456789|123456789|123456789|123456789|1234' \
--header 'X-Ipay-Request-Timestamp: 1659943695791' \
--header 'X-Ipay-Hash-Check: OFF' \
--header 'User-Agent: InstantPayAPITest/1.0.0' \
--header 'Content-Type: application/json' \
--data '{
    "panNumber":"AAOCS6028B",
    "dob":"1997-09-03",
    "consent":"Y",
    "latitude":0.99,
    "longitude":38,
    "externalRef":"jdnjdi89"
}'
POST /identity/ckyc HTTP/1.1
Host: api.instantpay.in
X-Ipay-Auth-Code: 2
X-Ipay-Client-Id: wiDLYLyGQc+21HPiah76S/HiAhx8pc2Hmkc9sXb7RDM=
X-Ipay-Client-Secret: a3d33c38bae71eca82bed090a1d0a757280563a2ed732521d20b8b78e2486190
X-Ipay-Endpoint-Ip: 14.142.186.142
X-Ipay-Request-Hash: 123456789|123456789|123456789|123456789|123456789|123456789|1234
X-Ipay-Request-Timestamp: 1659943695791
X-Ipay-Hash-Check: OFF
User-Agent: InstantPayAPITest/1.0.0
Content-Type: application/json
Content-Length: 146

{
    "panNumber":"BQUPJ2729J",
    "dob":"1997-09-03",
    "consent":"Y",
    "latitude":0.99,
    "longitude":38,
    "externalRef":"jdnjdi89"
}

Response Parameters

Parameter NameTypeDescription
statuscodeStringInstantpay Status Code
actcodeStringAction Code
statusArrayStatus message
dataStringResponse Data(if Present)
timestampStringResponse time (YYYY-MM-DD HH:II:SS)
ipay_uuidStringRequest reference number
orderidStringTransaction Id(if transaction otherwise it is null)
environmentStringLive/Sandbox
internalCodeStringIt will be null

Sample Response

{
    "statuscode": "TXN",
    "actcode": null,
    "status": "Transaction Successful",
    "data": {
        "ckycDetail": {
            "personalDetails": {
                "constituitonType": "Individual",
                "accountType": "Normal",
                "ckycNumber": "1234567890",
                "userPrefix": "MR",
                "userFirstName": "Sample",
                "userLastName": "Name",
                "userFullName": "MR Sample  Name",
                "userFatherPrefix": "MR",
                "userFatherFirstName": "Sample  ",
                "userFatherLastName": "Name",
                "userFatherFullName": "MR Sample Name",
                "userMotherPrefix": "MRS",
                "userMotherFirstName": " Sample",
                "userMotherLastName": "Name",
                "userMotherFullName": "MR Sample Name",
                "userGender": "MALE",
                "userDob": "03-09-1997",
                "userPan": "AT*****9B",
                "addressPermanentLine1": "Address Line 1",
                "addressPermanentLine2": "Address Line 2",
                "addressPermanentLine3": "Locality Name",
                "addressPermanentCity": "City Name",
                "addressPermanentDistrict": "District Name",
                "addressPermanentState": "BR",
                "addressPermanentCountry": "IN",
                "addressPermanentPin": "Pincode",
                "addressPermanetPoa": "Driving License",
                "permanetCorrespondenceSameFlag": "Y",
                "addressCorrespondenceLine1": "Address Line 1",
                "addressCorrespondenceLine2": "Address Line 2",
                "addressCorrespondenceLine3": "Locality Name",
                "addressCorrespondenceCity": "City Name",
                "addressCorrespondenceDistrict": "Patna",
                "addressCorrespondenceState": "BR",
                "addressCorrespondenceCountry": "IN",
                "addressCorrespondencePin": "Pincode",
                "addressCorrespondencePoa": "03",
                "userMobileCode": "91",
                "userMobileNumber": "7428585742"
                "userEmail": "[email protected]",
                "declarationDate": "30-01-2023",
                "declarationPlace": "DELHI",
                "kycDate": "********",
                "documentSubmitted": "Certified Copies",
                "kycName": "********",
                "kycDesignation": "********",
                "kycBranch": "********",
                "kycEmpCode": "********",
                "numIdentity": "3",
                "numRelated": "0",
                "numImages": "5"
            },
            "identityDetails": {
                "identity": [
                    {
                        "sequenceNo": "1",
                        "identityType": "Driving Licence",
                        "identityNumber": "********",
                        "idVerificationStatus": "NO"
                    },
                    {
                        "sequenceNo": "2",
                        "identityType": "Proof of Possession of Aadhaar",
                        "identityNumber": "XXXXXXXX6077",
                        "idVerificationStatus": "NO"
                    },
                    {
                        "sequenceNo": "3",
                        "identityType": "E-KYC Authentication",
                        "identityNumber": "XXXXXXXX6077",
                        "idVerificationStatus": "NO"
                    }
                ]
            },
            "imageDetails": {
                "image": [
                    {
                        "sequenceNo": "1",
                        "imageType": "JPG",
                        "imageCode": "Proof of Possession of Aadhaar",
                        "globalFlag": "1",
                        "branchCode": "CPUB001",
                        "imageData": "*********"
                    },
                    {
                        "sequenceNo": "2",
                        "imageType": "JPEG",
                        "imageCode": "Photograph",
                        "globalFlag": "1",
                        "branchCode": "CPUB001",
                        "imageData": "********"
                    },
                    {
                        "sequenceNo": "3",
                        "imageType": "JPG",
                        "imageCode": "Signature",
                        "branchCode": "HOBR",
                        "imageData": "*******"
                    },
                    {
                        "sequenceNo": "4",
                        "imageType": "PDF",
                        "imageCode": "E-KYC Authentication",
                        "branchCode": "NORTH01BR",
                        "imageData": "**********"
                    },
                    {
                        "sequenceNo": "5",
                        "imageType": "JPG",
                        "imageCode": "Driving License",
                        "branchCode": "002BR",
                        "imageData": "******"
            }
        },
        "pool": {
            "referenceId": "1231031122531GUZRH",
            "openingBalance": "19.60",
            "paymentAmount": "11.80",
            "mode": "DR",
            "closingBalance": "7.80"
        }
    },
    "timestamp": "2023-10-31 12:25:31",
    "ipay_uuid": "h0689a7fc392-8e42-4f9d-9956-43ba00fc09c4-Djy5KDTZj6DW",
    "orderid": "1231031122531GUZRH",
    "environment": "LIVE",
    "internalCode": null
}
Language
Click Try It! to start a request and see the response here!