Update a document

patch /documents/{id}

Updates a document.

You can upload a maximum of 15 pages for photo IDs.

Endpoint destination URL

Click to copy

Header parameters

x-requested-verification-code string

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

id string Required

The unique identifier of the document to be updated.

Request parameters

attachment object Deprecated in version 1

Use the attachments array instead.

Object that contains the document.

attachments array [object]

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

description string Required

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.

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).

number string

The number in the document.

owner object

Contains information about the resource that owns the document.

type string 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, 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.

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
  • 400 - Bad Request

    A problem reading or understanding the request.

    Show more Show less
  • 401 - Unauthorized

    Authentication required.

    Show more Show less
  • 403 - Forbidden

    Insufficient permissions to process the request.

    Show more Show less
  • 422 - Unprocessable Entity

    A request validation error.

    Show more Show less
  • 500 - Internal Server Error

    The server could not process the request.

    Show more Show less
  • Request
  • Click to copy
  • Response
  • Click to copy