Updated Response on PATCH Participants

Release Details

Release Date: Aug 2, 2024

Release Type

Informational – Optional action from platforms

Summary

Platforms currently using the KYC as a Service product will see a reduced set of fields returned by the PATCH /participants/customers/ endpoint as seen in the sample response below.

CERT Aug 2, 2024
PROD Aug 2, 2024

Remaining platforms and all API users will see the fields returned by the PATCH /participants/customers/ endpoint updated to the below sample response on:

CERT Aug 12, 2024
PROD Sep 2, 2024

Once this change is live for your platform, only the below fields will be returned even if you updated a field not included in the response. The change was successful if you received a 200 response.

Action Required

Action is needed if your platform is reliant on any of the fields that will be removed from the response. Please review your current use of PATCH /participants/customers/ to determine if there is any impact.

Endpoints Impacted

PATCH /participants/customers/{participant_code}

Sample Response:

After platform submits a customer information update via PATCH /participants/customers/, Zero Hash responds:

{
    "message": {
        "first_name": "John",
        "last_name": "Smith",
        "country": "United States",
        "state": "IL",
        "email": "[email protected]",
        "platform_code": "PLAT01",
        "participant_code": "CUST01"
    }
}