User Inquiry

Search and query user accounts on the Treasury platform. You can look up users using various search parameters to verify their account status, KYC details, and other registration information.

Query User

GET /inquiry/user

Headers

Header / Type	Condition	Description
Authorizationstring	required	Bearer token retrieved from the Authentication endpoint.

Query Parameters

Field / Type	Condition	Description
email_addressstring	optional	Unique email address of the user.
phone_numberstring	optional	Contact phone number for the user.
ninstring	optional	National Identification Number (NIN) of the user.
partner_user_idstring	optional	User ID from partner's side.

ℹ️

Note: All query parameters are optional, but you must provide at least one parameter to perform the query.

Example Request

bash

curl -X GET "{BASE_URL}/inquiry/[email protected]&phone_number=6281234567890&nin=3201010101010001&partner_user_id=user_1234567890" \
  -H "Authorization: Bearer eyJhbGciOiJIUzI..."

Response

Sample Response (200 OK - Match Found)

Returned when matching user records are found in the system:

json

{
  "code": 200,
  "message": "success",
  "data": [
    {
      "created_at"     : "2026-01-01T12:00:00+07:00",
      "partner_user_id": "user_1234567890",
      "email_address"  : "[email protected]",
      "phone_number"   : "6281234567890",
      "nin"            : "3201010101010001",
      "status"         : "active",
      "name"           : "andy",
      "kyc_status"     : "in-progress"
    }
  ]
}

Sample Response (200 OK - No Match Found)

Returned when no user records matching the search criteria are found in the system:

json

{
  "code"   : 200,
  "message": "no matches found",
  "data"   : []
}