v1

latestOpenAPI 3.1.02026-07-241653251.3 MB
Individual Participants

Submit documents

Submits a document on behalf of you or a customer if you operate a platform on zerohash.

post/participants/documents

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

Example request

{
  "document": "aGVsbG8gd29ybGQ=",
  "mime": "pdf",
  "file_name": "supporting_document.pdf",
  "participant_code": "CUST01",
  "document_type": "us_drivers_license",
  "id_front": true
}

Response

Successfully created participant document. Returns the created resource with generated IDs and timestamps.

Example response

{
  "message": {
    "state": "Success",
    "file_name": "supporting_document.pdf",
    "created_at": 1572899177383
  }
}