Customers

Create Customer

post

Assign entity the role of customer.

Authorizations
Header parameters
Requestor-IDstring · uuidRequired

Unique requestor identification in UUID format

Body
entityIdstring · uuidRequired

Identifier of the entity, natural person, joint person or legal entity, who will become a customer.

entityTypestring · enumRequiredPossible values:
labelsstring[] · max: 16Optional

Up to 16 user-defined labels can be provided to allow grouping of customers as per required logic

Responses
200

OK

application/json
post
POST /roles/customers 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: 198

{
  "entityId": "123e4567-e89b-12d3-a456-426614174000",
  "entityType": "NATURAL_PERSON",
  "refAccounts": [
    {
      "bankName": "text",
      "iban": "text",
      "bic": "text",
      "type": "PRIMARY",
      "ownerName": "text"
    }
  ],
  "labels": [
    "text"
  ]
}
{
  "customerId": "123e4567-e89b-12d3-a456-426614174000"
}

Get Customers

get

Get a list of customers.

Authorizations
Query parameters
cursorstringOptional

String value used for pagination

limitinteger · min: 1Required

Maximum number of items to return

Default: 20
entityIdstring · uuidOptional

Entity ID

customerStatusstring · enumOptional

Current customer status

Possible values:
customerTypestring · enumOptional

Customer type

Possible values:
labelsstring[] · max: 16Optional

user-defined labels (elements allow grouping of customers as per required logic) filter; will filter customers that have all of the provided labels

Responses
200

OK

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

{
  "data": [
    {
      "customerId": "123e4567-e89b-12d3-a456-426614174000",
      "customerStatus": "CREATED",
      "signedDocumentsRelatedToCustomer": [
        {
          "partnerDocumentId": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text",
          "documentType": "TERMS_AND_CONDITIONS",
          "version": 1,
          "naturalPersonId": "123e4567-e89b-12d3-a456-426614174000",
          "naturalPersonFullName": "text",
          "createdOn": "2025-08-30T17:55:25.058Z",
          "modifiedOn": "2025-08-30T17:55:25.058Z"
        }
      ],
      "createdOn": "2025-08-30T17:55:25.058Z",
      "modifiedOn": "2025-08-30T17:55:25.058Z",
      "cancellationDate": "2025-08-30T17:55:25.058Z",
      "entityId": "123e4567-e89b-12d3-a456-426614174000",
      "entityType": "NATURAL_PERSON",
      "refAccounts": [
        {
          "bankName": "text",
          "iban": "text",
          "bic": "text",
          "type": "PRIMARY",
          "ownerName": "text"
        }
      ],
      "labels": [
        "text"
      ]
    }
  ],
  "pagination": {
    "cursor": "text",
    "limit": 1
  }
}

Get Customer

get

Get customer

Authorizations
Path parameters
customerIdstring · uuidRequired

Customer ID

Responses
200

OK

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

{
  "customerId": "123e4567-e89b-12d3-a456-426614174000",
  "customerStatus": "CREATED",
  "signedDocumentsRelatedToCustomer": [
    {
      "partnerDocumentId": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "documentType": "TERMS_AND_CONDITIONS",
      "version": 1,
      "naturalPersonId": "123e4567-e89b-12d3-a456-426614174000",
      "naturalPersonFullName": "text",
      "createdOn": "2025-08-30T17:55:25.058Z",
      "modifiedOn": "2025-08-30T17:55:25.058Z"
    }
  ],
  "createdOn": "2025-08-30T17:55:25.058Z",
  "modifiedOn": "2025-08-30T17:55:25.058Z",
  "cancellationDate": "2025-08-30T17:55:25.058Z",
  "entityId": "123e4567-e89b-12d3-a456-426614174000",
  "entityType": "NATURAL_PERSON",
  "refAccounts": [
    {
      "bankName": "text",
      "iban": "text",
      "bic": "text",
      "type": "PRIMARY",
      "ownerName": "text"
    }
  ],
  "labels": [
    "text"
  ]
}

Update Customer

patch

Update customer

Authorizations
Path parameters
customerIdstring · uuidRequired

Customer ID

Header parameters
Requestor-IDstring · uuidRequired

Unique requestor identification in UUID format

Body
labelsstring[] · max: 16Optional

Up to 16 user-defined labels can be provided to allow grouping of customers as per required logic

Responses
202

Accepted

No content
patch
PATCH /roles/customers/{customerId} 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: 118

{
  "labels": [
    "text"
  ],
  "refAccounts": [
    {
      "bankName": "text",
      "iban": "text",
      "bic": "text",
      "type": "PRIMARY",
      "ownerName": "text"
    }
  ]
}
No content

Last updated