Eko Platform Services Logo

    POSTOnboard Customer

    Register a new customer on the platform; triggers an OTP to verify them.

    POST/customer/account/{customer_id}

    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

    customer_idstringRequired

    Customer's 10-digit mobile number.

    example: 9444444444

    Body parameters

    initiator_idstringRequired

    Registered mobile number of the API user (see Platform Credentials).

    example: 9962981729

    user_codestringRequired

    User code of the retailer/agent the service is run for.

    example: 20810200

    client_ref_idstringoptional

    Unique reference id per API call, generated by your system.

    example: REQ-20260101-001

    namestringRequired

    Name of the customer as per ID.

    example: Karan Garg

    dobstringRequired

    Date of birth of the customer in YYYY-MM-DD format.

    example: 1990-05-15

    residence_addressarrayRequired

    Customer's address as an array of strings.

    example: 123 MG Road,Bangalore,Karnataka,560001

    Headers

    developer_keystringRequired

    Static API key issued to your account after KYC.

    secret-keystringRequired

    Dynamic per-request signature: base64(HMAC-SHA256(timestamp, base64(access_key))).

    secret-key-timestampstringRequired

    Current time in milliseconds since UNIX epoch, used to compute secret-key. Must match server time.

    content-typestringRequired

    application/json

    example: application/json

    Responses

    • statusnumber

      Primary success indicator (0 = success).

    • messagestring

      Human-readable response / error message.

    • response_status_idnumber

      Granular status id; see the shared error-codes table.

    • response_type_idnumber

      A unique id for every possible response shape (success or error) — useful for client logic branching and analytics.

    • dataobject

      API-specific response payload.

      • intent_idnumber

        Intent flag for the next step (19 = onboarding).

      • otp_ref_idstring

        OTP session reference — pass to Verify Customer OTP.