Documents

Get document by ID

Returns a single compliance document.

get/api/documents/{id}

Request

  • Base URL: http://localhost:4100
  • URL: http://localhost:4100/api/documents/{id}
  • Auth: none required

Path parameters

idstring uuid required

Document ID

Response

Document

account_holder_idstring uuid required
content_typestring nullable
descriptionstring nullable
document_numberstring nullable
document_type'identity_document' | 'proof_of_address' | 'source_of_funds' | 'business_registration' | 'ubo_declaration' | 'pep_declaration' | 'other' required
file_keystring nullable
file_namestring nullable
file_sizeinteger nullable
idstring uuid
inserted_atstring date-time
metadataobject nullable
namestring required
primaryboolean required
status'draft' | 'submitted' | 'under_review' | 'accepted' | 'rejected' | 'expired' nullable
tenant_idstring uuid required
updated_atstring date-time

Example response

{
  "account_holder_id": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6",
  "content_type": "",
  "description": "",
  "document_number": "",
  "document_type": "identity_document",
  "file_key": "",
  "file_name": "",
  "file_size": 0,
  "id": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6",
  "inserted_at": "2020-04-20T16:20:00Z",
  "metadata": {},
  "name": "",
  "primary": false,
  "status": "draft",
  "tenant_id": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6",
  "updated_at": "2020-04-20T16:20:00Z"
}

Changes

No recorded changes to this operation across all 4 revisions of this API.