Skip to main content
Skip table of contents

Upload Merchant Documents via API

Merchant boarding documents, required by underwriting, can be provided by using notes, noteDocuments, and files API endpoints.

Steps to upload documents via API:

  1. Create a note and associate it with an entity (the newly created merchant’s entity).

    POST /notes
    Content-Type: application/json
      "entity": <entity ID>,
      "type": "note",
      "note": "Sample description of note"

  2. Create a noteDocument and associate it with the previously created note.

    POST /noteDocuments
    Content-Type: application/json
      "note": <note ID from step 1>,
      "type": <file type>,
      "documentType": <document type>,
      "description": "Description of file"

  3. Upload a file for the previously created noteDocument.

    POST /files/noteDocuments/<noteDocument id from step 2>
    Content-Type: multipart/form-data
    Body: form-data
    name: Document Name
    filename: <Selected File> 

Valid file and document type field values are as follows:

File Types

Document Types

  • jpg / jpeg

  • gif

  • png

  • pdf

  • tif / tiff

  • txt

  • xml

  • asc

  • rtf

  • csv

  • xls

  • doc

  • odt

  • ods

  • json

  • soap

  • general

  • personalId

  • companyId

  • voidCheck

  • bankStatement

  • bankLetter

  • contract

  • taxDocument

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.