API referenceBeneficiaries

List beneficiaries

GET
/api/b/v1/beneficiaries

Authorization

OAuth2PasswordBearer
AuthorizationBearer <token>

In: header

Query Parameters

include_archived?Include Archived
Defaultfalse
screening_status?|null
admin_access_token?string|null

Response Body

application/json

application/json

curl -X GET "https://example.com/api/b/v1/beneficiaries"
{  "beneficiaries": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "label": "string",      "full_name": "string",      "type": "string",      "currency": "string",      "country_code": "string",      "account_identifier": "string",      "bank_name": "string",      "validation_status": "unchecked",      "account_name_returned": "string",      "screening_status": "unscreened",      "screening_notes": "string",      "screened_at": "2019-08-24T14:15:22Z",      "reviewed_at": "2019-08-24T14:15:22Z",      "payable": true,      "archived_at": "2019-08-24T14:15:22Z",      "created_at": "2019-08-24T14:15:22Z"    }  ]}

Try a dead-lettered delivery again POST

Give up on giving up. Needs `WEBHOOK_MANAGE`, not `WEBHOOK_READ`: this puts traffic back on a receiver, and the person doing it is asserting that whatever broke is fixed.

Save a beneficiary POST

Save a recipient. The response carries the name-check result and the screening state, so a mismatch is visible immediately rather than at the first payout.