Response Parameters

Returns following user details in JSON format:

#	Response Parameter	Description	Mandatory (Yes/ No)
1	FI Code	ID Provided by CKYC to client	Yes
2	Session ID	Unique ID for the Request session	Yes
3	CKYC_Request_ID	dd-MM-yyyy	Yes
4	Status	Status Code of API Response	Yes
5	Status Description	Status Description of API Response	Yes
6	CKYC Number	As received in response from CKYC	Yes
7	Applicant Prefix	As received in response from CKYC	Yes
8	Full Name	As received in response from CKYC	Yes
9	Gender	As received in response from CKYC	Yes
10	Father/Spouse Type	As received in response from CKYC	Yes
11	Father/Spouse Prefix	As received in response from CKYC	Yes
12	Father/Spouse Full Name	As received in response from CKYC	Yes
13	Mother Prefix	As received in response from CKYC	Yes
14	Mother Full Name	As received in response from CKYC	Yes
15	DOB	As received in response from CKYC	Yes
16	PAN Number	As received in response from CKYC	Yes
17	Proof of Identity Number	As received in response from CKYC	Yes
18	Proof of Identity Type	As received in response from CKYC	Yes
19	Photo	As received in response from CKYC	Yes
20	KYC Verification Date	As received in response from CKYC	Yes
21	Location of KYC	As received in response from CKYC	Yes
22	Proof of Identity Image	As received in response from CKYC	No
23	Proof of Identity Image code	As received in response from CKYC	No
24	Proof of Current Address Image	As received in response from CKYC	Yes
25	Proof of Current Address Image code	As received in response from CKYC	Yes
26	Signature Image	As received in response from CKYC	Yes
27	Permanent Address 1	As received in response from CKYC	Yes
28	Permanent Address 2	As received in response from CKYC	Yes
29	Permanent Address 3	As received in response from CKYC	Yes
30	Permanent Address - City/Town/Village	As received in response from CKYC	Yes
31	Permanent Address - District	As received in response from CKYC	Yes
32	Permanent Address - State	As received in response from CKYC	Yes
33	Permanent Address - Country	As received in response from CKYC	Yes
34	Permanent Address - Pin code	As received in response from CKYC	Yes
35	Permanent Address - PoA Type	As received in response from CKYC	Yes
36	Current Address 1	As received in response from CKYC	Yes
37	Current Address 2	As received in response from CKYC	Yes
38	Current Address 3	As received in response from CKYC	Yes
39	Current Address -City/ Town/ Village	As received in response from CKYC	Yes
40	Current Address - District	As received in response from CKYC	Yes
41	Current Address - State	As received in response from CKYC	Yes
42	Current Address - Country	As received in response from CKYC	Yes
43	Current Address - Pin code	As received in response from CKYC	Yes
44	Current Address - PoA Type	As received in response from CKYC	Yes
45	Mobile Number	As received in response from CKYC	No
46	email ID	As received in response from CKYC	No
47	Photo image Type	As received in response from CKYC , image format ex: jpg,pdf,etc...	No
No	Signature Image Code	As received in response from CKYC	Yes
49	Signature Image Type	As received in response from CKYC , image format ex: jpg,pdf,etc...	Yes
50	Proof of Identity Image Type	As received in response from CKYC , image format ex: jpg,pdf,etc...	Yes
51	Proof of Current Address Image Type	As received in response from CKYC , image format ex: jpg,pdf,etc...	Yes

Sample Decryption Response:

{
 OiDyaAXtRU5DFSm8D6RbUj6PU0EL9gf/dIIP2YPRcf7a/PNPOOysumrUYxtr00FcvuhLUynsaffPgCOjr83Rx UuwIgPDvMNSLoVz4HhNDw+dwvqNZ3+CmSV9U68C+abkWUWPF2ZNZSrIXXPsbQPp+5pMRZgz6JiviJ hXnhYanb+sdAiSvv2di+MyFanhMWhvQWygdYTDiTYGNp4PPh8NE0NRdXK1NN80T48bPxVxcsEbPwh5 UWQRJdzKn66KQWN8MFgdqWf3D09+tKivqxLWyVsCcajLnF4YTs9PHsyxH0GoYKx5WyD8lAomoH9Tvs Rj7F6hm6qoriQplcibEkNj................QGkYQQ55XhUD2lgqEYSU0ZJBymMcOxYb97Vn1xRCrebzg2COW3l OkZ5c/A==
}

Sample Plain Response:

{ 
   "Status":"CSS000", 
   "StatusDecription":"Success", 
   "SessionID":"202301111322397xxxxxx", 
   "Res_Ref_No":"202301111336599xxxxxxxxxx", 
   "FI_Code":"IN100xx", 
   "CKYC_Request_ID":”xxxxxxxx”, 
   "CKYC_No":”xxxxxxxxxx”,    "Applicant_Prefix":”xxxxxxxxxx ”, 
   "Applicant_FullName":”xxxxxxxxxx ”, 
   "DOB":”xxxxxxxxxx ”, 
   "Gender":”xxxxxxxxxx”, 
   "PAN":”xxxxxxxxxx”, 
   "Mobile":”xxxxxxxxxx”, 
   "email_id":”xxxxxxxxxx”, 
   "Fatherspouse_Flag":”xxxxxxxxxx ”, 
   "Father_Spouse_Prefix":”xxxxxxxxxx ”, 
   "Father_Spouse_FullName":”xxxxxxxxxx ”, 
   "Mother_Prefix":”xxxxxxxxxx ”, 
   "Mother_FullName":”xxxxxxxxxx ”, 
   "Proof_Id_Type":”xxxxxxxxxx ”, 
   "Proof_Id_Num":”xxxxxxxxxx ”, 
   "KYC_Date":”xxxxxxxxxx ”, 
   "Location_of_Kyc":”xxxxxxxxxx ”, 
   "Perm_Type":”xxxxxxxxxx ”, 
   "Perm_Address_1":”xxxxxxxxxx ”, 
   "Perm_Address_2":”xxxxxxxxxx ”, 
   "Perm_Address_3":”xxxxxxxxxx ”, 
   "Perm_City":”xxxxxxxxxx ”, 
   "Perm_District":”xxxxxxxxxx ”, 
   "Perm_State":”xxxxxxxxxx ”, 
   "Perm_Country":”xxxxxxxxxx ”, 
   "Perm_Pincode":”xxxxxxxxxx ”, 
   "Corres_Type":”xxxxxxxxxx ”, 
   "Corres_Address_1":”xxxxxxxxxx ”, 
   "Corres_Address_2":”xxxxxxxxxx ”, 
   "Corres_Address_3":”xxxxxxxxxx ”, 
   "Corres_City":”xxxxxxxxxx ”, 
   "Corres_District":”xxxxxxxxxx ”, 
   "Corres_State":”xxxxxxxxxx ”, 
   "Corres_Country":”xxxxxxxxxx ”, 
   "Corres_Pincode":”xxxxxxxxxx ”, 
   "Sign_Img":”Base64String”, 
   "Sign_Img_Code":”xx”, 
   "Sign_Img_Type":”xxx”, 
   "Proof_Id_Img":”Base64String”, 
   "Proof_Id_Img_Code":”xx”, 
   "Proof_Id_Img_Type":”xxx”, 
   "Proof_Addr_Img":”Base64String”, 
   "Proof_Addr_Img_Code":”xx”, 
   "Proof_Addr_Img_Type":”xxx”, 
   "Photo_Img":”Base64String”, 
   "Photo_Img_Type":”xxx” 
} 

Sample Failure Plain Response:

{
 "Status": "CSS002",
 "StatusDecription": "Invalid request",
 "SessionID": "20220426145353738_BoTVKsp0yz",
"Res_Ref_No":"20221128181023618_CLhXXXXX"
}
{
 "Status":"CSS134",
 "StatusDecription":"RequestType should not be empty",
 "SessionID":"20221128174XXX_XXXX",
 "Res_Ref_No":"20221128181023618_CLhXXXXX"
}
{
 "Status":"CSS135",
 "StatusDecription":"Reached Maximum Given Length, Maximum Length For RequestType is 10",
 "SessionID":"20221128174XXX_XXXX",
 "Res_Ref_No":"20221128181023618_CLhXXXXX"
}

Response Status Code and Status Description:

If the request fails, corresponding status code will be returned along with the status description in the response parameter.

The following table lists the possible response status codes and description.

#	Status Code	Status Description
1	CSS500	Internal Error
2	CSS400	Request is empty
3	CSS999	“ {Error message directly from CKYC API’ s}”
4	CSS143	Failed to Retrieve Data
5	CSS142	Either Mobile or DOB must be provided in request
6	CSS141	Id Type does not match with Database
7	CSS135	Reached Maximum Given Length, Maximum Length For {Parameter Name and length Value}
8	CSS134	{Parameter Name} should not be empty
9	CSS061	Invalid Mobile Number
10	CSS059	Invalid Date of Birth
11	CSS018	SessionID is mandatory field
12	CSS008	Unauthorized API access
13	CSS007	Your password is expired
14	CSS006	Client is currently Inactive
15	CSS005	Client setup pending
16	CSS004	API authentication failed
17	CSS003	User id or password is mandatory field
18	CSS002	Invalid Request
19	CSS001	Your request decryption failed
20	CSS000	Success