Partner Documents

Get Partner Documents

get

Ready to test

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
Query parameters
documentTypestring · enumOptional

Type of document. For example TERMS_AND_CONDITIONS.

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.

cursorstringOptional

String value used for pagination

limitinteger · min: 1Required

Maximum number of items to return

Default: 20
Responses
200
OK
application/json
get
GET /partner-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,
      "version": 1,
      "validFrom": "2025-07-11",
      "validUntil": "2025-07-11",
      "name": "text",
      "type": "TERMS_AND_CONDITIONS",
      "description": "text",
      "createdOn": "2025-07-11T18:02:46.822Z",
      "modifiedOn": "2025-07-11T18:02:46.822Z"
    }
  ],
  "pagination": {
    "cursor": "text",
    "limit": 1
  }
}

Get Partner Document

get

Ready to test

Get single partner document for given documentId.

Authorizations
Path parameters
documentIdstring · uuidRequired

Id of document

Responses
200
OK
application/json
get
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": "2025-07-11",
  "validUntil": "2025-07-11",
  "name": "text",
  "type": "TERMS_AND_CONDITIONS",
  "description": "text",
  "createdOn": "2025-07-11T18:02:46.822Z",
  "modifiedOn": "2025-07-11T18:02:46.822Z"
}

Download document file

get

Ready to test

Download document file for given documentId.

Authorizations
Path parameters
documentIdstring · uuidRequired

Id of document

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

No content

Last updated