Ask us anything. We're here to help.

2020-10-27: Major Upgrade to the POST /customers Endpoint

Change Overview & Release Planning

The following describes a major upgrade to the POST /participants/customers endpoint, which will be rolled out as an entirely new POST /participants/customers/new endpoint. The changes will require client development as the data and layout are a significant departure from today's standards.

In order to support different client development timelines, Zero Hash will support both the old and new endpoints concurrently for a period, but the POST /participants/customers endpoint will eventually be deprecated and retired, once all consumers have converted. We will be in touch about a final deprecation date.

You can refer to our API docs describing the new endpoint here.

API Updates

The new format makes some significant updates to the previous endpoint, with a specific focus on breaking down the information sent via the metadata object into specific fields. An example of the data format required for the new POST /participants/customers/new endpoint is as follows:

{
"first_name":"John",
"last_name":"Smith",
"email":"email-example@mail.com",
"address_one":"1 Main St.",
"address_two":"Suite 1000",
"country":"United States",
"state":"IL",
"city":"Chicago",
"zip":"12345",
"date_of_birth":"1985-09-02",
"id_number_type":"ssn",
"id_number":"123456789",
"non_us_other_type":null,
"id_issuing_authority":null,
"signed_timestamp":1603378501286,
"risk_rating":null,
"metadata":{}
}

You can refer to the API docs here for the definitions of each field. Not all fields are required, and some fields are conditionally required.

The goal of the change is to improve our ability to operate and report on compliance-related requests. We appreciate your support through the upgrade. If you have any questions, feel free to reach out.