0% found this document useful (0 votes)
160 views28 pages

CKYC Secured Search API Ver1.2

Uploaded by

Aman kumar
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
160 views28 pages

CKYC Secured Search API Ver1.2

Uploaded by

Aman kumar
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 28

Central KYC Registry

Secured Search API Document


Version 1.2

Non-Confidential
Secured Search API Document | Version 1.2

Table of Contents

1.2 Request ................................................................................................................................................... 5


1.2.1 Client side:- ...................................................................................................................................... 5
1.2.2 Request format: - ............................................................................................................................ 5
1.2.3 Sample Request ............................................................................................................................... 6
1.2.3.1 Request-Individual: .................................................................................................................. 6
1.2.3.2 PID_DATA in request – Individual: .......................................................................................... 7
1.2.3.3 PID_DATA in request when ID Type is E (UID): ....................................................................... 7
1.2.3.4 Request-Legal: .......................................................................................................................... 7
1.2.3.5 PID_DATA in request – Legal: .................................................................................................. 9
1.3 Response............................................................................................................................................... 10
1.3.1 Client side:- .................................................................................................................................... 10
1.3.2 Response Format: - ....................................................................................................................... 10
1.3.2.1 Response :- ................................................................................................................................. 10
1.3.2.2 Response when ID type is C (PAN):- .......................................................................................... 11
1.3.3 Sample Response .......................................................................................................................... 12
1.3.3.1 Response for Individual: ........................................................................................................ 12
1.3.3.2 PID_DATA in response - Individual: ....................................................................................... 14
1.3.3.3 PID_DATA in response when ID type is C (PAN): .................................................................. 15
1.3.3.4 Response for Legal: ................................................................................................................ 17
1.3.3.5 PID_DATA in response - Legal:............................................................................................... 20
1.4 Web Services Details ............................................................................................................................ 22
1.4.1 Request Parameters for Individual and Legal .............................................................................. 22
1.4.2 ID Type code .................................................................................................................................. 22
1.4.3 Response Parameters for Individual ............................................................................................ 23
1.4.4 Response Parameters for Legal .................................................................................................... 24
1.4.5 Error Messages .............................................................................................................................. 26
1.5 FI Configuration .................................................................................................................................... 28

2|Secured Search API

Non-Confidential
Secured Search API Document | Version 1.2

Document Update history

Date Version Remarks


- 1 Original Document
- 1.1 Original Document
- 1.2 Original Document
- 1.2 Document Update - Response parameters of Individual and Legal Entity
09-Mar-21 1.2 Sample for Individual and Legal
Document Update: Removal of <SearchResponsePID> tag in sample
24-Mar-21 1.2
provided in section 1.3.3.4 & 1.3.3.5
11-Jun-21 1.2 Document Update: Service URL (Live) rectified
Document Update: Placement of <SESSION_KEY/> tag (1.2.2, 1.3.2.1 &
05-Dec-23 1.2
1.3.2.2)

3|Secured Search API

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

4|Secured Search API

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.

1.2.1 Client side:-


1) Generate a random 256 bit session key.
2) Encrypt PID and timestamp using this session key by AES algorithm.
3) Encode the encrypted PID to Base64 string
4) Encrypt the session key using public key provided by CERSAI using RSA algorithm.
5) Encode the encrypted session key to Base64 string
6) Add this encrypted and encoded session key in request xml.
7) Sign entire request using FI's private key.

Please note that the ciphers for encryption have been upgraded.

1.2.2 Request format: -


Request format remains the same for Individual and Legal
<REQ_ROOT>
<HEADER>
<FI_CODE />
<REQUEST_ID />
<VERSION />
</HEADER>
<CKYC_INQ>
<PID>
<PID_DATA>
<DATE_TIME />
<ID_TYPE />
<ID_NO />
</PID_DATA>
</PID>
<SESSION_KEY/>

</CKYC_INQ>
</REQ_ROOT>

5|Secured Search API

Non-Confidential
Secured Search API Document | Version 1.2

1.2.3 Sample Request

1.2.3.1 Request-Individual:

<?xml version="1.0" encoding="UTF-8"?><REQ_ROOT>

<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

6|Secured Search API

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>

1.2.3.2 PID_DATA in request – Individual:


<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<PID_DATA>
<DATE_TIME>22-11-2016 10:09:22</DATE_TIME>
<ID_NO>D4567890</ID_NO>
<ID_TYPE>A</ID_TYPE>
</PID_DATA>

1.2.3.3 PID_DATA in request when ID Type is E (UID):


<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<PID_DATA>
<DATE_TIME>22-11-2016 10:09:22</DATE_TIME>
<ID_NO>UID|ApplicantName|DOB|Gender</ID_NO>
<ID_TYPE>E</ID_TYPE>
</PID_DATA>

Note :

• UID : Please enter last 4 digits of UID Number


• "|" character should be used as a separator.
• ApplicantName : FirstName+MiddleName+LastName (Applicant Name should be
same as provided during KYC Upload/Update)
• DOB Format : DD-MM-YYYY
• Gender : M/F/T (Size 1)

1.2.3.4 Request-Legal:

<?xml version="1.0" encoding="UTF-8"?><REQ_ROOT>

<HEADER>

7|Secured Search API

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/

8|Secured Search API

Non-Confidential
Secured Search API Document | Version 1.2

i5tMwtPlpNNNUsYAWHvPSV40bNJ5wBL/A7hTqg==</SignatureValue></Signature>

</REQ_ROOT>

1.2.3.5 PID_DATA in request – Legal:


<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<PID_DATA>
<DATE_TIME>22-11-2020 10:09:22</DATE_TIME>
<ID_NO>D4567890</ID_NO>
<ID_TYPE>C</ID_TYPE>
</PID_DATA>

9|Secured Search API

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.

1.3.1 Client side:-


1) Verify signature using CERSAI’s public key.
2) Parse key parameter from request message.
3) Decode the session key from Base64 string.
4) Decrypt above key using FI’s private key with RSA algorithm so we will get session key.
5) Decode the PID from Base64 string.
6) Decrypt data using session key with AES algorithm.
7) Update of Cipher mode for decryption.

1.3.2 Response Format: -


Response format remains the same for Individual and Legal
1.3.2.1 Response :-
<REQ_ROOT>
<HEADER>
<FI_CODE />
< REQUEST_ID />
<REQ_DATE />
<VERSION />
</HEADER>
<CKYC_INQ>
<PID>
<PID_DATA>
<CKYC_NO />
<NAME />
<FATHERS_NAME />
<AGE />
<IMAGE_TYPE />
<PHOTO />
<KYC_DATE />
<UPDATED_DATE />
<ID-LIST>
<ID>
<TYPE/>

10|Secured Search API

Non-Confidential
Secured Search API Document | Version 1.2

<STATUS/>
</ID>
</ID-LIST>
<REMARKS/>
</PID_DATA>
</PID>
<SESSION_KEY/>

<ERROR />
</CKYC_INQ>
</REQ_ROOT>

1.3.2.2 Response when ID type is C (PAN):-


<REQ_ROOT>
<HEADER>
<FI_CODE />
< REQUEST_ID />
<REQ_DATE />
<VERSION />
</HEADER>
<CKYC_INQ>
<PID>
<PID_DATA>

<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>

11|Secured Search API

Non-Confidential
Secured Search API Document | Version 1.2

<SESSION_KEY/>

<ERROR />
</CKYC_INQ>
</REQ_ROOT>

1.3.3 Sample Response


1.3.3.1 Response for Individual:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

<REQ_ROOT>

<HEADER>

<FI_CODE>IN0106</FI_CODE>

<REQ_DATE>17-10-2016</REQ_DATE>

< REQUEST_ID>02</ REQUEST_ID>

<VERSION>1.2</VERSION>

</HEADER>

<CKYC_INQ>

<PID><?xml version="1.0" encoding="UTF-8" standalone="yes"?>


<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

12|Secured Search API

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>

13|Secured Search API

Non-Confidential
Secured Search API Document | Version 1.2

</REQ_ROOT>

1.3.3.2 PID_DATA in response - Individual:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

<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>

14|Secured Search API

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):

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

<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>

15|Secured Search API

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>

<FATHERS_NAME>mr Make erw</FATHERS_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>

1.3.3.4 Response for Legal:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

<REQ_ROOT>

<HEADER>

<FI_CODE>IN0106</FI_CODE>

17|Secured Search API

Non-Confidential
Secured Search API Document | Version 1.2

<REQ_DATE>17-10-2020</REQ_DATE>

< REQUEST_ID>02</ REQUEST_ID>

<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>

18|Secured Search API

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

19|Secured Search API

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:

<?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>

20|Secured Search API

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>

21|Secured Search API

Non-Confidential
Secured Search API Document | Version 1.2

1.4 Web Services Details

1.4.1 Request Parameters for Individual and Legal

The following table provides details on CKYC Verification -Request Parameters for
Individual/Legal:

CKYC Verification-Request Description Mandatory


Parameters Field Name
FI_CODE FI code provided by CKYC Yes
DATE Current date(dd-MM-yyyyHH:mm:ss) Yes
VERSION 1.2 Yes
ID_TYPE ID Type code Yes
ID_NO ID Number Yes
REQUEST_ID Should be unique throughout the day for an FI. Yes

1.4.2 ID Type code

Code Category Character Validation Data Type of


Type Account
A Passport Number 20 First digit alphabet then String All
seven-digit number.
B Voter ID 20 String All

C PAN 10 First three digits any String All


alphabets, 4th digit in
ABCFGHJLPT, 5th digit any
alphabet, 6th to 9th digit
any numbers and last digit
any alphabet
D Driving License 20 String All

E Proof Of Possession of 165 Maximum 165 characters String All


Aadhaar

22|Secured Search API

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

1.4.3 Response Parameters for Individual

The following table provides details on CKYC Verification -Response Parameters:

S.No Field Field Field Mandatory Remarks / XML TAG


Type Length / Optional Details
1 FI Code String 6 Mandatory FI Code FI_CODE
2 Date DATE 10 Mandatory REQ_DATE
3 CKYC 14 digit 14/15 Mandatory CKYC number CKYC_NO
Identifier number, corresponding
Alphabet to serial number
as a in request file
prefix
4 Applicant String 150 Mandatory NAME
Full Name

23|Secured Search API

Non-Confidential
Secured Search API Document | Version 1.2

5 Applicant's String 150 Mandatory FATHERS_NAME


Fathers Full
Name
6 Applicants Number 2 Mandatory AGE
Age
7 Applicant String Mandatory Photo as Base64 PHOTO
Photo encoded string
8 KYC DATE 10 Mandatory DD-MM-YYYY KYC_DATE
Generation
Date
9 Last DATE 10 Mandatory DD-MM-YYYY UPDATED_DATE
Updated on
10 Remarks String 200 Validation REMARKS
failure or
Record doesn't
exist
11 Request Id Number 8 Mandatory Should be REQUEST_ID
unique
throughout the
day for an FI.
12 Image Type String 5 Mandatory Extension of IMAGE_TYPE
Photo
Identity Details
13 ID Type String 2 Mandatory Proof of Identity TYPE
Submitted
14 ID Status String 2 Optional Proof of Identity STATUS
Status

1.4.4 Response Parameters for Legal

The following table provides details on CKYC Verification -Response Parameters:

S.N Field Field Field Mandator Remarks / XML TAG


o Type Lengt y/ Details
h Optional
1 FI Code String 6 Mandator FI Code FI_CODE
y

24|Secured Search API

Non-Confidential
Secured Search API Document | Version 1.2

2 Date DATE 10 Mandator REQ_DATE


y
3 CKYC Numbe 14 Mandator CKYC CKYC_NO
Identifier r y number
correspondin
g to serial
number in
request file
4 Applicant String 150 Mandator NAME
Full Name y
5 Constitution String 2 Mandator Constitution CONSTITUTION_TYPE
Type y Type
6 Applicants Numbe 2 Mandator AGE
Age r y

7 Place of String 150 Mandator Where PLACE_OF_INCORPORATI


Incorporatio y Constitution ON
n type is other
than '01'

8 KYC DATE 10 Mandator DD-MM- KYC_DATE


Generation y YYYY
Date
9 Last DATE 10 Mandator DD-MM- UPDATED_DATE
Updated on y YYYY
10 Remark String 200 Validation REMARKS
failure or
Record
doesn't exist
11 Request Id Numbe 8 Mandator Should be REQUEST_ID
r y unique
throughout
the day for
an FI.
Identity Details

25|Secured Search API

Non-Confidential
Secured Search API Document | Version 1.2

12 ID Type String 2 Mandator Proof of TYPE


y Identity
Submitted
13 ID Status String 2 Optional Proof of STATUS
Identity
Status

1.4.5 Error Messages

The following table lists the error messages

Scenario Error Message


Digital signature verification Digital signature cannot be verified. The certificate is
failed expired.
Incorrect ID type or ID Number Validation failure
Request Id size greater than 8 Request Id should not exceed more than 8 digits
Request Id is not unique Request Id is not unique
throughout the day for an FI.
Incorrect FI Code Institution does not exists
No records found No records found
Time difference between Time difference should be less than 5 minutes
request and response is more
than 5 minute

IP not registered Please configure your IP address.


IP does not match with the The given IP does not match with the institution’s
registered IP registered IP.

IF proper encryption is not used Session Key Decryption error. Please encrypt with correct
for appropriate version. public Key

If session key is not generated PID Data Decoding error


properly

26|Secured Search API

Non-Confidential
Secured Search API Document | Version 1.2

Invalid request date Invalid Date-Time Stamp. The format is dd-MM-yyyy


hh:mm:ss

If version number is not entered Please enter version number

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

If version no given is 1.0 and Please enter individual KYC number


invalid KYC no given

27|Secured Search API

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.

28|Secured Search API

Non-Confidential

You might also like