Skip to main content
POST
/
api
/
v1
/
documents
Upload a document
curl --request POST \
  --url http://localhost:45000/api/v1/documents \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --header 'x-api-key: <api-key>' \
  --form 'entityId=<string>'
{
  "id": "<string>",
  "fileName": "<string>",
  "mimeType": "<string>",
  "size": 123,
  "category": "<string>",
  "entityType": "<string>",
  "entityId": "<string>",
  "isInternal": true,
  "createdAt": "<string>",
  "downloadUrl": "<string>"
}

Authorizations

​
x-api-key
string
header
required

Nuvera API application secret key

​
Authorization
string
header
required

RS256 per-request signed JWT

Body

multipart/form-data
​
category
enum<string>
required

Document category

Available options:
CERTIFICATE_OF_INCORPORATION,
ARTICLES_OF_ASSOCIATION,
PROOF_OF_ADDRESS,
COMPANY_STRUCTURE_CHART,
BANK_STATEMENT,
FINANCIAL_ACCOUNTS,
SHAREHOLDER_CONFIRMATION,
AML_POLICY,
ID_FRONT,
ID_BACK,
PERSON_PROOF_OF_ADDRESS,
INVOICE,
SUPPORTING_DOCUMENT,
SWIFT_CONFIRMATION,
OTHER,
SHARE_REGISTER,
LICENSE_PERMIT,
REGISTER_OF_DIRECTORS,
BOARD_RESOLUTION_MINUTES,
POWER_OF_ATTORNEY,
TECHNICAL_FUND_FLOW_DOCUMENT,
SELFIE
​
entityType
enum<string>
required

Entity this document belongs to

Available options:
CUSTOMER,
CUSTOMER_PERSON,
CUSTOMER_LEGAL_ENTITY_SHAREHOLDER,
BENEFICIARY,
PAYMENT,
ORGANIZATION,
ORGANIZATION_PERSON
​
entityId
string
required

ID of the entity (resolved from auth for ORGANIZATION)

Response

default - application/json
​
id
string
required
​
fileName
string
required
​
mimeType
string
required
​
size
number
required
​
category
string
required
​
entityType
string
required
​
entityId
string
required
​
isInternal
boolean
required
​
createdAt
string
required
​
downloadUrl
string