Update a document
Updates a document.
The unique identifier of the document to be updated.
Object that contains the document.
Array that contains the document. The array supports multiple attachments for uploading different sides or pages of a document.
Your description for the document.
The expiry date of the document, in YYYY-MM-DD format.
The filename of the document.
The two-character ISO 3166-1 alpha-2 country code where the document was issued. For example, US.
The state or province where the document was issued (AU only).
The number in the document.
Contains information about the resource that owns the document.
Type of document, used when providing an ID number or uploading a document. The possible values depend on the legal entity type.
When providing ID numbers:
- For individual, the
typevalues can be driversLicense, identityCard, nationalIdNumber, or passport.
When uploading documents:
-
For organization, the
typevalues can be proofOfAddress, registrationDocument, taxDocument, proofOfOwnership, or proofOfIndustry. -
For individual, the
typevalues can be identityCard, driversLicense, proofOfNationalIdNumber, proofOfResidency, or proofOfIndustry. -
Use bankStatement to upload documents for a transfer instrument.
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.
400 - Bad Request
A problem reading or understanding the request.
401 - Unauthorized
Authentication required.
403 - Forbidden
Insufficient permissions to process the request.
422 - Unprocessable Entity
A request validation error.
500 - Internal Server Error
The server could not process the request.