API referenceBeneficiaries
Retire a beneficiary
Retire rather than delete: deleting takes the screening history with it and leaves past payouts pointing at nothing.
Retire rather than delete: deleting takes the screening history with it and leaves past payouts pointing at nothing.
Authorization
OAuth2PasswordBearer AuthorizationBearer <token>
In: header
Path Parameters
beneficiary_id*Beneficiary Id
Format
uuidCookie Parameters
Response Body
application/json
application/json
curl -X POST "https://example.com/api/b/v1/beneficiaries/497f6eca-6276-4993-bfeb-53cbbbba6f08/archive"{ "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"}