Sign in

v1

latestOpenAPI 3.1.02026-07-241653251.3 MB
Individual Participants

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.

patch/participants/beneficiaries/{participant_code}

Path parameters

participant_codestring required
Example:ABCDEF

Unique participant identifier. Always 6 uppercase alphanumeric characters.

Headers

X-SCX-SIGNEDstring required

HMAC-SHA256 signature of the request, base64-encoded. See the Authentication guide for the exact signing formula.

X-SCX-TIMESTAMPstring required
Example:1678901234

Current Unix timestamp in seconds. Must be within 60 seconds of server time or the request is rejected.

X-Request-Idstring uuid

Optional client-supplied request ID used for tracing and idempotency. Must be a UUID v4. When omitted, zerohash generates one and returns it in the response X-Request-Id header.

Request body

first_namestring required

The first name of the customer being onboarded.

last_namestring required

The last name of the customer being onboarded.

emailstring

Customer email address, required. Note: zerohash will validate that the email is a correctly formatted email, and that the value is unique per-platform

phone_numberstring

The phone number of the participant

address_onestring

First line for the customer'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.
address_twostring

Extra information, like an apartment or suite number.

Notes:

  • The maximum length is 50 characters for platform using KYCaaS through zerohash.
  • If the platform is on the shared vendor reliance track, the maximum length increases to 200 characters.
  • PO Box addresses are not accepted.
citystring required

The city customer resides in.

zipstring required

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

jurisdiction_code'US-AL' | 'US-AK' | 'US-AZ' | 'US-AR' | 'US-CA' | 'US-CO' | 'US-CT' | 'US-DE' | 'US-FL' | 'US-GA' | 'US-HI' | 'US-ID' | 'US-IL' | 'US-IN' | 'US-IA' | 'US-KS' | 'US-KY' | 'US-LA' | 'US-ME' | 'US-MD' | 'US-MA' | 'US-MI' | 'US-MN' | 'US-MS' | 'US-MO' | 'US-MT' | 'US-NE' | 'US-NV' | 'US-NH' | 'US-NJ' | 'US-NM' | 'US-NY' | 'US-NC' | 'US-ND' | 'US-OH' | 'US-OK' | 'US-OR' | 'US-PA' | 'US-RI' | 'US-SC' | 'US-SD' | 'US-TN' | 'US-TX' | 'US-UT' | 'US-VT' | 'US-VA' | 'US-WA' | 'US-WV' | 'US-WI' | 'US-WY' | 'US-DC' | 'US-AS' | 'US-GU' | 'US-MP' | 'US-PR' | 'US-UM' | 'US-VI' required

The ISO 3166-2 subdivision code that the customer resides in. A full list of valid jurisdiction codes can be retrieved from the GET /jurisdictions/subdivisions endpoint passing a country parameter.

date_of_birthstring

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

tax_idstring

The national ID of the participant, e.g. a social security number.

  • Required when citizenship_code is US.
  • Optional when citizenship_code is not US, but if provided, must be accompanied by a valid id_number and id_number_type.
  • If the tax ID provided is a US ITIN (a 9-digit US ID that begins with the number 9), then id_number_type will be required.
id_number_type'us_drivers_license' | 'us_passport' | 'us_passport_card' | 'us_permanent_resident_card' | 'us_border_crossing_card' | 'us_alien_card' | 'us_id_card' | 'non_us_passport' | 'non_us_other' | 'passport' | 'eu_drivers_license' | 'national_id' | 'legal_entity_identifier' | 'chamber_of_commerce_number' | 'value_added_tax_number'

The id number type field is required when;

  • citizenship is not US
  • citizenship=US and tax_id starts with 9 (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
id_numberstring

The ID number for the customer.

  • Required when citizenship_code is not US
  • Required when citizenship_code : US but tax_id is an ITIN (a 9-digit US ID that begins with the number 9).
citizenship_code'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AO' | 'AQ' | 'AR' | 'AS' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BV' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CU' | 'CV' | 'CW' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FM' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GU' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IR' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KP' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MH' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MP' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PR' | 'PS' | 'PT' | 'PW' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RW' | 'SA' | 'SB' | 'SC' | 'SD' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'SS' | 'ST' | 'SV' | 'SX' | 'SY' | 'SZ' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VI' | 'VN' | 'VU' | 'WF' | 'WS' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW'

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

non_us_other_typestring

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

id_issuing_authoritystring

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

Example request

{
  "first_name": "John",
  "last_name": "Smith",
  "email": "test@example.com",
  "phone_number": "15557778888",
  "address_one": "123 Main St.",
  "address_two": "Suite 1000",
  "city": "Chicago",
  "zip": "12345",
  "jurisdiction_code": "US-IL",
  "date_of_birth": "1985-09-02",
  "tax_id": "000-00-0000",
  "id_number_type": "us_passport",
  "id_number": "123456789",
  "citizenship_code": "US"
}

Response

Successfully updated beneficiary participant. Returns the updated resource.

Example response

{
  "message": {
    "first_name": "John",
    "last_name": "Smith",
    "email": "test@example.com",
    "address_one": "123 Main St.",
    "address_two": "Suite 1000",
    "jurisdiction_code": "US-IL",
    "city": "Chicago",
    "zip": "12345",
    "date_of_birth": "1985-09-02",
    "id_number_type": "us_passport",
    "id_number": "123456789",
    "citizenship_code": "US",
    "phone_number": "15557778888",
    "platform_code": "XXXXXX",
    "participant_code": "XXXXXX"
  }
}