Update a document
Updates a document.
You can upload a maximum of 15 pages for photo IDs.
Header Parameters
Use the requested verification code 0_0001 to resolve any suberrors associated with the document. Requested verification codes can only be used in your test environment.
Path Parameters
The unique identifier of the document to be updated.
Request Parameters
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.
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
typevalues can be proofOfAddress, registrationDocument, vatDocument, proofOfOrganizationTaxInfo, proofOfOwnership, proofOfIndustry, proofOfSignatory, or proofOfFundingOrWealthSource. -
For individual, the
typevalues can be identityCard, driversLicense, passport, liveSelfie, proofOfNationalIdNumber, proofOfResidency, proofOfIndustry, proofOfIndividualTaxId, proofOfFundingOrWealthSource or proofOfRelationship. -
For soleProprietorship, the
typevalues can be constitutionalDocument, proofOfAddress, or proofOfIndustry. -
For trust, the
typevalue is constitutionalDocument. -
For unincorporatedPartnership, the
typevalue is constitutionalDocument. -
Use bankStatement to upload documents for a transfer instrument.
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.