Document Endpoints

document

This endpoint is used to upload account documents.Only one document can be uploaded by request. You must provide the document name and its content. Here are some rules regarding the document requirements:

  • The types accepted are: PDF, PNG or JPEG

  • The maximum allowed file size is 10Mb

  • Files must be sent as base64. Make sure the base64 code is valid (must contain the initial file information. E.g. data:image/jpeg;base64

  • The same document cannot be uploaded twice with the same name

post/document

Request

  • Base URL
    https://earthnode-dev.vopay.com/api/v2
  • URL
    https://earthnode-dev.vopay.com/api/v2/document
  • Auth
    none declared

Request body application/x-www-form-urlencoded

AccountIDstring required

Your account ID

Keystring required

API key for the account

Signaturestring required

Hashed signature for the request

DocumentNamestring required

Document description

DocumentContentstring required

Base64 code of the document content. Allowed content types: PDF, JPG, PNG.

DocumentTypestring required

String that identify the document type: 'kyc' or 'invoice'.

Response

Successboolean

True if the request was successful, false if it failed

ErrorMessagestring

Contains a description of the error if the request failed

DocumentIDstring

This ID should be saved as it is required in order to retrieve the uploaded document URL

Changes

No recorded changes to this operation across all 1 revision of this API.