Eko Platform Services Logo

    POSTVerify Customer OTP

    Verify the customer OTP to complete onboarding and return the customer profile.

    POST/customer/account/{customer_id}/otp/verify

    Validates the OTP issued by Onboard Customer / Get Customer Information. For an existing customer the response returns the full customer_profile (limits, balance, KYC state). For a new customer the flow continues to Aadhaar validation and PAN.

    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

    otpintegeroptional

    OTP received from Onboard Customer, Get Customer Information, or Validate Aadhaar.

    example: 123456

    otp_ref_idintegerRequired

    otp_ref_id received from Onboard Customer, Get Customer Information, or Validate Aadhaar.

    example: 66748392

    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.

      • customer_profileobject

        Customer's profile — limits, balance, KYC state, and usage chart.

        • namestring

          Registered name of the customer.

        • mobilestring

          Customer's mobile number.

        • next_allowed_limitstring

          Remaining transfer limit for the period (INR).

        • balancestring

          Current balance (INR).

        • kyc_statenumber

          KYC completion state.

      • sender_namestring

        Registered name of the customer.