Get Document Info

GET/documents/{documentId}

This endpoint provides dual functionality based on the Accept header:

  • JSON Response: When no specific Accept header or application/json is provided, this endpoint returns document metadata information.
  • File Download: When the Accept header matches one of the supported document formats (application/pdf, image/jpeg, or image/png), the endpoint returns the actual document file for download.

Only documents with category “transfer_purpose” can be downloaded, and the document’s mime type must match one of the supported formats.

Path Parameters

documentIdstringrequired

Response

OK

idstring<uuid>
external_idstring

A reference to the document given by API caller

owner_idstring<uuid>

The ID of an individual or company who owns the document.

category"identity_verification"

More categories will be added over time.

document_type"passport" | "national_id" | "selfie_photo" | "kyc_provider_result"

The type kyc_provider_result can be used to upload reports from the 3rd party KYC providers.

mime_typestring

The type kyc_provider_result can be used to upload reports from the 3rd party KYC providers.

file_namestring
file_idstring
status"none" | "valid" | "pending" | "rejected" | "expired"
expires_atstring<date-time>

Time of expiry of the validity of this identity document.

created_atstring<date-time>
updated_atstring<date-time>

Error defines errors may be returned from the system.

messagestring
errorsobject[]
Show errors properties
errorCodestring
messagestring

Error defines errors may be returned from the system.

messagestring
errorsobject[]
Show errors properties
errorCodestring
messagestring

Error defines errors may be returned from the system.

messagestring
errorsobject[]
Show errors properties
errorCodestring
messagestring
Request
curl -X GET "https://api.uat.triple-a.io/api/fiat-payout/v1/documents/<documentId>" \
  -H "Authorization: Bearer <token>"
Response
{
  "id": "00000000-0000-0000-0000-000000000000",
  "external_id": "string",
  "owner_id": "00000000-0000-0000-0000-000000000000",
  "category": "identity_verification",
  "document_type": "passport",
  "mime_type": "string",
  "file_name": "string",
  "file_id": "string",
  "status": "pending",
  "expires_at": "1970-01-01T00:00:00.000Z",
  "created_at": "1970-01-01T00:00:00.000Z",
  "updated_at": "1970-01-01T00:00:00.000Z"
}