Get Beneficiary List
Testing Env
https://api.uat.sokin.com
Testing Env
https://api.uat.sokin.com
GET
/beneficiaries
Request
Query Params
Header Params
Responses
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.uat.sokin.com/beneficiaries?beneficiary_type&limit&page&order_by&order_with&filter_value&filter_type' \
--header 'x-api-version;' \
--header 'Authorization: Bearer <token>'Response Response Example
200 - Example 1
{
"status": 200,
"success": true,
"message": "External beneficiary loaded successfully.",
"data": [
{
"beneficiary_id": "af9db313-3c2b-416c-b69f-161ac5c56d59",
"beneficiary_name": "Joe Company Ltd",
"beneficiary_type": "Iban",
"account_name": "Joe Company Ltd",
"account_type": "IBAN",
"account_number": "GB13BUKB60161331926819",
"identifier_type": "BIC (SWIFT)",
"identifier_code": "BARCGB22LDN",
"address_line_one": "42 Cherry street",
"address_line_two": "london",
"address_line_three": null,
"postal_code": "W1 8BN",
"city": "London",
"currency_code": "GBP",
"country_name": "United Kingdom",
"country_code": "GB"
},
{
"beneficiary_id": "d37db465-460e-45f9-95e5-14a3245e31a8",
"beneficiary_name": "Jane Doe",
"beneficiary_type": "Account",
"account_name": "Jane Doe",
"account_type": "ACCOUNT",
"account_number": "1234569934",
"identifier_type": "NCC (Sort Code / ABA/Routing No / BSB / Branch & Transit Code)",
"identifier_code": "987654322",
"address_line_one": "23 Maple Street",
"address_line_two": "null",
"address_line_three": null,
"postal_code": "123345",
"city": "New York",
"currency_code": "USD",
"country_name": "United States",
"country_code": "US"
},
],
"page": {
"page_number": 1,
"page_size": 1000,
"total_records": 2
}
}Modified at 2025-12-05 10:52:54