curl --request GET \
--url https://api.yapily.com/users/{userId}/beneficiaries \
--header 'Authorization: Basic <encoded-value>'{
"meta": {
"tracingId": "<string>",
"count": 123,
"pagination": {
"totalCount": 123,
"self": {
"from": "2023-11-07T05:31:56Z",
"before": "2023-11-07T05:31:56Z",
"limit": 123,
"sort": "date",
"offset": 123,
"cursor": "<string>"
},
"next": {
"from": "2023-11-07T05:31:56Z",
"before": "2023-11-07T05:31:56Z",
"limit": 123,
"cursor": "<string>"
}
}
},
"data": [
{
"beneficiaryId": "e7b7636d-a041-4013-8a1b-34dc85b7d341",
"status": "PENDING",
"details": {
"name": "John Doe",
"accountIdentifier": {
"type": "IBAN",
"identification": "DE12345123451234512345123"
},
"match": {
"status": "FULL_MATCH",
"closeMatchName": "John Doe"
}
}
}
]
}Get all users beneficiaries from an userId.
curl --request GET \
--url https://api.yapily.com/users/{userId}/beneficiaries \
--header 'Authorization: Basic <encoded-value>'{
"meta": {
"tracingId": "<string>",
"count": 123,
"pagination": {
"totalCount": 123,
"self": {
"from": "2023-11-07T05:31:56Z",
"before": "2023-11-07T05:31:56Z",
"limit": 123,
"sort": "date",
"offset": 123,
"cursor": "<string>"
},
"next": {
"from": "2023-11-07T05:31:56Z",
"before": "2023-11-07T05:31:56Z",
"limit": 123,
"cursor": "<string>"
}
}
},
"data": [
{
"beneficiaryId": "e7b7636d-a041-4013-8a1b-34dc85b7d341",
"status": "PENDING",
"details": {
"name": "John Doe",
"accountIdentifier": {
"type": "IBAN",
"identification": "DE12345123451234512345123"
},
"match": {
"status": "FULL_MATCH",
"closeMatchName": "John Doe"
}
}
}
]
}Use HTTP Basic Authentication with your Application ID as username and Application Secret as password. Manage credentials in the Yapily Console. See Authentication for details.
"e7b7636d-a041-4013-8a1b-34dc85b7d341"
Was this page helpful?