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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Unique participant identifier. Always 6 uppercase alphanumeric characters.

Body Params

Updated customer profile fields (all fields optional, only send fields to update)

Patch for standard user details such as address, phone, name, etc.

string

The first name of the customer being onboarded.

string

The middle name of the customer being onboarded.

string

The last name of the customer being onboarded.

string

The former name of the customer being onboarded.

string
enum

Customer gender.

Allowed:
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.
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.
string
enum

The ISO-3166-1 alpha3 country, e.g.USA, IRL.

string
enum

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.

string

The city customer resides in.

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.

string
length ≥ 4

Same as zip. Postal code of the customer, in the format "min 4 characters, no leading or trailing spaces".

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

string

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

string

The phone number of the participant

number
required

Platform updated timestamp

Headers
string
required

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

string
required

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

Responses

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