POSTOnboard Customer
Register a new customer on the platform; triggers an OTP to verify them.
Creates a rail-agnostic customer record. An OTP is dispatched and an otp_ref_id returned — call Verify Customer OTP next to complete onboarding.
Path parameters
| Field | Type | Required | Description |
|---|---|---|---|
customer_id | string | required | Customer's 10-digit mobile number.e.g. 9444444444 |
customer_idstringRequiredCustomer's 10-digit mobile number.
example: 9444444444
Body parameters
| Field | Type | Required | Description |
|---|---|---|---|
initiator_id | string | required | Registered mobile number of the API user (see Platform Credentials).e.g. 9962981729 |
user_code | string | required | User code of the retailer/agent the service is run for.e.g. 20810200 |
client_ref_id | string | optional | Unique reference id per API call, generated by your system.e.g. REQ-20260101-001 |
name | string | required | Name of the customer as per ID.e.g. Karan Garg |
dob | string | required | Date of birth of the customer in YYYY-MM-DD format.e.g. 1990-05-15 |
residence_address | array | required | Customer's address as an array of strings.e.g. 123 MG Road,Bangalore,Karnataka,560001 |
initiator_idstringRequiredRegistered mobile number of the API user (see Platform Credentials).
example: 9962981729
user_codestringRequiredUser code of the retailer/agent the service is run for.
example: 20810200
client_ref_idstringoptionalUnique reference id per API call, generated by your system.
example: REQ-20260101-001
namestringRequiredName of the customer as per ID.
example: Karan Garg
dobstringRequiredDate of birth of the customer in YYYY-MM-DD format.
example: 1990-05-15
residence_addressarrayRequiredCustomer's address as an array of strings.
example: 123 MG Road,Bangalore,Karnataka,560001
Headers
| Field | Type | Required | Description |
|---|---|---|---|
developer_key | string | required | Static API key issued to your account after KYC. |
secret-key | string | required | Dynamic per-request signature: base64(HMAC-SHA256(timestamp, base64(access_key))). |
secret-key-timestamp | string | required | Current time in milliseconds since UNIX epoch, used to compute secret-key. Must match server time. |
content-type | string | required | application/jsone.g. application/json |
developer_keystringRequiredStatic API key issued to your account after KYC.
secret-keystringRequiredDynamic per-request signature: base64(HMAC-SHA256(timestamp, base64(access_key))).
secret-key-timestampstringRequiredCurrent time in milliseconds since UNIX epoch, used to compute secret-key. Must match server time.
content-typestringRequiredapplication/json
example: application/json
Responses
statusnumberPrimary success indicator (0 = success).
messagestringHuman-readable response / error message.
response_status_idnumberGranular status id; see the shared error-codes table.
response_type_idnumberA unique id for every possible response shape (success or error) — useful for client logic branching and analytics.
dataobjectAPI-specific response payload.
intent_idnumberIntent flag for the next step (19 = onboarding).
otp_ref_idstringOTP session reference — pass to Verify Customer OTP.