> ## Documentation Index
> Fetch the complete documentation index at: https://docs.uqpay.org/llms.txt
> Use this file to discover all available pages before exploring further.
# List all beneficiaries
> Get list of beneficiaries.
### Header
`x-client-id`.
Bearer `YOUR_TOKEN_HERE`.
### Parameters
Page number, starts from 1.
Number of results per page.
`Maximum 100`
Filter on entity type of the beneficiary.
One of `company`, `individual`
Filter on nickname of the beneficiary.
Filter on account currency of the beneficiary.
Three-letter [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code.
### Response
Indicates whether the call was successful. 200 if successful, 400 if not.
Response Message. "Success" if successful, others not.
Total items.
Total pages.
Beneficiary UUID.
Entity type of the beneficiary.
One of `company`, `individual`
The payment method needs to be specified to ensure that accurate banking details are captured and validated for the specified payment method.
One of `local`, `swift`
Email of the beneficiary.
Nickname of the beneficiary.
Company name of the beneficiary.
Summary of the beneficiary.
Account currency code.
Three-letter [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code.
Bank country code.
Two-letter [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) country code.
First name of the beneficiary.
Last name of the beneficiary.
Beneficiary's bank account details where the payment will be credited.
Bank name of the beneficiary's bank account.
Bank street address.
Bank country code.
Two-letter [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) country code.
Account holder name of the beneficiary’s bank account.
Account currency code.
Three-letter [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code.
Account number, mostly for non-european countries, either account\_number or iban should be filled.
International bank account number, mostly for european countries.
Bank swift code.
Which clearing system should be used for this.
Routing code type.
Routing code value.
Routing code sub type.
Routing code sub type value.
Beneficiary's address details.
Country code of the beneficiary.
Two-letter [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) country code.
City of the beneficiary.
Street address of the beneficiary.
Postal code of the beneficiary.
State of the beneficiary.
```bash cURL Example Request theme={null}
curl 'https://api.sandbox.uqpay.org/api/v1/beneficiaries?page_num=1&page_size=10¤cy=USD' \
-H 'x-auth-token: Bearer 0e043e2ec6898b3220a0921466d7c203' \
-H 'x-client-id: Up1HIsjiETPXLy7gON9PMG'
```
```json Response theme={null}
{
"code": 200,
"message": "Success",
"data": {
"total_item": 2,
"total_page": 1,
"item_list": [
{
"beneficiary_id": "62988ce3-63d7-412a-9546-a5991829be9c",
"entity_type": "company",
"payment_method": "local",
"beneficiary_email": "ayalili88@gmail.com",
"beneficiary_nickname": "KINGO",
"beneficiary_company_name": "KINGO TECHNOLOGY SG PTE LTD",
"beneficiary_summary": "SGD account ending in 0071",
"account_currency_code": "SGD",
"bank_country_code": "SG",
"beneficiary_bank_details": {
"bank_name": "OCBC BANK",
"bank_address": "7 Burn Road #07-07 Trivex Singapore 413577",
"bank_country_code": "SG",
"account_holder": "KINGO TECHNOLOGY SG PTE LTD",
"account_currency_code": "SGD",
"account_number": "701308749981",
"iban": "",
"swift_code": "UOVBSGSG",
"clearing_system": "GIRO",
"routing_code_type1": "",
"routing_code_value1": "",
"routing_code_type2": "",
"routing_code_value2": ""
},
"beneficiary_address": {
"country_code": "SG",
"city": "Singapore",
"street_address": "7 Burn Road #07-07 Trivex Singapore 413577",
"postal_code": "500121",
"state": "Singapore"
},
"create_time": "2023-10-07T21:09:27+08:00",
"update_time": "2023-10-19T13:50:46+08:00"
},
{
"beneficiary_id": "56f3d71d-f732-44c8-8833-55536941e2b0",
"entity_type": "individual",
"payment_method": "swift",
"beneficiary_email": "ayalili88@gmail.com",
"beneficiary_nickname": "AYALAMIH",
"beneficiary_first_name": "LILI",
"beneficiary_last_name": "HU",
"beneficiary_summary": "USD account ending in 1913",
"account_currency_code": "USD",
"bank_country_code": "SG",
"beneficiary_bank_details": {
"bank_name": "UOB Ltd",
"bank_address": "UOB NOVENA BRANCH 238B Thomson Road #01-38 Novena Square Tower B SINGAPORE 307648",
"bank_country_code": "SG",
"account_holder": "WEN LILI",
"account_currency_code": "USD",
"account_number": "7799030917",
"iban": "",
"swift_code": "UOVBSGSG",
"clearing_system": "SWIFT",
"routing_code_type1": "",
"routing_code_value1": "",
"routing_code_type2": "",
"routing_code_value2": ""
},
"beneficiary_address": {
"country_code": "SG",
"city": "Singapore",
"street_address": "196 Ayer Rajah Crescent, #11-07",
"postal_code": "200121",
"state": "Singapore"
},
"create_time": "2023-10-07T21:03:23+08:00",
"update_time": "2023-10-19T12:45:58+08:00"
}
]
}
}
```