Replace the personal details stored in the secure vault for this beneficiary. Send the detail block that matches the beneficiary's type (individual or business). The other block is refused.
The block you send replaces the stored block as a whole. Vault tokens are immutable, so a field you leave out of the block is cleared, not kept, and the block must be complete. The display_name on the beneficiary is re-derived from the new details.
Personal details are write-only for machine credentials: your system is the source of the data, so it can replace it without reading it back (see GET /v1/beneficiaries/{id}/pii).
Accepts an Idempotency-Key but does not require one.
Path parameters
idstring · requiredBeneficiary ID (prefixed ben_).
Headers
Anton-VersionstringThe API version for this request, a date such as 2026-12-01. Optional. Without it, the request runs on your account's pinned version: the latest version when you created your first OAuth client, or the launch version (2026-12-01) if you have not created one. An unknown value returns 400 invalid_api_version. The header applies to one request and never changes your pinned version; move the pin from the dashboard. It does not apply to webhooks, which follow your pinned version. The response echoes the version used in the Anton-Version header.
"2026-12-01"Idempotency-KeystringOptional on PATCH and DELETE. Sending the same key with the same request returns the original response instead of repeating the change. Keys are kept for 24 hours.
Body application/json
individualobjectPII for an individual beneficiary. Tokenized on creation.
Fields (9)
first_namestring · required"Jane"last_namestring · required"Smith"emailstring (email) · required"jane@example.com"phonestring · requiredE.164-formatted phone number.
"+442079460000"birth_datestring · requiredYYYY-MM-DD.
"1988-05-12"nationalitystring · requiredISO 3166-1 alpha-2 country code.
"US"addressobject · requiredFields (6)
street_line_1string · required"10 Example Street"citystring · required"London"postal_codestring · required"SW1A 1AA"countrystring · requiredISO 3166-1 alpha-2 country code.
"US"street_line_2string"Apt 4B"statestringState, province or region. Required in some countries (for example US, CA, AU).
"Greater London"middle_namestring"R"tax_idstringTax identification number (for example US SSN/ITIN, UK NINO, or a foreign equivalent). Tokenized in the PII vault on creation and never stored in plaintext on the beneficiary record. Optional.
"123-45-6789"businessobjectPII for a business beneficiary. Tokenized on creation.
Fields (11)
legal_namestring · required"Example GmbH"registration_numberstring · required"HRB12345"emailstring (email) · requiredphonestring · requiredE.164-formatted phone number.
"+493012345678"addressobject · requiredFields (6)
street_line_1string · required"10 Example Street"citystring · required"London"postal_codestring · required"SW1A 1AA"countrystring · requiredISO 3166-1 alpha-2 country code.
"US"street_line_2string"Apt 4B"statestringState, province or region. Required in some countries (for example US, CA, AU).
"Greater London"trading_namestringName the business trades as, if different from its legal name.
"Example"tax_idstring"DE123456789"entity_typestringLegal entity form.
llccorporationpartnershipsole_proprietorshiptrustotherincorporation_countrystringISO 3166-1 alpha-2 country code.
"US"incorporation_datestringYYYY-MM-DD.
websitestring (uri)"https://example.de"end_user_ipstringResponses
200Personal details replaced. Returns the beneficiary.
idstring · required"ben_01HX8Z9K0M2N3P4Q5R6S7T8UA1"objectstring · requiredbeneficiarylivemodeboolean · requiredtrue in production, false in sandbox.
statusstring · requiredactive: usable for payouts.archived: disabled by you and not usable. You can restore it.blocked: cannot be used for payouts and cannot be restored through the API.
New values may be added.
activearchivedblockedtypestring · requiredindividualbusinessdisplay_namestring · requiredBuilt from the tokenized details on creation: the joined name fields for individuals, the legal name for businesses.
"Jane Smith"countrystring · requiredISO 3166-1 alpha-2 country code.
"US"external_refstring | null · requiredYour own reference, if you supplied one.
risk_scoreinteger | null · requiredPayee risk score, an integer from 0 to 1000. Higher is always worse. Reflects the payee and recent payouts to it, and is refreshed over time. null until the payee's first score, shortly after it is created.
risk_tierstring | null · requiredRisk band for risk_score: >= 900 CRITICAL, >= 700 HIGH, >= 400 MEDIUM, otherwise LOW. null while unscored.
CRITICALHIGHMEDIUMLOWrisk_signalsarray of object · requiredThe main reasons behind risk_score, worst first, at most two. Empty while unscored or when nothing stands out. Show label as-is and branch on code, which is stable. New codes may be added.
Codes: regulatory_review, flagged_across_network, high_risk_country, possible_duplicate, identity_mismatch, masked_network, location_mismatch, details_changed, high_payout_volume, large_payouts, unusual_activity, unverified_account, crypto_focused, new_payee, incomplete_details, established, trusted_by_other_merchants.
Item fields (2)
codestring · required"new_payee"labelstring · required"New payee"created_viastring · requiredThe surface that first created the beneficiary.
apibatchportalimportsource_batch_idstring | null · requiredThe batch (bat_…) that created the beneficiary when created_via is batch, otherwise null.
metadataobject · requiredYour own key/value pairs, stored and returned as-is. At most 50 keys; keys up to 40 characters and values up to 500, all strings. On a beneficiary the key block_reason is reserved and is refused with 422. Anton never reads it, never logs or audits it, and never sends it to screening or risk checks, so it is not searchable. Never put personal data in it.
Do not store personal information, account numbers or credentials in metadata. Use the resource's own fields, which are tokenized.
created_atstring (date-time) · requiredRFC 3339 / ISO 8601 timestamp in UTC.
"2026-04-15T14:30:00Z"updated_atstring (date-time) · requiredRFC 3339 / ISO 8601 timestamp in UTC.
"2026-04-15T14:30:00Z"400The request body could not be parsed or contains unknown fields, its `Content-Type` is not `application/json` (`invalid_content_type`), or t
errorobject · requiredThe error object of every /v1 error response. type, code, message, doc_url and request_id are always present.
Fields (7)
typestring · requiredThe kind of error; it follows the HTTP status. idempotency_error is used only for the two Idempotency-Key failures that are a 409 or a 422 (idempotency_in_flight, idempotency_key_reused).
authentication_errorpermission_errorinvalid_request_erroridempotency_errorrate_limit_errorapi_errorcodestring · requiredMachine-readable error code. Branch on this, not on message. Each code is documented at its doc_url.
"amount_precision_invalid"messagestring · requiredHuman-readable description for a developer. Never includes personal data or internal detail; a 5xx message is always generic.
"CAD amounts allow 2 decimal places; got 3."doc_urlstring (uri) · requiredWhere this code is documented.
"https://docs.antonpayments.com/api-reference/errors#amount_precision_invalid"request_idstring · requiredThe req_ ID of the request that failed; the same value as the Request-Id header.
"req_01JD3XB7Q2"paramstringThe request field or query parameter at fault, when one is. With several failures, see details.
"amount"detailsarray of objectEvery field failure at once, so a form can be fixed in one pass.
Item fields (3)
paramstring · requiredDotted JSON path to the offending field.
"amount"codestring · required"amount_precision_invalid"messagestring · required"CAD amounts allow 2 decimal places; got 3."401Missing, expired or invalid credentials (access token or DPoP proof). Carries `WWW-Authenticate`.
errorobject · requiredThe error object of every /v1 error response. type, code, message, doc_url and request_id are always present.
Fields (7)
typestring · requiredThe kind of error; it follows the HTTP status. idempotency_error is used only for the two Idempotency-Key failures that are a 409 or a 422 (idempotency_in_flight, idempotency_key_reused).
authentication_errorpermission_errorinvalid_request_erroridempotency_errorrate_limit_errorapi_errorcodestring · requiredMachine-readable error code. Branch on this, not on message. Each code is documented at its doc_url.
"amount_precision_invalid"messagestring · requiredHuman-readable description for a developer. Never includes personal data or internal detail; a 5xx message is always generic.
"CAD amounts allow 2 decimal places; got 3."doc_urlstring (uri) · requiredWhere this code is documented.
"https://docs.antonpayments.com/api-reference/errors#amount_precision_invalid"request_idstring · requiredThe req_ ID of the request that failed; the same value as the Request-Id header.
"req_01JD3XB7Q2"paramstringThe request field or query parameter at fault, when one is. With several failures, see details.
"amount"detailsarray of objectEvery field failure at once, so a form can be fixed in one pass.
Item fields (3)
paramstring · requiredDotted JSON path to the offending field.
"amount"codestring · required"amount_precision_invalid"messagestring · required"CAD amounts allow 2 decimal places; got 3."403Authenticated, but not permitted for this operation. A sandbox credential used against production is `key_environment_mismatch`.
errorobject · requiredThe error object of every /v1 error response. type, code, message, doc_url and request_id are always present.
Fields (7)
typestring · requiredThe kind of error; it follows the HTTP status. idempotency_error is used only for the two Idempotency-Key failures that are a 409 or a 422 (idempotency_in_flight, idempotency_key_reused).
authentication_errorpermission_errorinvalid_request_erroridempotency_errorrate_limit_errorapi_errorcodestring · requiredMachine-readable error code. Branch on this, not on message. Each code is documented at its doc_url.
"amount_precision_invalid"messagestring · requiredHuman-readable description for a developer. Never includes personal data or internal detail; a 5xx message is always generic.
"CAD amounts allow 2 decimal places; got 3."doc_urlstring (uri) · requiredWhere this code is documented.
"https://docs.antonpayments.com/api-reference/errors#amount_precision_invalid"request_idstring · requiredThe req_ ID of the request that failed; the same value as the Request-Id header.
"req_01JD3XB7Q2"paramstringThe request field or query parameter at fault, when one is. With several failures, see details.
"amount"detailsarray of objectEvery field failure at once, so a form can be fixed in one pass.
Item fields (3)
paramstring · requiredDotted JSON path to the offending field.
"amount"codestring · required"amount_precision_invalid"messagestring · required"CAD amounts allow 2 decimal places; got 3."404The resource does not exist, or belongs to a different merchant.
errorobject · requiredThe error object of every /v1 error response. type, code, message, doc_url and request_id are always present.
Fields (7)
typestring · requiredThe kind of error; it follows the HTTP status. idempotency_error is used only for the two Idempotency-Key failures that are a 409 or a 422 (idempotency_in_flight, idempotency_key_reused).
authentication_errorpermission_errorinvalid_request_erroridempotency_errorrate_limit_errorapi_errorcodestring · requiredMachine-readable error code. Branch on this, not on message. Each code is documented at its doc_url.
"amount_precision_invalid"messagestring · requiredHuman-readable description for a developer. Never includes personal data or internal detail; a 5xx message is always generic.
"CAD amounts allow 2 decimal places; got 3."doc_urlstring (uri) · requiredWhere this code is documented.
"https://docs.antonpayments.com/api-reference/errors#amount_precision_invalid"request_idstring · requiredThe req_ ID of the request that failed; the same value as the Request-Id header.
"req_01JD3XB7Q2"paramstringThe request field or query parameter at fault, when one is. With several failures, see details.
"amount"detailsarray of objectEvery field failure at once, so a form can be fixed in one pass.
Item fields (3)
paramstring · requiredDotted JSON path to the offending field.
"amount"codestring · required"amount_precision_invalid"messagestring · required"CAD amounts allow 2 decimal places; got 3."422The request failed validation (`validation_error`, or a more specific code such as `amount_precision_invalid`). `details` lists every failin
errorobject · requiredThe error object of every /v1 error response. type, code, message, doc_url and request_id are always present.
Fields (7)
typestring · requiredThe kind of error; it follows the HTTP status. idempotency_error is used only for the two Idempotency-Key failures that are a 409 or a 422 (idempotency_in_flight, idempotency_key_reused).
authentication_errorpermission_errorinvalid_request_erroridempotency_errorrate_limit_errorapi_errorcodestring · requiredMachine-readable error code. Branch on this, not on message. Each code is documented at its doc_url.
"amount_precision_invalid"messagestring · requiredHuman-readable description for a developer. Never includes personal data or internal detail; a 5xx message is always generic.
"CAD amounts allow 2 decimal places; got 3."doc_urlstring (uri) · requiredWhere this code is documented.
"https://docs.antonpayments.com/api-reference/errors#amount_precision_invalid"request_idstring · requiredThe req_ ID of the request that failed; the same value as the Request-Id header.
"req_01JD3XB7Q2"detailsarray of object · requiredEvery field failure at once, so a form can be fixed in one pass.
Item fields (3)
paramstring · requiredDotted JSON path to the offending field.
"amount"codestring · required"amount_precision_invalid"messagestring · required"CAD amounts allow 2 decimal places; got 3."paramstringThe request field or query parameter at fault, when one is. With several failures, see details.
"amount"429Rate limit exceeded. See `Retry-After`. The `X-RateLimit-*` headers are on every authenticated API response, not only on 429s; they are docu
errorobject · requiredThe error object of every /v1 error response. type, code, message, doc_url and request_id are always present.
Fields (7)
typestring · requiredThe kind of error; it follows the HTTP status. idempotency_error is used only for the two Idempotency-Key failures that are a 409 or a 422 (idempotency_in_flight, idempotency_key_reused).
authentication_errorpermission_errorinvalid_request_erroridempotency_errorrate_limit_errorapi_errorcodestring · requiredMachine-readable error code. Branch on this, not on message. Each code is documented at its doc_url.
"amount_precision_invalid"messagestring · requiredHuman-readable description for a developer. Never includes personal data or internal detail; a 5xx message is always generic.
"CAD amounts allow 2 decimal places; got 3."doc_urlstring (uri) · requiredWhere this code is documented.
"https://docs.antonpayments.com/api-reference/errors#amount_precision_invalid"request_idstring · requiredThe req_ ID of the request that failed; the same value as the Request-Id header.
"req_01JD3XB7Q2"paramstringThe request field or query parameter at fault, when one is. With several failures, see details.
"amount"detailsarray of objectEvery field failure at once, so a form can be fixed in one pass.
Item fields (3)
paramstring · requiredDotted JSON path to the offending field.
"amount"codestring · required"amount_precision_invalid"messagestring · required"CAD amounts allow 2 decimal places; got 3."500Something went wrong on our end (`api_error`: 500 `internal_error`, 502 `upstream_error`, 503 `service_unavailable`). The message is always
errorobject · requiredThe error object of every /v1 error response. type, code, message, doc_url and request_id are always present.
Fields (7)
typestring · requiredThe kind of error; it follows the HTTP status. idempotency_error is used only for the two Idempotency-Key failures that are a 409 or a 422 (idempotency_in_flight, idempotency_key_reused).
authentication_errorpermission_errorinvalid_request_erroridempotency_errorrate_limit_errorapi_errorcodestring · requiredMachine-readable error code. Branch on this, not on message. Each code is documented at its doc_url.
"amount_precision_invalid"messagestring · requiredHuman-readable description for a developer. Never includes personal data or internal detail; a 5xx message is always generic.
"CAD amounts allow 2 decimal places; got 3."doc_urlstring (uri) · requiredWhere this code is documented.
"https://docs.antonpayments.com/api-reference/errors#amount_precision_invalid"request_idstring · requiredThe req_ ID of the request that failed; the same value as the Request-Id header.
"req_01JD3XB7Q2"paramstringThe request field or query parameter at fault, when one is. With several failures, see details.
"amount"detailsarray of objectEvery field failure at once, so a form can be fixed in one pass.
Item fields (3)
paramstring · requiredDotted JSON path to the offending field.
"amount"codestring · required"amount_precision_invalid"messagestring · required"CAD amounts allow 2 decimal places; got 3."