Sign in

v1

latestOpenAPI 3.1.02026-07-241653251.3 MB
Individual Participants

Lock customer

When platforms terminate a customer, they may alert zerohash through this endpoint.

post/participants/customers/{participant_code}/lock

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

reason_code'user_request' | 'compliance_issue' required

Reason the customer is being locked.

notesstring required

Additional detail on the lock. Including useful context here can meaningfully speed up investigations on the zerohash side.

Example request

{
  "reason_code": "compliance_issue",
  "notes": "confirmed fraud"
}

Response

Successfully locked customer.