ZEzerohash
Individual Participants

Update customer

Changed on

Update 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 it.

This is a partial update — send only the fields you want to change. platform_updated_at (the timestamp of the change on your platform, in milliseconds since the Unix epoch) is required on every request.

💡 Use the Examples / schema dropdown on the request body to see common update scenarios (standard details, change of address, change of name, W-9 document generation, W-9 document upload, W-8BEN, tax withholding, KYC/compliance, EDD, and an all-accepted-fields reference).

patch/participants/customers/{participant_code}

Request

  • Base URL
    https://api.cert.zerohash.com
  • URL
    https://api.cert.zerohash.com/participants/customers/{participant_code}
  • Auth
    API key in header X-SCX-API-KEY and API key in header X-SCX-PASSPHRASE

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.

Request body

OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR

Example request

{
  "first_name": "John",
  "last_name": "Doe",
  "address_one": "123 Main St.",
  "city": "Chicago",
  "postal_code": "60601",
  "platform_updated_at": 1680643465352
}

Response

Successfully updated customer participant. Returns the updated resource.

Example response

{
  "message": {
    "first_name": "John",
    "last_name": "Smith",
    "country": "USA",
    "jurisdiction_code": "US-IL",
    "email": "test@example.com",
    "signed_timestamp": 1603378501286,
    "signed_agreements": [
      {
        "type": "user_agreement",
        "region": "us",
        "signed_timestamp": 1603378501286
      }
    ],
    "platform_code": "XXXXXX",
    "participant_code": "XXXXXX",
    "phone_number": "+15557778888"
  }
}

Changes

  • 47cf70ae701cRevision changes
    • breaking

      removed subschema #1: Standard User Details Patch subschema #2: W-9 Form Update subschema #3: W-9 Exemption Update subschema #4: Tax Withholding Update subschema #5: Change of Address subschema #6: Change of Name subschema #7: Update Requiring Supporting Documentation from the request body oneOf list

    • warning

      added the new virtual_accounts enum value to the /// response property for the response status

    • info

      added subschema #1: Standard User Details Patch subschema #2: W-9 Form document generation subschema #3: W-9 Form document upload subschema #4: W-9 Exemption Update subschema #5: Tax Withholding Update subschema #6: Signed Agreements Update subschema #7: Change of Address subschema #8: Change of Name subschema #9: Update Requiring Supporting Documentation subschema #10: W-8BEN Form Update (foreign individual) subschema #11: KYC / Compliance Update subschema #12: Enhanced Due Diligence (EDD) Update subschema #13: All Accepted Fields (reference) to the request body anyOf list