Update beneficiary

Updates a beneficiary from your platform.
This endpoint is only available to certain participants leveraging zerohash for beneficiary services. Please contact us for more information on enabling this endpoint.

Path Params
string
required

Unique identifier related to the beneficiary

Body Params
string
required

The first name of the beneficiary

string
required

The last name of the beneficiary

string

Beneficiary email address, required when phone_number not provided.
Note: zerohash will validate that the email is a correctly formatted email, and that the value is unique per-platform

string

The phone number of the participant, required when email not provided.

string

First line for the beneficiary's address.

Notes:

  • The regular maximum length is 80 characters.
  • If the platform is on the vendor reliance track, the maximum length increases to 200 characters.
  • PO Box addresses are not accepted.
string

Extra information, like an apartment or suite number.

Notes:

  • The regular maximum length is 50 characters.
  • If the platform is on the vendor reliance track, the maximum length increases to 200 characters.
  • PO Box addresses are not accepted.
string
required

The city customer resides in

string
required

Zip code of the beneficiary, required if "country" is "United States", min 5 characters or <5digits>-<4digits>, no leading or trailing spaces", e.g. 77777 or 77777-7777.

string
required

The ISO 3166-2 subdivision code that the customer resides in

string

Date of birth of the customer in the format YYYY-MM-DD

string

The national ID of the participant, e.g. a social security number. Required if citizenship=United States or citizenship_code=US.
Note: if citizenship=United States, and tax_id begins with 9, then id_number_type and id_number are also required.

string
enum

Required when citizenship is not United States; or when citizenship=United States but tax_id is an ITIN (a 9-digit US ID that begins with the number 9).
Passport, EU Drivers License, National ID are EU-specific types. EU platforms also accept us_passport, non_us_passport, non_us_other, us_drivers_license, us_id_card, us_passport_card

string

The ID number for the customer. Required when citizenship is not United States; or when citizenship=United States but tax_id is an ITIN (a 9-digit US ID that begins with the number 9).

string

The ISO-3166-1 alpha2 citizenship of the participant, e.g. "US"

string

This is required if you select non_us_other for the id_number_type - a freeform string to describe the ID type

string

ISO-3166-1_A2 country code that issued the ID. Required if id_number is provided.

signed_agreements
array of objects

The agreements signed by the beneficiary. A payment_services_terms agreement is required.

signed_agreements
string
enum

Employment status

Allowed:
string
enum

Employment industry

string
enum

Source of funds

Headers
string
Defaults to [WEB] auto-generated on fly

Signature for your request.

string
Defaults to [WEB] auto-generated on fly

UNIX timestamp.

string
Defaults to [WEB] auto-generated on fly

Optional request ID for idempotency purposes. Required format: uuid v4

Responses

Language
Credentials
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json