GETGet User's Services

Check the activation status of every service for one of your agents.

GET/user/account/services

Returns every service enabled for the given user_code, with each service's activation status, ops-verification status and timestamps. Use it to audit which services one of your agents can actually transact on.

Service status (`service_status_list[].status`)

Not to be confused with the top-level status — this one lives on each entry of service_status_list.

`status`	`status_desc`	Meaning
0	`DEACTIVATED`	Agent must re-upload their documents using the Activate Service API
1	`ACTIVATED`	Service is live and usable
2	`PENDING`	Activation pending for this agent

Note

Once the agent re-uploads their documents from the DEACTIVATED state, the service moves to PENDING — not straight back to ACTIVATED.

Verification status (`verification_status`)

Tells you the action taken by the Eko operations team on the agent's documents for that service.

`verification_status`	Meaning
0	Not applicable — this service needs no ops verification
1	Verified — documents verified by the ops team
2	Rejected — rejection reason is in the entry's `comments` field
3	Pending — action pending from the ops team

Request

Query parameters

Field	Type	Required	Description
`initiator_id`	string	required	Registered mobile number of the API user (see Platform Credentials).e.g. 9962981729
`client_ref_id`	string	optional	Unique reference ID per API call, generated by your system (max 20 characters).e.g. 2026010100123456789
`user_code`	string	required	Unique code of your user/agent/retailer the service is run for. Use `Onboard Agent` API to register your userse.g. 20810200

initiator_idstringRequired

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

example: 9962981729

client_ref_idstringoptional

Unique reference ID per API call, generated by your system (max 20 characters).

example: 2026010100123456789

user_codestringRequired

Unique code of your user/agent/retailer the service is run for. Use `Onboard Agent` API to register your users

example: 20810200

These headers authenticate and sign every request. See How Auth Works for details.

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_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.
- service_status_listarray
  Per-service status for the user.
  - service_codestring
    Service code.
  - status_descstring
    Human-readable status (ACTIVATED / PENDING / DEACTIVATED).
  - statusnumber
    Activation status — 0 = deactivated (agent must re-upload documents via Activate Service), 1 = activated, 2 = pending.
  - verification_statusnumber
    Ops-team verification state — 0 = not applicable, 1 = verified, 2 = rejected (reason in `comments`), 3 = pending.
  - commentsstring
    Ops-team remark — holds the rejection reason when `verification_status` is 2, otherwise null.
  - createdAtstring
    When the service was created.

Next steps

NextGETGet All ServicesList every service available on the platform with its service code and provider.

Service status (service_status_list[].status)

Verification status (verification_status)