CKYC Secured Search API Ver1.2
CKYC Secured Search API Ver1.2
Non-Confidential
Secured Search API Document | Version 1.2
Table of Contents
Non-Confidential
Secured Search API Document | Version 1.2
Non-Confidential
Secured Search API Document | Version 1.2
1.1 Introduction
This web service is used to search different IDs for CKYC verification. This is applicable for
registered Financial Institutions. Both CERSAI and Financial Institution should share their public
key while registering for this service. Financial Institution should configure their IP address
through Upload Public Key interface in CKYC application that can be accessed by Institution
admins. The following table provides details on CKYC Verification -Interface Properties:
Property Value
Service URL (Test bed) https://testbed.ckycindia.in/Search/ckycverificationservice/verify
Service URL (Live) https://www.ckycindia.in/Search/ckycverificationservice/verify
Request type Application/XML
Response type Application/XML
Request Digitally signed Yes
Non-Confidential
Secured Search API Document | Version 1.2
1.2 Request
Request should be digitally signed using FI’s Private Key and its public key should be shared with
CERSAI at the time of registering for this service. Personal Identity Data (PID) should be encrypted
using session key and Session key should be encrypted using public key provided by CERSAI so it
can be decrypt only with CERSAI’s private key. The encrypted PID and session key should be
encoded to Base64 string. User can follow the below steps for encryption.
Please note that the ciphers for encryption have been upgraded.
</CKYC_INQ>
</REQ_ROOT>
Non-Confidential
Secured Search API Document | Version 1.2
1.2.3.1 Request-Individual:
<HEADER>
<FI_CODE>IN0106</FI_CODE>
<REQUEST_ID>02</REQUEST_ID>
<VERSION>1.2</VERSION>
</HEADER>
<CKYC_INQ>
<PID>huoJx9wQ266EicUOdIinE+hJNxbyILKvTmfy8qTsQkcTXNrhLPJ5U67LmbJzPUEa71Et
NGT57sqCvGFYSBeGv2pjXkTOoMvsZETwq+6rrB+LiYuy+X7nTuNqXdPxTRHCLHoJSaQrSR7
gb3SlepkmfbscxMj9w8h3d/p+ig3F+C4duc+Aom20Bj8R5+4zVMkcB7gr5j5odVwzP5PTilt+
bsrJwjRAXSp7VKohJ5+MTJ4=</PID>
<SESSION_KEY>ZlziyLF37bykRkzj4FyjIVx6EvMd/6u5wzPVSAkepdMG6odsN6Kix15fVAvItx
uXz1x9EZzrfyD2moawxVvl2grX3yAO8HQe1Hx9aY61QTAAcq4ApthnObUmIcFIosS8QoD5
gt0k1NdQ3qPRVcOukRDrgZgKQIQNgtDeSdrI9WtUWNCBveiREJoVqJsLjCOkSoyQOmVTw
AWjayGdEyuyceorYeFZDhnDtRrI+lkyGIkDmIx3m5zem5vKrPro13P8RgVZ/Al8AzkgKUyInC
5da7pQ/RkewFrbLAEuUkrFSF4MdKrBS+sMX07NxWk7mOtK6dafT2OJpL+yk2EfZtXemQ==
</SESSION_KEY>
</CKYC_INQ>
<Signature
xmlns="http://www.w3.org/2000/09/xmldsig#"><SignedInfo><CanonicalizationMethod
Algorithm="http://www.w3.org/TR/2001/REC-xml-c14n-
20010315"/><SignatureMethod Algorithm="http://www.w3.org/2000/09/xmldsig#rsa-
sha1"/><Reference URI=""><Transforms><Transform
Algorithm="http://www.w3.org/2000/09/xmldsig#enveloped-
signature"/></Transforms><DigestMethod
Algorithm="http://www.w3.org/2000/09/xmldsig#sha1"/><DigestValue>m8ytZjJS6tFELs
YJvrSpvxS81Bc=</DigestValue></Reference></SignedInfo><SignatureValue>e55kdxdWu
wghAvsT7UgIkIUXkBBA28EBuvwqcenBBt9PVV5qs/0WbwFJu7EGEbE3zpbP6sGSN761
Non-Confidential
Secured Search API Document | Version 1.2
SIAx13UGq504lES+PIeJudj8OWKmUZgQvSaB0DoYYCNpIqYUzkn93ufnr5L6Wf+q9utua0A
8FRoe
voy0DEBidROxzRVvZ84IyP74kZ2vFFCADqWOjHXUiczwsnGhvAtd6I80BU+2CJJXhDpM7w5
NtzA7
R2nXNC2PvEswGA7lCW53tZ1WoY1p6ty30wl/f4SvP/kHkiSU7QRRFy+QTjO3S21bdWAybp
u9dg1/
i5tMwtPlpNNNUsYAWHvPSV40bNJ5wBL/A7hTqg==</SignatureValue></Signature></RE
Q_ROOT>
Note :
1.2.3.4 Request-Legal:
<HEADER>
Non-Confidential
Secured Search API Document | Version 1.2
<FI_CODE>IN0106</FI_CODE>
<REQUEST_ID>02</REQUEST_ID>
<VERSION>1.2</VERSION>
</HEADER>
<CKYC_INQ>
<PID>ZlD8IUwYgoGGmhUeOoP2SDP6IaQez2MKi6IKozlWMRbxCKVuEROQLHfwLV2C6X7x
BOfExHVkKwqSdE1wMe+NKi9Qy5nI6SUQe8z3SpWxZ5xWjyDphNZxZYXCuGqqMIsg5TFn
6HBs1zx+nJDp2y5C7LQ41b9Ld1UaNVBJDOfuyYY8jncWzZrNxVXD3+UrCnZH79qdkjXmhe
qBxBsNxfLdLz2x96/Qnf6X2Up1qIHrFUu9Ulj3LzRkkoAiB8zBrs/y</PID>
<SESSION_KEY>hNkloqvfwh1UYoRmiZdof1bnikbk8vq9CDktVjsBoHPy/9mpLSa6f6GwHl/z
hruKpNDFOHCGdMoUP779TwH9Deieq6IM7YBv4wuYtudBa1eGG/lv2xptenlKsF/hrZhXQ
Oh5byikGCMm0lFcZoaKW9lgfEKVQ3TXc1QLIVDEUxZQUa3daplxZNdQ97zhl8RFMz/IDqEq
hCSaYGlAJl9RY60CT43gjefCxFFN7/U5+hyi+dm2YMX1/6AmzFriAjmg4gKSPgxekA+QAfgHg
QTIGSka3GZVDHeNo/W+3hK1ydDtai3skI4LPSabwTfoIPCdcCJFdXIV5q7zOYcLJg815Q==</
SESSION_KEY>
</CKYC_INQ>
<Signature
xmlns="http://www.w3.org/2000/09/xmldsig#"><SignedInfo><CanonicalizationMethod
Algorithm="http://www.w3.org/TR/2001/REC-xml-c14n-
20010315"/><SignatureMethod Algorithm="http://www.w3.org/2000/09/xmldsig#rsa-
sha1"/><Reference URI=""><Transforms><Transform
Algorithm="http://www.w3.org/2000/09/xmldsig#enveloped-
signature"/></Transforms><DigestMethod
Algorithm="http://www.w3.org/2000/09/xmldsig#sha1"/><DigestValue>m8ytZjJS6tFELs
YJvrSpvxS81Bc=</DigestValue></Reference></SignedInfo><SignatureValue>e55kdxdWu
wghAvsT7UgIkIUXkBBA28EBuvwqcenBBt9PVV5qs/0WbwFJu7EGEbE3zpbP6sGSN761
SIAx13UGq504lES+PIeJudj8OWKmUZgQvSaB0DoYYCNpIqYUzkn93ufnr5L6Wf+q9utua0A
8FRoe
voy0DEBidROxzRVvZ84IyP74kZ2vFFCADqWOjHXUiczwsnGhvAtd6I80BU+2CJJXhDpM7w5
NtzA7
R2nXNC2PvEswGA7lCW53tZ1WoY1p6ty30wl/f4SvP/kHkiSU7QRRFy+QTjO3S21bdWAybp
u9dg1/
Non-Confidential
Secured Search API Document | Version 1.2
i5tMwtPlpNNNUsYAWHvPSV40bNJ5wBL/A7hTqg==</SignatureValue></Signature>
</REQ_ROOT>
Non-Confidential
Secured Search API Document | Version 1.2
1.3 Response
Response should be digitally signed using CERSAI’s Private Key and its public key will be available
to FIs. Personal Identity Data (PID) should be encrypted using session key and Session key should
be encrypted using public key provided by FI so it can be decrypt only with FI’s private key. The
encrypted PID and session key should be encoded to Base64 string. Customer image will be send
as a Base64 encrypted string. User can follow the below steps for encryption.
Non-Confidential
Secured Search API Document | Version 1.2
<STATUS/>
</ID>
</ID-LIST>
<REMARKS/>
</PID_DATA>
</PID>
<SESSION_KEY/>
<ERROR />
</CKYC_INQ>
</REQ_ROOT>
<SearchResponsePID>
<CKYC_NO />
<NAME />
<FATHERS_NAME />
<AGE />
<IMAGE_TYPE />
<PHOTO />
<KYC_DATE />
<UPDATED_DATE />
<ID-LIST>
<ID>
<TYPE/>
<STATUS/>
</ID>
</ID-LIST>
<REMARKS/>
</SearchResponsePID>
</PID_DATA>
</PID>
Non-Confidential
Secured Search API Document | Version 1.2
<SESSION_KEY/>
<ERROR />
</CKYC_INQ>
</REQ_ROOT>
<REQ_ROOT>
<HEADER>
<FI_CODE>IN0106</FI_CODE>
<REQ_DATE>17-10-2016</REQ_DATE>
<VERSION>1.2</VERSION>
</HEADER>
<CKYC_INQ>
<CKYC_NO>10041581114235</CKYC_NO>
<NAME>Alex</NAME>
<FATHERS_NAME>Raj</FATHERS_NAME>
<AGE>27.0</AGE>
<IMAGE_TYPE>jpg</IMAGE_TYPE>
<PHOTO>/9j/4AAQSkZJRgABAQEAYABgAAD/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsL
DBkSEw8UHRofHh0aHBwgJC4nICIsIxwcWLMegVVBLHqcAHgE9Aa8+h/aA8HzTxxSWmrwI
Non-Confidential
Secured Search API Document | Version 1.2
7hWlkgjKoCfvHbITgdeAT6A0Aeu0Vh6B4h0rxHpY1HR75Lu03FNSexZ/m4OfougAook45Nb
FFABRRRQAUUUUAFFFFABRRRQAUUUUAFFFFABRRRQAUUUUAFFFFABRRRQAUUUUAFF
FFABRRRQAUUUUAFFFFABRRRQAUUUUAFFFFABRRRQAUUUUAFFFFABRRRQAUUUUAFF
FFABRRRQAUUUUAFFFFABRRRQAUUUUAFFFFABRRRQAUUUUAFFFFABRRRQAUUUUAFF
FFABRRRQAUUUUAFFFFABRRRQB//2Q==</PHOTO>
<KYC_DATE>06-09-2016</KYC_DATE>
<UPDATED_DATE>15-09-2016</UPDATED_DATE>
<ID_LIST>
<ID>
<TYPE>E</TYPE>
<STATUS>03</STATUS>
</ID>
<ID>
<TYPE>F</TYPE>
<STATUS>02</STATUS>
</ID>
</ID_LIST>
<REMARKS>done</REMARKS>
</PID_DATA>
</PID>
<SESSION_KEY>Fs+Ergv4flMZ5hgb/U3DPVyj9FdEYIReZQcl2gqm3IrP7/EL/N8vrFj2MSJZiFL
2ikOn4yYho4EEI76HDN7MKoRSEwOEH+smer8Ng/7ymiirB/L0AlLuyQv78H005ZbefdkWip
0hQPglaocGQC1qy2T0kis9ugYEMjibgt1WUVSiLdOv2PHGqbrXbh+Airvih/Rk92tyMQHz1D
kXlgsCu++dDkMShYYKfh30Ed8Xg7R/1NHJe3NJId97fcPWDykMEqKWvDVJsS6LlS3JF46hyV
UsNOSY2hvugMGaHod6Er0TPwh2s8iH2KhVR3c9rCL+h5HP7pC8roo7U4vIuN/ysw==</SE
SSION_KEY>
</CKYC_INQ>
Non-Confidential
Secured Search API Document | Version 1.2
</REQ_ROOT>
<PID_DATA>
<CKYC_NO>10041581114235</CKYC_NO>
<NAME>Alex</NAME>
<FATHERS_NAME>Raj</FATHERS_NAME>
<AGE>27.0</AGE>
<IMAGE_TYPE>jpg</IMAGE_TYPE>
<PHOTO>/9j/4AAQSkZJRgABAQEAYABgAAD/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsL
DBkSEw8UHRofHh0aHBwgJC4nICIsIxwcWLMegVVBLHqcAHgE9Aa8+h/aA8HzTxxSWmrwI
7hWlkgjKoCfvHbITgdeAT6A0Aeu0Vh6B4h0rxHpY1HR75Lu03FNSexZ/m4OfougAook45Nb
FFABRRRQAUUUUAFFFFABRRRQAUUUUAFFFFABRRRQAUUUUAFFFFABRRRQAUUUUAFF
FFABRRRQAUUUUAFFFFABRRRQAUUUUAFFFFABRRRQAUUUUAFFFFABRRRQAUUUUAFF
FFABRRRQAUUUUAFFFFABRRRQAUUUUAFFFFABRRRQAUUUUAFFFFABRRRQAUUUUAFF
FFABRRRQAUUUUAFFFFABRRRQB//2Q==</PHOTO>
<KYC_DATE>06-09-2016</KYC_DATE>
<UPDATED_DATE>15-09-2016</UPDATED_DATE>
<ID_LIST>
<ID>
<TYPE>E</TYPE>
<STATUS>03</STATUS>
</ID>
<ID>
<TYPE>F</TYPE>
Non-Confidential
Secured Search API Document | Version 1.2
<STATUS>02</STATUS>
</ID>
</ID_LIST>
<REMARKS>done</REMARKS>
</PID_DATA>
1.3.3.3 PID_DATA in response when ID type is C (PAN):
<PID_DATA>
<SearchResponsePID>
<CKYC_NO>10041581114235</CKYC_NO>
<NAME>uigiguiguigiuguigui</NAME>
<FATHERS_NAME>vuiviviviug</FATHERS_NAME>
<AGE>27.0</AGE>
<IMAGE_TYPE>jpg</IMAGE_TYPE>
<PHOTO>/9j/4AAQSkZJRgABAQEAYABgAAD/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsL
DBkSEw8UHRofHh0aHBwgJC4nICIsIxwcWLMegVVBLHqcAHgE9Aa8+h/aA8HzTxxSWmrwI
7hWlkgjKoCfvHbITgdeAT6A0Aeu0Vh6B4h0rxHpY1HR75Lu03FNSexZ/m4OfougAook45Nb
FFABRRRQAUUUUAFFFFABRRRQAUUUUAFFFFABRRRQAUUUUAFFFFABRRRQAUUUUAFF
FFABRRRQAUUUUAFFFFABRRRQAUUUUAFFFFABRRRQAUUUUAFFFFABRRRQAUUUUAFF
FFABRRRQAUUUUAFFFFABRRRQAUUUUAFFFFABRRRQAUUUUAFFFFABRRRQAUUUUAFF
FFABRRRQAUUUUAFFFFABRRRQB//2Q==</PHOTO>
<KYC_DATE>06-09-2016</KYC_DATE>
<UPDATED_DATE>15-09-2016</UPDATED_DATE>
<ID_LIST>
<ID>
<TYPE>E</TYPE>
Non-Confidential
Secured Search API Document | Version 1.2
<STATUS>03</STATUS>
</ID>
<ID>
<TYPE>F</TYPE>
<STATUS>02</STATUS>
</ID>
</ID_LIST>
<REMARKS>done</REMARKS>
</SearchResponsePID>
<SearchResponsePID>
<CKYC_NO>60013907454980</CKYC_NO>
<NAME>fdgdfgdfgdfgi </NAME>
<AGE>33</AGE>
<IMAGE_TYPE>JPG</IMAGE_TYPE>
<PHOTO>/9j/4AAQSkZJRgABAQEAyADIAAD/4QDCRXhpZgAASUkqAAgAAAANAP4ABAAB
AAAAAAAAAAABAwABAAAAhQEAAAEBAwABAAAAjwAAAAIBAwABAAAAAQAAAAMBAw
ABAAAABAAAAAYBAwABAAAAAADFThEBBAABAAAACAAAABUBAwABAAAAAQB/PxYBB
AABAAAAjwAAABcBBAABAAAA0AMAABoBBQABAAAAqgAAABsBBQABAAAAsgAAACgBA
wtBUAfv9RRRQAUUUUAFFFFABRRRQAUUUUAFFFFABRRRQAUUUUAFFFFABRRRQAUUU
UAFFFFABRRRQAUUUUAFFFFABRRRQAUUUUAFFFFABRRRQAUUUUAFFFFABRRRQAUUU
UAFFFFAH4A/8HR3/ACgo/bm/7tm/9bD/AGfaP+DXH/lBR+wz/wB3M/8ArYf7QVH/AAdHf
8oKP25v+7Zv/Ww/2faP+DXH/lBR+wz/AN3M/wDrYf7QVAH7/UUUUAf/2Q==</PHOTO>
<KYC_DATE>03-01-2020</KYC_DATE>
<UPDATED_DATE>02-01-2020</UPDATED_DATE>
16|Secured Search API
Non-Confidential
Secured Search API Document | Version 1.2
<ID_LIST>
<ID>
<TYPE>A</TYPE>
<STATUS>03</STATUS>
</ID>
<ID>
<TYPE>E</TYPE>
<STATUS>03</STATUS>
</ID>
<ID>
<TYPE>C</TYPE>
<STATUS>03</STATUS>
</ID>
</ID_LIST>
<REMARKS>done</REMARKS>
</SearchResponsePID>
</PID_DATA>
<REQ_ROOT>
<HEADER>
<FI_CODE>IN0106</FI_CODE>
Non-Confidential
Secured Search API Document | Version 1.2
<REQ_DATE>17-10-2020</REQ_DATE>
<VERSION>1.2</VERSION>
</HEADER>
<CKYC_INQ>
<PID><?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<PID_DATA>
<CKYC_NO>90033545959659</CKYC_NO>
<NAME> ARP limited</NAME>
<CONSTITUTION_TYPE>K-Artificial Liability Partnership</CONSTITUTION_TYPE>
<PLACE_OF_INCORPORATION>chennai</PLACE_OF_INCORPORATION>
<AGE>0</AGE>
<KYC_DATE>30-07-2020</KYC_DATE>
<UPDATED_DATE>30-07-2020</UPDATED_DATE>
<ID_LIST>
<ID>
<TYPE>01</TYPE>
<STATUS></STATUS>
</ID>
<ID>
<TYPE>04</TYPE>
<STATUS></STATUS>
</ID>
<ID>
<TYPE>05</TYPE>
<STATUS></STATUS>
</ID>
Non-Confidential
Secured Search API Document | Version 1.2
<ID>
<TYPE>06</TYPE>
<STATUS></STATUS>
</ID>
<ID>
<TYPE>07</TYPE>
<STATUS></STATUS>
</ID>
<ID>
<TYPE>08</TYPE>
<STATUS></STATUS>
</ID>
<ID>
<TYPE>03</TYPE>
<STATUS></STATUS>
</ID>
<ID>
<TYPE>02</TYPE>
<STATUS></STATUS>
</ID>
</ID_LIST>
<REMARKS></REMARKS>
</PID_DATA>
</PID>
<SESSION_KEY>Fs+Ergv4flMZ5hgb/U3DPVyj9FdEYIReZQcl2gqm3IrP7/EL/N8vrFj2MSJZiFL
2ikOn4yYho4EEI76HDN7MKoRSEwOEH+smer8Ng/7ymiirB/L0AlLuyQv78H005ZbefdkWip
0hQPglaocGQC1qy2T0kis9ugYEMjibgt1WUVSiLdOv2PHGqbrXbh+Airvih/Rk92tyMQHz1D
kXlgsCu++dDkMShYYKfh30Ed8Xg7R/1NHJe3NJId97fcPWDykMEqKWvDVJsS6LlS3JF46hyV
Non-Confidential
Secured Search API Document | Version 1.2
UsNOSY2hvugMGaHod6Er0TPwh2s8iH2KhVR3c9rCL+h5HP7pC8roo7U4vIuN/ysw==</SE
SSION_KEY>
</CKYC_INQ>
</REQ_ROOT>
1.3.3.5 PID_DATA in response - Legal:
<PID_DATA>
<CKYC_NO>90033545959659</CKYC_NO>
Non-Confidential
Secured Search API Document | Version 1.2
<ID>
<TYPE>06</TYPE>
<STATUS></STATUS>
</ID>
<ID>
<TYPE>07</TYPE>
<STATUS></STATUS>
</ID>
<ID>
<TYPE>08</TYPE>
<STATUS></STATUS>
</ID>
<ID>
<TYPE>03</TYPE>
<STATUS></STATUS>
</ID>
<ID>
<TYPE>02</TYPE>
<STATUS></STATUS>
</ID>
</ID_LIST>
<REMARKS></REMARKS>
</PID_DATA>
Non-Confidential
Secured Search API Document | Version 1.2
The following table provides details on CKYC Verification -Request Parameters for
Individual/Legal:
Non-Confidential
Secured Search API Document | Version 1.2
• Aadhaar – Last 4
digits of Aadhaar
number
• Applicant Name –
(Maximum 150
characters including
FirstName,
MiddleName and
LastName)
• DOB Format should
be DD-MM-YYYY (10
characters)
• Gender – M/F/T (1
Character)
F NREGA Job Card 40 Maximum 40 characters. String All
G National Population 20
Register Letter
Z CKYC Identifier 14 14 digit Number String All
02 Certificate of 60 Maximum 60 characters. String All
Incorporation/Formation
03 Registration Certificate 60 Maximum 60 characters. String All
Non-Confidential
Secured Search API Document | Version 1.2
Non-Confidential
Secured Search API Document | Version 1.2
Non-Confidential
Secured Search API Document | Version 1.2
IF proper encryption is not used Session Key Decryption error. Please encrypt with correct
for appropriate version. public Key
Non-Confidential
Secured Search API Document | Version 1.2
If KYC no. size is not 14 digits KYC Number should be of length 14 digits
If entered 14 digit no. does not KYC Number <<KYC_NO>> does not exists in system
exist
Non-Confidential
Secured Search API Document | Version 1.2
1.5 FI Configuration
Institutions should upload their Public key and configure their IP through this interface before
sending the request to the server.
Non-Confidential