API response body
{
"_meta": {
"client_uuid": "425ff0c8-1507-4550-a8d1-b9466535afdc",
"created_before": "2021-09-20T08:29:21+00:00",
"created_after": "1970-01-01T00:00:00+00:00",
"search": "daniel",
"total_users_count": 2,
"page": 1,
"max_pages": 1
},
"users": [
{
"uuid": "76af1d00-0718-11ec-88ab-fd37c21ff90e",
"first_name": "Daniel",
"last_name": "Aki",
"email": "[email protected]",
"primary_phone_number": "2349038385617",
"primary_phone_imei": null,
"secondary_phone_number": null,
"secondary_phone_imei": null,
"is_kyc_verified": false,
"device_id": "296165215773dcdf",
"external_id": "76af1d00-0718-11ec-88ab-fd37c21ff90e",
"created_at": "2021-08-27T09:23:53.603000+00:00",
"updated_at": "2021-09-05T19:25:13.535175+00:00",
"country_code": "NG"
},
{
"uuid": "f05707a0-ebdc-11eb-af63-5fa311f9bad7",
"first_name": "Danielle",
"last_name": "Fukua",
"email": "[email protected]",
"primary_phone_number": "233758585000",
"primary_phone_imei": null,
"secondary_phone_number": null,
"secondary_phone_imei": null,
"is_kyc_verified": false,
"device_id": "640f004658c5e678",
"external_id": "f05707a0-ebdc-11eb-af63-5fa311f9bad7",
"created_at": "2021-07-23T17:39:50.251000+00:00",
"updated_at": "2021-09-05T19:25:13.533809+00:00",
"country_code": "GH"
}
]
}
Summary
The /users
API exposes tools to search and filter mobile phone users added by an organization's Android SDK.
Query/Response Behavior
If no time range is provided in the query, the endpoint defaults to returning a full page of users.
The ?search=
query parameter can be used to find a user by first_name
, last_name
, email
, primary_phone_number
, external_id
, or uuid
. This can be used to fetch information about a user of interest, or identify the uuid
necessary to access financial information about a user through other endpoints.
Fields
user[].uuid
A unique identifier for the user, used as the user_uuid
path parameter for other endpoints, and provided by the Android SDK.
user[].first_name
The user's first name, provided by the Android SDK.
user[].last_name
The user's last name, provided by the Android SDK.
user[].email
The user's email address, provided by the Android SDK.
user[].primary_phone_number
The user's phone number, provided by the Android SDK.
user[].primary_phone_imei
The user's phone IMEI, provided by the Android SDK.
user[].secondary_phone_number
Optional secondary phone number associated with the user, provided by the Android SDK installed.
user[].secondary_phone_imei
Optional secondary phone IMEI associated with the user, provided by the Android SDK installed.
user[].is_kyc_verified
Flag indicating whether or not the user has passed KYC verification, provided by the Android SDK.
user[].device_id
Unique identifier of the user's mobile phone, provided by the Android SDK.
user[].external_id
External identifier configured while integrating the Android SDK. Can be used to identify users in other identity systems.
user[].created_at
Date and time when the user was first provisioned in the Pngme system.
user[].updated_at
Date and time when the user was last updated in the Pngme system.
users[].country_code
ISO 3166 compatible country code inferred from the user's primary phone number.