Eko Platform Services Logo

    GETGet Customer Information

    Check whether a customer is already enrolled on the platform by mobile number.

    GET/customer/profile/{customer_id}

    Looks up a customer. For an enrolled customer the response returns an otp_ref_id to validate; if not enrolled (response_type_id 308) proceed to Onboard Customer.

    Path parameters

    customer_idstringRequired

    Customer's 10-digit mobile number.

    example: 9444444444

    Query 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

    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.