Partner Documents

Get Partner Documents

get

https://tvda-api.platform-test.tradevest.aihttps://tvda-api.platform-pretest.tradevest.ai

/partner-documents

Get partner documents not connected to single customer. For example reports. By default, it returns last 20 documents. It is possible to send query parameters to adjust the result.

Authorizations

Bearer

OAuth2clientCredentialsRequired

Token URL:

Query parameters

documentTypestring · enumOptional

This list may change in the future.

Possible values:

startDatestring · date-timeOptional

Beginning of the range. Document create date time is after this parameter.

endDatestring · date-timeOptional

End of the range. Document create date time is before this parameter.

isValidbooleanOptional

Used to filter active documents.

cursorstringOptional

String value used for pagination

limitinteger · min: 1Required

Maximum number of items to return

Default: 20

Responses

200

OK

application/json

404

Not Found

application/json

get

/partner-documents

HTTPcURLJavaScriptPython

GET /partner-documents?limit=20 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,
      "version": 1,
      "validFrom": "2026-02-19",
      "validUntil": "2026-02-19",
      "name": "text",
      "type": "TERMS_AND_CONDITIONS",
      "description": "text",
      "createdOn": "2026-02-19T21:50:25.250Z",
      "modifiedOn": "2026-02-19T21:50:25.250Z"
    }
  ],
  "pagination": {
    "cursor": "text",
    "limit": 1
  }
}

Get Partner Document

get

https://tvda-api.platform-test.tradevest.aihttps://tvda-api.platform-pretest.tradevest.ai

/partner-documents/{documentId}

Get single partner document for given documentId.

Authorizations

Bearer

OAuth2clientCredentialsRequired

Token URL:

Path parameters

documentIdstring · uuidRequired

Id of document

Responses

200

OK

application/json

documentIdstring · uuidRead-onlyRequired

sizeintegerRead-onlyRequired

file size in kB

versionintegerRead-onlyRequired

document version

validFromstring · dateOptional

validUntilstring · dateOptional

namestring · max: 255Required

typestring · enumRequired

This list may change in the future.

Possible values:

descriptionstring · min: 1 · max: 255Optional

createdOnstring · date-timeRead-onlyRequired

modifiedOnstring · date-timeRead-onlyRequired

404

Not Found

application/json

get

/partner-documents/{documentId}

HTTPcURLJavaScriptPython

GET /partner-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,
  "version": 1,
  "validFrom": "2026-02-19",
  "validUntil": "2026-02-19",
  "name": "text",
  "type": "TERMS_AND_CONDITIONS",
  "description": "text",
  "createdOn": "2026-02-19T21:50:25.250Z",
  "modifiedOn": "2026-02-19T21:50:25.250Z"
}

Download document file

get

https://tvda-api.platform-test.tradevest.aihttps://tvda-api.platform-pretest.tradevest.ai

/partner-documents/{documentId}/file

Download document file for given documentId.

Authorizations

Bearer

OAuth2clientCredentialsRequired

Token URL:

Path parameters

documentIdstring · uuidRequired

Id of document

Responses

200

OK

application/octet-stream

string · binaryOptional

404

Not Found

application/json

get

/partner-documents/{documentId}/file

HTTPcURLJavaScriptPython

GET /partner-documents/{documentId}/file HTTP/1.1
Host: tvda-api.platform-test.tradevest.ai
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*