Sign in

v1

latestOpenAPI 3.1.02026-07-241653251.3 MB
Query Participants

Get participant document metadata

Returns a list of KYC document metadata for a participant. Does not include document contents or signed URLs.

get/participant/{participant_code}/full_info/document_metadata

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.

Response

Successfully retrieved document metadata list. Returns an empty array if no documents exist for the participant.

Example response

{
  "message": {
    "participant_code": "ABCDEF",
    "documents": [
      {
        "document_id": "e39e7b6a908e397dac50e461eb2d284820214ca2cb3c4aa9aeb9dfc1873332a0",
        "file_name": "passport.pdf",
        "participant_code": "ABCDEF",
        "document_type": "us_passport",
        "created_at": 1678901234567
      }
    ]
  }
}