List Individuals

GET/individuals

This endpoint allows API users to retrieve a list of individuals they have created.

Query Parameters

pageinteger

Specify the page number

per_pageinteger

Specify the number of items per page

namestring

Search individuals by first_name or last_name.

external_idstring

Response

OK

idstring<uuid>

A UUID to identify an Individual.

external_idstring

A reference given by API caller

gender"female" | "male"

Gender

native_first_namestring

First name or given name in native language

first_namestring

First name or given name

native_last_namestring

Last name or surname in native language

last_namestring

Last name or surname

emailstring<email>

Email address

country_codestring<iso-3166-1-alpha3>

Residence country

province_statestring

Residence State/Province

citystring

Residence city

native_addressstring

Residence address in native language

addressstring

Residence address

zip_codestring

Residence address zip code or postal code

date_of_birthstring<date>

Date of birth

place_of_birthstring

Place of birth

mobile_numberstring

Mobile number

identification_type"RESIDENT_CARD" | "NATIONAL_ID" | "PASSPORT" | "TAX_ID" | "DRIVING_LICENSE" | "SOCIAL_SECURITY" | "OTHER"

Identification type

identification_numberstring

Identification number

additional_identification_type"BVN"

Additional identification type

additional_identification_numberstring

Identification number

nationalitystring<iso-3166-1-alpha3>

Nationality

remarksstring

Remarks or notes

verification_status"none" | "missing" | "pending" | "failed" | "additional_kyc_required" | "confirmed"

Individual KYC verification status

kyc_submittedboolean

Did the individual submit KYC information

daily_quotanumber

Daily limit of sending transfers

monthly_quotanumber

Monthly limit of sending transfers

yearly_quotanumber

Yearly limit of sending transfers

quota_currencystring<iso-4217-ext>

Currency to be used for all quotas

created_atstring<date-time>

Creation timestamp

updated_atstring<date-time>

Last update timestamp

is_blockedboolean

Whether this sender entity is blocked for transfer operations. Managed by internal ops only.

Request
curl -X GET "https://api.uat.triple-a.io/api/fiat-payout/v1/individuals?page=<page>&per_page=<per_page>&name=<name>&external_id=<external_id>" \
  -H "Authorization: Bearer <token>"
Response
[
  {
    "id": "00000000-0000-0000-0000-000000000000",
    "external_id": "9c0eb636-84ac-4f78-a83c-83ab108d8cee",
    "gender": "female",
    "native_first_name": "占士",
    "first_name": "James",
    "native_last_name": "張",
    "last_name": "Zhang",
    "email": "[email protected]",
    "country_code": "USA",
    "province_state": "New York",
    "city": "New York City",
    "native_address": "51 號,福州路,廣州市",
    "address": "1 Falcon Ave, California",
    "zip_code": "12345",
    "date_of_birth": "2019-08-24",
    "place_of_birth": "New York City",
    "mobile_number": "+198766234",
    "identification_type": "NATIONAL_ID",
    "identification_number": "S98765433X",
    "additional_identification_type": "BVN",
    "additional_identification_number": 22227340549,
    "nationality": "SGP",
    "remarks": "string",
    "verification_status": "none",
    "kyc_submitted": true,
    "daily_quota": 10000,
    "monthly_quota": 50000,
    "yearly_quota": 100000,
    "quota_currency": "USD",
    "created_at": "1970-01-01T00:00:00.000Z",
    "updated_at": "1970-01-01T00:00:00.000Z",
    "is_blocked": true
  }
]