v1

latestOpenAPI 3.1.02026-07-241653251.3 MB
Individual Participants

Update customer

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.

patch/participants/customers/{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.

Request body

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"
  }
}