Sign in

v50

latestOpenAPI 3.1.0raw.githubusercontent.com2026-04-143490310.6 KB
Documents

Get a document

Returns a document.

Requests to this endpoint are subject to rate limits:

  • Live environments: 700 requests per 5 seconds.

  • Test environments: 200 requests per 5 seconds.

  • Failed requests are subject to a limit of 5 failures per 10 seconds.

get/documents/{id}

Path parameters

idstring required

The unique identifier of the document.

Query parameters

skipContentboolean

Do not load document content while fetching the document.

Response

OK - the request has succeeded.

creationDatestring date-time

The creation date of the document.

descriptionstring required

Your description for the document.

expiryDatestring

The expiry date of the document, in YYYY-MM-DD format.

fileNamestring

The filename of the document.

idstring

The unique identifier of the document.

issuerCountrystring

The two-character ISO 3166-1 alpha-2 country code where the document was issued. For example, US.

issuerStatestring

The state or province where the document was issued (AU only).

modificationDatestring date-time

The modification date of the document.

numberstring

The number in the document.

type'bankStatement' | 'driversLicense' | 'identityCard' | 'nationalIdNumber' | 'passport' | 'proofOfAddress' | 'proofOfNationalIdNumber' | 'proofOfResidency' | 'registrationDocument' | 'vatDocument' | 'proofOfOrganizationTaxInfo' | 'proofOfIndividualTaxId' | 'proofOfOwnership' | 'proofOfSignatory' | 'liveSelfie' | 'proofOfIndustry' | 'constitutionalDocument' | 'proofOfFundingOrWealthSource' | 'proofOfRelationship' required

Type of document, used when providing an ID number or uploading a document. The possible values depend on the legal entity type.

  • For organization, the type values can be proofOfAddress, registrationDocument, vatDocument, proofOfOrganizationTaxInfo, proofOfOwnership, proofOfIndustry, proofOfSignatory, or proofOfFundingOrWealthSource.

  • For individual, the type values can be identityCard, driversLicense, passport, liveSelfie, proofOfNationalIdNumber, proofOfResidency, proofOfIndustry, proofOfIndividualTaxId, proofOfFundingOrWealthSource or proofOfRelationship.

  • For soleProprietorship, the type values can be constitutionalDocument, proofOfAddress, or proofOfIndustry.

  • For trust, the type value is constitutionalDocument.

  • For unincorporatedPartnership, the type value is constitutionalDocument.

  • Use bankStatement to upload documents for a transfer instrument.