Archive a Beneficiary
Soft-disables a beneficiary. The record is preserved and can be restored later, but it cannot be used to initiate new payouts while archived. PII remains tokenized and accessible.
Requires an Idempotency-Key header.
Authorizations
Per-request DPoP proof JWT (RFC 9449). MUST accompany the Authorization: DPoP <access_token> header on every protected operation. The proof is signed by the merchant's private DPoP key and carries htm, htu, iat, jti, and ath claims.
Headers
Unique key identifying this operation. Sending the same key twice returns the original response instead of creating a duplicate. Keys are retained for 24 hours.
255Path Parameters
^ben_[a-zA-Z0-9]+$Body
IP address of the merchant's end-user who initiated this action.
Response
Beneficiary archived. Returns the updated record.
A person or business you pay. PII is tokenized in Basis Theory on creation —
raw identifiers are never returned in this response. Use
GET /v1/beneficiaries/{id}/pii to retrieve detokenized PII for a
beneficiary you own.