Legal Entity Management v3 - Get a document

Path parameters

Required Optional

id string Required

The unique identifier of the document.

Response parameters

After submitting a call, you receive a response message to inform you that your request was received and processed.

Depending on the HTTP status code of the response message, it is helpful to build some logic to handle any errors that a request or the system may return.

HTTP Responses

200 - OK

The request has succeeded.
Show more Show less
attachment object Deprecated in version 1
Use the attachments array instead.

Object that contains the document.

Show children Hide children

content string

The document in Base64-encoded string format.

contentType string Deprecated in version 1

The file format.

Possible values: application/pdf, image/jpg, image/jpeg, image/png.

filename string Deprecated in version 1

The name of the file including the file extension.

pageName string

The name of the file including the file extension.

pageType string

Specifies which side of the ID card is uploaded.

When type is driversLicense or identityCard, set this to front or back.

When omitted, we infer the page number based on the order of attachments.

attachments array [object]

Array that contains the document. The array supports multiple attachments for uploading different sides or pages of a document.

Show children Hide children

content string

The document in Base64-encoded string format.

contentType string Deprecated in version 1

The file format.

Possible values: application/pdf, image/jpg, image/jpeg, image/png.

filename string Deprecated in version 1

The name of the file including the file extension.

pageName string

The name of the file including the file extension.

pageType string

Specifies which side of the ID card is uploaded.

When type is driversLicense or identityCard, set this to front or back.

When omitted, we infer the page number based on the order of attachments.

creationDate string

The creation date of the document.

description string

Your description for the document.

expiryDate string Deprecated in version 1

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

fileName string

The filename of the document.

id string

The unique identifier of the document.

issuerCountry string Deprecated in version 1

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

issuerState string Deprecated in version 1

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

modificationDate string

The modification date of the document.

number string

The number in the document.

owner object

Contains information about the resource that owns the document.

Show children Hide children

id string

Unique identifier of the resource that owns the document. For type legalEntity, this value is the unique identifier of the legal entity. For type bankAccount, this value is the unique identifier of the transfer instrument.

type string

Type of resource that owns the document.

Possible values: legalEntity, bankAccount.

type string

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, or proofOfFundingOrWealthSource.

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

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

Use bankStatement to upload documents for a transfer instrument.
400 - Bad Request

A problem reading or understanding the request.
Show more Show less
errorCode string

The error code mapped to the error message.

errorType string

The category of the error.

message string

A short explanation of the issue.

pspReference string

The PSP reference of the payment.

status integer

The HTTP response status.
401 - Unauthorized

Authentication required.
Show more Show less
errorCode string

The error code mapped to the error message.

errorType string

The category of the error.

message string

A short explanation of the issue.

pspReference string

The PSP reference of the payment.

status integer

The HTTP response status.
403 - Forbidden

Insufficient permissions to process the request.
Show more Show less
errorCode string

The error code mapped to the error message.

errorType string

The category of the error.

message string

A short explanation of the issue.

pspReference string

The PSP reference of the payment.

status integer

The HTTP response status.
422 - Unprocessable Entity

A request validation error.
Show more Show less
errorCode string

The error code mapped to the error message.

errorType string

The category of the error.

message string

A short explanation of the issue.

pspReference string

The PSP reference of the payment.

status integer

The HTTP response status.
500 - Internal Server Error

The server could not process the request.
Show more Show less
errorCode string

The error code mapped to the error message.

errorType string

The category of the error.

message string

A short explanation of the issue.

pspReference string

The PSP reference of the payment.

status integer

The HTTP response status.

Get a document

Endpoint destination URL

Path parameters

Response parameters

HTTP Responses

200 - OK

400 - Bad Request

401 - Unauthorized

403 - Forbidden

422 - Unprocessable Entity

500 - Internal Server Error