Create a Document

Creates a new document for the authenticated user or entity.

curl --request POST \
  --url https://api.nuvion.tech/documents \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "description": "Business registration certificate",
  "urls": {
    "main": "https://storage.example.com/documents/reg-cert-123.pdf"
  },
  "meta": {
    "file_size": 2048576,
    "file_type": "application/pdf",
    "document_category": "business_registration",
    "verification_notes": "Original certificate issued by state authorities",
    "expiry_date": "2030-12-31"
  },
  "link_to_identity": {
    "person_id": "01HJ5G6R7MXW5ZK2QD6YA8N9F5",
    "identity_type": "international_passport",
    "auto_update_verification": true
  }
}
'

{
  "message": "Document submitted successfully",
  "status": 201,
  "data": {
    "document": {
      "id": "01HJ5G6R7MXW5ZK2QD6YA8N9F3",
      "entity_id": "01HJ5G6R7MXW5ZK2QD6YA8N9F4",
      "description": "Business registration certificate",
      "urls": {
        "main": "https://storage.example.com/documents/reg-cert-123.pdf"
      },
      "meta": {
        "file_size": 2048576,
        "file_type": "application/pdf",
        "document_category": "business_registration",
        "verification_notes": "Original certificate issued by state authorities",
        "expiry_date": "2030-12-31",
        "verification_status": "pending",
        "uploaded_at": 1694520000000
      },
      "created": 1694520000000,
      "updated": 1694520000000
    },
    "entity_verification_impact": {
      "entity_id": "01HJ5G6R7MXW5ZK2QD6YA8N9F4",
      "auto_verification_triggered": true,
      "verification_status_changed": false,
      "current_verification_status": "pending",
      "previous_verification_status": "pending",
      "pending_verification_requirements": [
        "proof_of_address",
        "director_id"
      ]
    },
    "identity_link_result": {
      "person_id": "01HJ5G6R7MXW5ZK2QD6YA8N9F5",
      "verification_updated": false,
      "previous_document_id": "01HJ5G6R7MXW5ZK2QD6YA8N9F6",
      "identity_type": "international_passport",
      "verification_impact": "pending_review"
    }
  }
}

POST

documents

Creates a new document for the authenticated user or entity.

curl --request POST \
  --url https://api.nuvion.tech/documents \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "description": "Business registration certificate",
  "urls": {
    "main": "https://storage.example.com/documents/reg-cert-123.pdf"
  },
  "meta": {
    "file_size": 2048576,
    "file_type": "application/pdf",
    "document_category": "business_registration",
    "verification_notes": "Original certificate issued by state authorities",
    "expiry_date": "2030-12-31"
  },
  "link_to_identity": {
    "person_id": "01HJ5G6R7MXW5ZK2QD6YA8N9F5",
    "identity_type": "international_passport",
    "auto_update_verification": true
  }
}
'

{
  "message": "Document submitted successfully",
  "status": 201,
  "data": {
    "document": {
      "id": "01HJ5G6R7MXW5ZK2QD6YA8N9F3",
      "entity_id": "01HJ5G6R7MXW5ZK2QD6YA8N9F4",
      "description": "Business registration certificate",
      "urls": {
        "main": "https://storage.example.com/documents/reg-cert-123.pdf"
      },
      "meta": {
        "file_size": 2048576,
        "file_type": "application/pdf",
        "document_category": "business_registration",
        "verification_notes": "Original certificate issued by state authorities",
        "expiry_date": "2030-12-31",
        "verification_status": "pending",
        "uploaded_at": 1694520000000
      },
      "created": 1694520000000,
      "updated": 1694520000000
    },
    "entity_verification_impact": {
      "entity_id": "01HJ5G6R7MXW5ZK2QD6YA8N9F4",
      "auto_verification_triggered": true,
      "verification_status_changed": false,
      "current_verification_status": "pending",
      "previous_verification_status": "pending",
      "pending_verification_requirements": [
        "proof_of_address",
        "director_id"
      ]
    },
    "identity_link_result": {
      "person_id": "01HJ5G6R7MXW5ZK2QD6YA8N9F5",
      "verification_updated": false,
      "previous_document_id": "01HJ5G6R7MXW5ZK2QD6YA8N9F6",
      "identity_type": "international_passport",
      "verification_impact": "pending_review"
    }
  }
}

Headers

Authorization

string

required

Authorization header: Bearer {jwt or Secretkey}

Body

application/json

description

string

required

Description of the document

urls

object

required

URLs to the document files

Show child attributes

urls.main

string

required

URL to the main document file

urls.back

string

URL to the back side of the document (if applicable)

Response

Created successfully

message

string

required

A descriptive message indicating the result of the operation

status

string

required

The status of the API operation (successful, error, failed, pending)

data

object

required

Container for the created document data and related information

Show child attributes

data.document

object

required

Information about the submitted document

Show child attributes

data.document.id

string

required

Unique identifier for the document

data.document.entity_id

string

required

ID of the entity this document belongs to

data.document.description

string

required

Description of the document

data.document.urls

object

required

URLs associated with the document

Show child attributes

data.document.urls.main

string

required

Main URL for accessing the document

data.document.meta

object

required

Additional metadata for the document

Show child attributes

data.document.meta.file_size

number

required

Size of the file in bytes

data.document.meta.file_type

string

required

MIME type of the file

data.document.meta.document_category

string

required

Category of the document

data.document.meta.verification_status

string

required

Current verification status of the document

data.document.meta.uploaded_at

number

required

Timestamp when the document was uploaded

data.document.meta.verification_notes

string

Notes about document verification

data.document.meta.expiry_date

string

Date when the document expires

data.document.created

number

required

Timestamp when the document record was created

data.document.updated

number

required

Timestamp when the document record was last updated

data.entity_verification_impact

object

required

Information about how this document affects entity verification

Show child attributes

data.entity_verification_impact.entity_id

string

required

ID of the entity affected by this document

data.entity_verification_impact.auto_verification_triggered

boolean

required

Indicates if automatic verification was triggered

data.entity_verification_impact.verification_status_changed

boolean

required

Indicates if the verification status changed

data.entity_verification_impact.current_verification_status

string

required

Current verification status of the entity

data.entity_verification_impact.previous_verification_status

string

required

Previous verification status of the entity

data.entity_verification_impact.pending_verification_requirements

string[]

required

List of pending verification requirements

data.identity_link_result

object

required

Information about how this document affects identity verification

Show child attributes

data.identity_link_result.person_id

string

required

ID of the person linked to this document

data.identity_link_result.verification_updated

boolean

required

Indicates if the verification was updated

data.identity_link_result.identity_type

string

required

Type of identity document

data.identity_link_result.verification_impact

string

required

Impact of this document on verification

data.identity_link_result.previous_document_id

string

ID of the previous document if any

Delete an entity Retrieve an Entity Document

⌘I

Business Entities

Individual Entities

Entities

Documents

Entity Documents

Accounts

Accounts Details

Counterparties

Counterparty Lookup

Bank Transfers

Mobile Money Transfers

Issuers

Create a Document

Headers

Body

Response