Documents v2

Get Documents

get

Get documents. By default, it returns last 20 documents. It is possible to send query parameters to adjust the result

Authorizations
Query parameters
startDatestring · date-timeOptional

Beginning of the range

endDatestring · date-timeOptional

End of the range

searchTextstringOptional

search string to filter through document names

resourceTypestring · enumRequiredPossible values:
resourceIdstring · uuidRequired
docTypestring · enumOptional

document type filter

Possible values:
cursorstringOptional

String value used for pagination

limitinteger · min: 1Required

Maximum number of items to return

Default: 20
Responses
200

OK

application/json
get
GET /v2/documents HTTP/1.1
Host: tvda-api.platform-test.tradevest.ai
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "data": [
    {
      "documentId": "123e4567-e89b-12d3-a456-426614174000",
      "size": 1,
      "status": "RECEIVED",
      "name": "text",
      "resourceType": "NATURAL_PERSON",
      "type": "KYC",
      "description": "text",
      "resourceId": "123e4567-e89b-12d3-a456-426614174000",
      "externalId": "text",
      "validUntil": "2025-08-29T14:56:31.801Z",
      "createdOn": "2025-08-29T14:56:31.801Z",
      "modifiedOn": "2025-08-29T14:56:31.801Z"
    }
  ],
  "pagination": {
    "cursor": "text",
    "limit": 1
  }
}

Upload Document

post
Document Group
Document Type
Entities/Roles

Company documents

CURRENT_REGISTRY_EXTRACT CHRONOLOGICAL_REGISTRY_EXTRACT SHAREHOLDER_LIST PARTNERSHIP_AGREEMENT TRANSPARENCY_REGISTER_EXTRACT STATUTE

LEGAL_ENTITY

Company documents

BUSINESS_REGISTRATION

NATURAL_PERSON LEGAL_ENTITY

Kyc documents

IDENTIFICATION_CERTIFICATE PROOF_OF_RESIDENCE KYC

NATURAL_PERSON PARTNER_USER

Kyc documents

BIRTH_CERTIFICATE

NATURAL_PERSON (Minor)

Kyc documents

DEATH_CERTIFICATE

NATURAL_PERSON

Tax documents

NON_ASSESSMENT_CERTIFICATE

NATURAL_PERSON LEGAL_ENTITY

Tax documents

TIN_NA_CONFIRMATION

NATURAL_PERSON

Financial situation documents

SOURCE_OF_INCOME SOURCE_OF_FUNDS

CUSTOMER

Proxy documents

PROOF_OF_SINGLE_CUSTODY PROOF_OF_CUSTODY

PROXY (Guardian)

Proxy documents

INSOLVENCY_ORDER

PROXY (Liquidator)

Proxy documents

INHERITANCE_LIGITIMATION

PROXY (Power of Attorney in case of death)

General documents

OTHER

NATURAL_PERSON JOINT_PERSON LEGAL_ENTITY PARTNER_USER CUSTOMER PROXY

Authorizations
Header parameters
Requestor-IDstring · uuidRequired

Unique requestor identification in UUID format

Body
filestring · binaryRequired

File data

Responses
200

OK

application/json
post
POST /v2/documents HTTP/1.1
Host: tvda-api.platform-test.tradevest.ai
Authorization: Bearer YOUR_OAUTH2_TOKEN
Requestor-ID: 123e4567-e89b-12d3-a456-426614174000
Content-Type: multipart/form-data
Accept: */*
Content-Length: 182

{
  "document": {
    "name": "text",
    "resourceType": "NATURAL_PERSON",
    "type": "KYC",
    "description": "text",
    "resourceId": "123e4567-e89b-12d3-a456-426614174000",
    "externalId": "text"
  },
  "file": "binary"
}
{
  "documentId": "123e4567-e89b-12d3-a456-426614174000"
}

Get Document

get

Get document

Authorizations
Path parameters
documentIdstring · uuidRequired

Unique document identification number in UUID format

Responses
200

OK

application/json
get
GET /v2/documents/{documentId} HTTP/1.1
Host: tvda-api.platform-test.tradevest.ai
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "documentId": "123e4567-e89b-12d3-a456-426614174000",
  "size": 1,
  "status": "RECEIVED",
  "name": "text",
  "resourceType": "NATURAL_PERSON",
  "type": "KYC",
  "description": "text",
  "resourceId": "123e4567-e89b-12d3-a456-426614174000",
  "externalId": "text",
  "validUntil": "2025-08-29T14:56:31.801Z",
  "createdOn": "2025-08-29T14:56:31.801Z",
  "modifiedOn": "2025-08-29T14:56:31.801Z"
}

Get Document File

get

Get document file

Authorizations
Path parameters
documentIdstring · uuidRequired

Unique document identification number in UUID format

Responses
200

OK

application/octet-stream
Responsestring · binary
get
GET /v2/documents/{documentId}/file HTTP/1.1
Host: tvda-api.platform-test.tradevest.ai
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

binary

Sign Document

post

Create new natural person document signature

Authorizations
Header parameters
Requestor-IDstring · uuidRequired

Unique requestor identification in UUID format

Body
partnerDocumentIdstring · uuidRequired

Id of the partner document which was signed

naturalPersonIdstring · uuidRequired

Id of the natural person for which the document is signed

customerIdstring · uuidOptional

Id of the customer in whose context the natural person is active. Required only for TERMS_AND_CONDITIONS document type.

Responses
202

Accepted

post
POST /v2/documents/sign HTTP/1.1
Host: tvda-api.platform-test.tradevest.ai
Authorization: Bearer YOUR_OAUTH2_TOKEN
Requestor-ID: 123e4567-e89b-12d3-a456-426614174000
Content-Type: application/json
Accept: */*
Content-Length: 169

{
  "partnerDocumentId": "123e4567-e89b-12d3-a456-426614174000",
  "naturalPersonId": "123e4567-e89b-12d3-a456-426614174000",
  "customerId": "123e4567-e89b-12d3-a456-426614174000"
}
No content

Last updated