---
title: "Update customer"
method: PATCH
path: "/participants/customers/{participant_code}"
tags: ["Individual Participants"]
---

# Update customer

`PATCH /participants/customers/{participant_code}`

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

## Path parameters

- `participant_code` string, required

## Headers

- `X-SCX-SIGNED` string, required
- `X-SCX-TIMESTAMP` string, required

## Request body

- union
  - object — Patch for standard user details such as address, phone, name, etc.
    - `first_name` string — The first name of the customer being onboarded.
    - `middle_name` string — The middle name of the customer being onboarded.
    - `last_name` string — The last name of the customer being onboarded.
    - `former_name` string — The former name of the customer being onboarded.
    - `gender` 'male' | 'female' | 'other' — Customer gender.
    - `address_one` string — 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_two` string — 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.
    - `country` 'AND' | 'ARE' | 'AFG' | 'ATG' | 'AIA' | 'ALB' | 'ARM' | 'AGO' | 'ATA' | 'ARG' | 'ASM' | 'AUT' | 'AUS' | 'ABW' | 'ALA' | 'AZE' | 'BIH' | 'BRB' | 'BGD' | 'BEL' | 'BFA' | 'BGR' | 'BHR' | 'BDI' | 'BEN' | 'BLM' | 'BMU' | 'BRN' | 'BOL' | 'BES' | 'BRA' | 'BHS' | 'BTN' | 'BVT' | 'BWA' | 'BLR' | 'BLZ' | 'CAN' | 'CCK' | 'COD' | 'CAF' | 'COG' | 'CHE' | 'CIV' | 'COK' | 'CHL' | 'CMR' | 'CHN' | 'COL' | 'CRI' | 'CUB' | 'CPV' | 'CUW' | 'CXR' | 'CYP' | 'CZE' | 'DEU' | 'DJI' | 'DNK' | 'DMA' | 'DOM' | 'DZA' | 'ECU' | 'EST' | 'EGY' | 'ESH' | 'ERI' | 'ESP' | 'ETH' | 'FIN' | 'FJI' | 'FLK' | 'FSM' | 'FRO' | 'FRA' | 'GAB' | 'GBR' | 'GRD' | 'GEO' | 'GUF' | 'GGY' | 'GHA' | 'GIB' | 'GRL' | 'GMB' | 'GIN' | 'GLP' | 'GNQ' | 'GRC' | 'SGS' | 'GTM' | 'GUM' | 'GNB' | 'GUY' | 'HKG' | 'HMD' | 'HND' | 'HRV' | 'HTI' | 'HUN' | 'IDN' | 'IRL' | 'ISR' | 'IMN' | 'IND' | 'IOT' | 'IRQ' | 'IRN' | 'ISL' | 'ITA' | 'JEY' | 'JAM' | 'JOR' | 'JPN' | 'KEN' | 'KGZ' | 'KHM' | 'KIR' | 'COM' | 'KNA' | 'PRK' | 'KOR' | 'KWT' | 'CYM' | 'KAZ' | 'LAO' | 'LBN' | 'LCA' | 'LIE' | 'LKA' | 'LBR' | 'LSO' | 'LTU' | 'LUX' | 'LVA' | 'LBY' | 'MAR' | 'MCO' | 'MDA' | 'MNE' | 'MAF' | 'MDG' | 'MHL' | 'MKD' | 'MLI' | 'MMR' | 'MNG' | 'MAC' | 'MNP' | 'MTQ' | 'MRT' | 'MSR' | 'MLT' | 'MUS' | 'MDV' | 'MWI' | 'MEX' | 'MYS' | 'MOZ' | 'NAM' | 'NCL' | 'NER' | 'NFK' | 'NGA' | 'NIC' | 'NLD' | 'NOR' | 'NPL' | 'NRU' | 'NIU' | 'NZL' | 'OMN' | 'PAN' | 'PER' | 'PYF' | 'PNG' | 'PHL' | 'PAK' | 'POL' | 'SPM' | 'PCN' | 'PRI' | 'PSE' | 'PRT' | 'PLW' | 'PRY' | 'QAT' | 'REU' | 'ROU' | 'SRB' | 'RUS' | 'RWA' | 'SAU' | 'SLB' | 'SYC' | 'SDN' | 'SWE' | 'SGP' | 'SHN' | 'SVN' | 'SJM' | 'SVK' | 'SLE' | 'SMR' | 'SEN' | 'SOM' | 'SUR' | 'SSD' | 'STP' | 'SLV' | 'SXM' | 'SYR' | 'SWZ' | 'TCA' | 'TCD' | 'ATF' | 'TGO' | 'THA' | 'TJK' | 'TKL' | 'TLS' | 'TKM' | 'TUN' | 'TON' | 'TUR' | 'TTO' | 'TUV' | 'TWN' | 'TZA' | 'UKR' | 'UGA' | 'UMI' | 'USA' | 'URY' | 'UZB' | 'VAT' | 'VCT' | 'VEN' | 'VGB' | 'VIR' | 'VNM' | 'VUT' | 'WLF' | 'WSM' | 'YEM' | 'MYT' | 'ZAF' | 'ZMB' | 'ZWE' — The ISO-3166-1 alpha3 country, e.g.`USA`, `IRL`.
    - `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' — 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](https://docs.zerohash.com/reference/get_jurisdiction-subdivisions) passing a `country` parameter.
    - `city` string — The city customer resides in.
    - `zip` string — 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.
    - `postal_code` string — Same as `zip`. Postal code of the customer, in the format "min 4 characters, no leading or trailing spaces".
    - `email` string — Customer email address, required. Note: zerohash will validate that the email is a correctly formatted `email`, and that the value is unique per-platform
    - `date_of_birth` string — Date of birth of the customer in the format `YYYY-MM-DD`
    - `phone_number` string — The phone number of the participant
    - `platform_updated_at` number, required — Platform updated timestamp
  - object — Patch for W-9 form certification, signature, and exemption fields.
    - `is_w_form_certified` boolean, required — Indicates whether the participant is W-Form certified, required for customers onboarded to a US platform. - When `true`, user can be onboarded without restriction, so long as other mandatory fields are provided at time of onboarding. - When `false`, user is restricted and ineligible to transact on the platform.
    - `w_form_certification` number, required — Must be provided with `is_w_form_certified` boolean field to indicate the time at which the user certified their W-form. In the event the user transitions from an uncertified to a certified, the platform must provide a new `w_form_certification` and update `is_w_form_certified` from `false` to `true`.
    - `signature` string, required — This field is used to capture the customer's first and last name as used on the W-form.
    - `signature_timestamp` number, required — This field captures the timestamp at which the user signed their W-form, used in conjunction with the `signature` field.
    - `payee_exemption` '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9' | '10' | '11' | '12' | '13' | 'NONE', required — Payee exemption field that captures enum values for any applicable payee exemption codes 1 - 13, or NONE if no exemption applies. Required for customers onboarded to a US platform.
    - `fatca_reporting_exemption` '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9' | '10' | '11' | '12' | '13' | 'NONE', required — FATCA reporting exemption code (1-13 or NONE)
    - `is_not_subject_backup_withholding` boolean, required — Backup withholding attestation flag. Required for customers onboarded to a US platform. - If the participant confirms they are **not** subject to backup withholding, this field should be set to `true`. - If the participant **is** subject to backup withholding, this field should be set to `false`. This acts as a positive attestation that the participant confirms they are not subject to backup withholding.
    - `platform_updated_at` number, required — Platform updated timestamp
  - object — Patch for updating only W-9 exemption fields.
    - `payee_exemption` '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9' | '10' | '11' | '12' | '13' | 'NONE', required — Payee exemption field that captures enum values for any applicable payee exemption codes 1 - 13, or NONE if no exemption applies. Required for customers onboarded to a US platform.
    - `fatca_reporting_exemption` '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9' | '10' | '11' | '12' | '13' | 'NONE', required — FATCA reporting exemption code (1-13 or NONE)
    - `is_not_subject_backup_withholding` boolean, required — Backup withholding attestation flag. Required for customers onboarded to a US platform. - If the participant confirms they are **not** subject to backup withholding, this field should be set to `true`. - If the participant **is** subject to backup withholding, this field should be set to `false`. This acts as a positive attestation that the participant confirms they are not subject to backup withholding.
    - `platform_updated_at` number, required — Platform updated timestamp
  - object — Patch for updating tax withholding related fields.
    - `tax_id` string — 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.
    - `b_notice_receipt` boolean — Indicates whether a user has been flagged in an IRS B-Notice as not having up-to-date tax information on file. Required for customers onboarded to a US platform.
    - `tin_jurisdiction_reason` 'working_abroad' | 'studying_abroad' | 'dual_residency' | 'business_abroad' | 'real_estate_abroad' | 'other' — Optional. Reason for the tax residence jurisdiction differing from the legal jurisdiction. Defaults to "unknown" if not provided.
    - `tin_jurisdiction_other` string — Optional. Free text explanation when tin_jurisdiction_reason is "other"
    - `additional_tax_residences` AdditionalTaxResidence[] — Optional. Additional tax residences when the participant has tax obligations in multiple jurisdictions. Maximum 25 items.
      - `tax_id` string, required — Tax identification number for the additional tax residence
      - `jurisdiction_code` string, required — The ISO 3166-2 subdivision code that the participant resides in
    - `platform_updated_at` number, required — Platform updated timestamp
  - object — Patch for updating address fields only.
    - `address_one` string, required — 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_two` string — 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.
    - `city` string, required — The city customer resides in.
    - `postal_code` string, required — Same as `zip`. Postal code of the customer, in the format "min 4 characters, no leading or trailing spaces".
    - `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](https://docs.zerohash.com/reference/get_jurisdiction-subdivisions) passing a `country` parameter.
    - `platform_updated_at` number, required — Platform updated timestamp
  - object — Patch for updating customer name fields. Providing supporting documentation proving the name change (e.g., marriage certificate, court order, identity documents) are required for this update.
    - `first_name` string, required — The first name of the customer being onboarded.
    - `middle_name` string — The middle name of the customer being onboarded.
    - `last_name` string, required — The last name of the customer being onboarded.
    - `former_name` string, required — The former name of the customer being onboarded.
    - `platform_updated_at` number, required — Platform updated timestamp
  - object — Patch for updates that require supporting documentation. The update to the participant should be accompanied by supporting documentation using the [`POST /participants/documents` endpoint](https://docs.zerohash.com/reference/post_participants-documents) with the supported `document_type`'s.
    - `first_name` string — The first name of the customer being onboarded.
    - `middle_name` string — The middle name of the customer being onboarded.
    - `last_name` string — The last name of the customer being onboarded.
    - `former_name` string — The former name of the customer being onboarded.
    - `date_of_birth` string — Date of birth of the customer in the format `YYYY-MM-DD`
    - `tax_id` string — 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.
    - `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`.
    - `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' — ### Region-specific guidelines ### Platforms integrated to zerohash USA; - 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`). --- ### Platforms integrated to zerohash EU; The following enums are EU-specific types: - `passport` - `eu_drivers_license` - `national_id` EU platforms can also accept: - `us_passport` - `non_us_passport` - `non_us_other` - `us_drivers_license` - `us_id_card` - `us_passport_card`
    - `tax_residence` object — Tax residence address for the customer
      - `address_one` string — First line of tax residence address
      - `address_two` string — Second line of tax residence address (optional)
      - `city` string — City of tax residence
      - `jurisdiction_code` string, required — Jurisdiction code in ISO-3166-2 format
      - `postal_code` string — Postal code of tax residence
    - `address_one` string — 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.
    - `city` string — The city customer resides in.
    - `postal_code` string — Same as `zip`. Postal code of the customer, in the format "min 4 characters, no leading or trailing spaces".
    - `gross_annual_income_amount` 'up_to_5k' | '5k_to_25k' | '25k_to_100k' | '100k_and_up' — The individual's total pre-tax income from all sources annually, in a currency (e.g., USD, EUR depends on region).
    - `gross_annual_salary_amount` string — The individual's gross annual salary amount, in a currency (e.g., USD, EUR depends on region).
    - `platform_updated_at` number, required — Platform updated timestamp

## Response `200`

Successfully updated customer participant. Returns the updated resource.

- PatchCustomersResponse
  - `message` object — Updated customer summary. Only a fixed subset of identity fields is returned after an update, regardless of which fields were patched.
    - `first_name` string — The first name of the customer being onboarded.
    - `last_name` string — The last name of the customer being onboarded.
    - `country` 'AND' | 'ARE' | 'AFG' | 'ATG' | 'AIA' | 'ALB' | 'ARM' | 'AGO' | 'ATA' | 'ARG' | 'ASM' | 'AUT' | 'AUS' | 'ABW' | 'ALA' | 'AZE' | 'BIH' | 'BRB' | 'BGD' | 'BEL' | 'BFA' | 'BGR' | 'BHR' | 'BDI' | 'BEN' | 'BLM' | 'BMU' | 'BRN' | 'BOL' | 'BES' | 'BRA' | 'BHS' | 'BTN' | 'BVT' | 'BWA' | 'BLR' | 'BLZ' | 'CAN' | 'CCK' | 'COD' | 'CAF' | 'COG' | 'CHE' | 'CIV' | 'COK' | 'CHL' | 'CMR' | 'CHN' | 'COL' | 'CRI' | 'CUB' | 'CPV' | 'CUW' | 'CXR' | 'CYP' | 'CZE' | 'DEU' | 'DJI' | 'DNK' | 'DMA' | 'DOM' | 'DZA' | 'ECU' | 'EST' | 'EGY' | 'ESH' | 'ERI' | 'ESP' | 'ETH' | 'FIN' | 'FJI' | 'FLK' | 'FSM' | 'FRO' | 'FRA' | 'GAB' | 'GBR' | 'GRD' | 'GEO' | 'GUF' | 'GGY' | 'GHA' | 'GIB' | 'GRL' | 'GMB' | 'GIN' | 'GLP' | 'GNQ' | 'GRC' | 'SGS' | 'GTM' | 'GUM' | 'GNB' | 'GUY' | 'HKG' | 'HMD' | 'HND' | 'HRV' | 'HTI' | 'HUN' | 'IDN' | 'IRL' | 'ISR' | 'IMN' | 'IND' | 'IOT' | 'IRQ' | 'IRN' | 'ISL' | 'ITA' | 'JEY' | 'JAM' | 'JOR' | 'JPN' | 'KEN' | 'KGZ' | 'KHM' | 'KIR' | 'COM' | 'KNA' | 'PRK' | 'KOR' | 'KWT' | 'CYM' | 'KAZ' | 'LAO' | 'LBN' | 'LCA' | 'LIE' | 'LKA' | 'LBR' | 'LSO' | 'LTU' | 'LUX' | 'LVA' | 'LBY' | 'MAR' | 'MCO' | 'MDA' | 'MNE' | 'MAF' | 'MDG' | 'MHL' | 'MKD' | 'MLI' | 'MMR' | 'MNG' | 'MAC' | 'MNP' | 'MTQ' | 'MRT' | 'MSR' | 'MLT' | 'MUS' | 'MDV' | 'MWI' | 'MEX' | 'MYS' | 'MOZ' | 'NAM' | 'NCL' | 'NER' | 'NFK' | 'NGA' | 'NIC' | 'NLD' | 'NOR' | 'NPL' | 'NRU' | 'NIU' | 'NZL' | 'OMN' | 'PAN' | 'PER' | 'PYF' | 'PNG' | 'PHL' | 'PAK' | 'POL' | 'SPM' | 'PCN' | 'PRI' | 'PSE' | 'PRT' | 'PLW' | 'PRY' | 'QAT' | 'REU' | 'ROU' | 'SRB' | 'RUS' | 'RWA' | 'SAU' | 'SLB' | 'SYC' | 'SDN' | 'SWE' | 'SGP' | 'SHN' | 'SVN' | 'SJM' | 'SVK' | 'SLE' | 'SMR' | 'SEN' | 'SOM' | 'SUR' | 'SSD' | 'STP' | 'SLV' | 'SXM' | 'SYR' | 'SWZ' | 'TCA' | 'TCD' | 'ATF' | 'TGO' | 'THA' | 'TJK' | 'TKL' | 'TLS' | 'TKM' | 'TUN' | 'TON' | 'TUR' | 'TTO' | 'TUV' | 'TWN' | 'TZA' | 'UKR' | 'UGA' | 'UMI' | 'USA' | 'URY' | 'UZB' | 'VAT' | 'VCT' | 'VEN' | 'VGB' | 'VIR' | 'VNM' | 'VUT' | 'WLF' | 'WSM' | 'YEM' | 'MYT' | 'ZAF' | 'ZMB' | 'ZWE' — The ISO-3166-1 alpha3 country, e.g.`USA`, `IRL`.
    - `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' — 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](https://docs.zerohash.com/reference/get_jurisdiction-subdivisions) passing a `country` parameter.
    - `email` string — Customer email address, required. Note: zerohash will validate that the email is a correctly formatted `email`, and that the value is unique per-platform
    - `signed_timestamp` number — The UNIX timestamp (in milliseconds) when the Services Agreement was accepted by the participant. This timestamp value must be from no longer than one (1) year in the past or one (1) day in the future.
    - `signed_agreements` object[]
      - `type` 'fund_auto_convert' | 'payment_services_terms' | 'account_link' | 'account_funding_payouts' | 'account_funding_general' | 'account_funding_pay' | 'crypto_payouts_service_terms' | 'staking' | 'trust_agreement' | 'zhllc_user_agreement_v1' | 'zhllc_privacy_policy_v1' | 'zhllc_regulatory_disclosures_v1' | 'auth_user_services_agreement_v1' | 'zhllc_payment_sender_terms_v1' | 'zhllc_third_party_disclosures_v1' | 'connect_privacy_policy_v1', required
      - `region` 'worldwide' | 'us' | 'brazil' | 'uk' | 'eu', required
      - `signed_timestamp` number, required — The UNIX timestamp (in milliseconds) when the Fund Auto Convert Agreement was accepted by the participant. This timestamp value must be from no longer than one (1) year in the past or one (1) day in the future.
    - `platform_code` string
    - `participant_code` string
    - `phone_number` string — Customer phone number. Only included in the response for platforms where phone number echo is enabled.

## Other responses

- `400` — Bad Request
- `403` — Forbidden
- `404` — Not Found
- `500` — Internal Server Error
- `503` — Service Unavailable

---

[API](https://skmtc.net/zerohash/apis/zerohash-api.md) · [All operations](https://skmtc.net/zerohash/apis/zerohash-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/zerohash/zerohash-api/revisions/8b647d934363/schema)