Request Parameter

Plain Request Parameters:

#

Request Parameter

Description

Data Type

Max. Length

Mandatory (Yes/ No)

1

UserID

ID Provided by CAMS to client for API Access

String

10

Yes

2

Password

Password Provided by CAMS to client for API Access

String

50

Yes

3

IntermediaryID

ID Provided by CAMS to client for API Access

String

10

Yes

4

FI_Code

ID Provided by CKYC to client

String

7

Yes

5

SessionID

Unique ID for the Request session

String

100

Yes

6

TimeStamp

dd-MM-yyyy HH:mm:ss

String

19

Yes

7

ID_Number

ID Number of the customer (PAN for Phase 1)

String

165

Yes

8

ID_Type

Type of ID Proof ("C" for Phase 1) of the customer

String

2

Yes

9

DOB

Date of Birth (DD-MM-YYYY) of the customer

String

10

Either Mobile or DOB must be provided in request

10

Mobile

Mobile Number of the customer

String

10

11

Gender

Gender of the customer (M/F/T)

String

1

No

12

FullName

Full Name of the customer

String

150

No

13

CKYC_NO

14 Digit number

String

14

No

14

AdditionalPara m1

For Future Use

Varchar

250

No

15

AdditionalPara m2

For Future Use

Varchar

250

No

16

AdditionalPara m3

For Future Use

Varchar

250

No

Sample Encrypted Request:

{
zZKQMD06mAJwhMH/udtWoBQqTOmISq1cjbqRk53Md7kbPfrnpmCy+8WZd4EiWe+icIe94UnMlweKDjCo zOQYE+EB6goQkPTmnYrZq6i7YWnYK3eWWnFRa52/Mq1yGirIXGEs/mO39DlnGhKNIo9DxdtQ8bj802rJo 9eFSkpAoY7DsXT+oBEz5NXPVK16Kbnx3y9dEOSGAqeSHf546+ewqQ0ho9iIREJ0ZKXpUbXrMnEs+3pv7
3gATeOlyRvElfXgZpL1O8K57eyAk++PXql7Xqku9W0HGiNLqCOnPiEuW0WXgo2Emo8G91BzoQkXqIoFo
Sb5krNMNneQPRiPwR5OMeIY507DM3.............Ci1VVlfbAQNDbOo= 
}

Sample Plain Request:

{ 
   "UserID":"CAMXXXX", 
   "Password":"XXXXX", 
   "SessionID":"20230111122900XXXXXXX", 
   "IntermediaryID":"H", 
   "FI_Code":"IN10XXXX", 
   "ID_Number":"ATJPXXXXX", 
   "ID_Type":"C", 
   "DOB":"07-10-1XXX", 
   "Mobile":"74186XXXX", 
   "Gender":"M", 
   "FullName":"XXXXXXX ",    "CKYC_NO":null, 
   "AdditionalParam1":null, 
   "AdditionalParam2":null, 
   "AdditionalParam3":null, 
   "TimeStamp":"2023-01-11T13:04:37" 
} 

Last updated