LogoLogo
  • Home Page
  • Documentation
    • API Overview
    • Partner API Authentication
    • Customer Management
      • Onboarding
    • Partner Webhooks
    • Status Codes for Financial Operations
    • Prices
  • WEBSOCKETS
    • Websocket Prices
      • Prices
      • Schemas
  • API REFERENCE
    • Authorization
      • Schemas
    • User Management
      • Users
      • Schemas
    • Customers
      • General
      • Legal Entities
      • Natural Persons
      • Customer Labels
      • Search Nace Sectors
      • Onboarding Wizard
      • Schemas
    • Documents
      • Documents
      • Schemas
    • Onboardings
      • Onboarding
      • Offboarding
      • Schemas
    • Products
      • Product Definitions & Fees
      • Customer Products
      • Products Changelog
      • Schemas
    • Asset Management
      • Digital assets
        • Create Order
        • General
        • Assets
        • Schemas
    • Transaction History
      • Schemas
    • Transfers
      • Transfers
      • IBAN validator
      • Create Incoming Test Transfer
      • Schemas
    • Partner Documents
      • Schemas
    • Webhooks
      • Schemas
  • PARTNER APIS
    • Partner Webhooks
      • Schemas
Powered by GitBook
On this page
Export as PDF
  1. API REFERENCE
  2. Customers

Natural Persons

Last updated 23 days ago

Get Natural Person

get

Ready to test

Get natural person

Authorizations
Path parameters
naturalPersonIdstring · uuidRequired

Natural Person ID.

Responses
200
OK
application/json
400
Bad Request
application/json
404
Not Found
application/json
get
GET /natural-persons/{naturalPersonId} HTTP/1.1
Host: tvda-api.platform-test.tradevest.ai
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
  "roles": [
    {
      "roleName": "CUSTOMER",
      "roleId": "123e4567-e89b-12d3-a456-426614174000",
      "relatedCustomerId": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "deathDay": "2025-06-13",
  "naturalPersonId": "123e4567-e89b-12d3-a456-426614174000",
  "globalId": "text",
  "createdOn": "2025-06-13T05:43:45.035Z",
  "modifiedOn": "2025-06-13T05:43:45.035Z",
  "verifiedOn": "2025-06-13T05:43:45.035Z",
  "isPep": true,
  "isPepRelated": true,
  "isSanction": true,
  "naturalPersonStatus": "CREATED",
  "naturalPersonIdentifications": [
    {
      "identificationId": "123e4567-e89b-12d3-a456-426614174000",
      "createdOn": "2025-06-13T05:43:45.035Z",
      "modifiedOn": "2025-06-13T05:43:45.035Z",
      "externalVerifier": "WEB_ID",
      "identificationType": "VIDEO_IDENT",
      "identificationDate": "2025-06-13",
      "identificationDocumentType": "ID",
      "documentNumber": "text",
      "documentCountry": "AF",
      "documentIssuer": "text",
      "documentIssueDate": "2025-06-13",
      "documentExpiryDate": "2025-06-13",
      "documentMotherFullName": "text",
      "documentMotherResidenceCity": "text",
      "documentFatherFullName": "text",
      "documentFatherResidenceCity": "text"
    }
  ],
  "naturalPersonSignedDocuments": [
    {
      "partnerDocumentId": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "documentType": "TERMS_AND_CONDITIONS",
      "version": 1,
      "customerId": "123e4567-e89b-12d3-a456-426614174000",
      "createdOn": "2025-06-13T05:43:45.035Z",
      "modifiedOn": "2025-06-13T05:43:45.035Z"
    }
  ],
  "gender": "MALE",
  "title": "PROFESSOR",
  "firstName": "text",
  "lastName": "text",
  "maritalStatus": "MARRIED",
  "birthDay": "2025-06-13",
  "birthPlace": "text",
  "birthCountry": "AF",
  "nationalities": [
    {
      "countryCode": "AF",
      "nationalIdentifier": "text",
      "nationalIdentifierType": "CONCAT"
    }
  ],
  "language": "da",
  "taxDetails": [
    {
      "taxId": "text",
      "taxResidency": "AF"
    }
  ],
  "isUsNationality": true,
  "profession": "text",
  "professionGroup": "EMPLOYED",
  "naceSectors": [
    {
      "section": "text",
      "description": "text"
    }
  ],
  "mainAddress": {
    "street": "text",
    "streetNumber": "text",
    "city": "text",
    "zip": "text",
    "country": "AF",
    "additionalInfo": "text"
  },
  "correspondenceAddress": {
    "street": "text",
    "streetNumber": "text",
    "city": "text",
    "zip": "text",
    "country": "AF",
    "additionalInfo": "text"
  },
  "annualIncomeNet": 1,
  "sourceOfIncome": [
    "INCOME_FROM_EMPLOYMENT"
  ],
  "availableAssets": 1,
  "originOfAssets": [
    "NON_EMPLOYED_LABOR"
  ],
  "contact": {
    "phone": "text",
    "email": "text",
    "fax": "text",
    "website": "text"
  },
  "externalId": "text"
}

Get Identification Verifications

get

Ready to test

Get Identification Verifications

Authorizations
Query parameters
cursorstringOptional

String value used for pagination

limitinteger · min: 1Required

Maximum number of items to return

Default: 20
Header parameters
Requestor-IDstring · uuidRequired

Unique requestor identification in UUID format

Responses
200
OK
application/json
400
Bad Request
application/json
get
GET /identification-verifications HTTP/1.1
Host: tvda-api.platform-test.tradevest.ai
Authorization: Bearer YOUR_OAUTH2_TOKEN
Requestor-ID: 123e4567-e89b-12d3-a456-426614174000
Accept: */*
{
  "data": [
    {
      "naturalPersonId": "123e4567-e89b-12d3-a456-426614174000",
      "identificationVerificationId": "123e4567-e89b-12d3-a456-426614174000",
      "externalVerifier": "WEB_ID",
      "identificationType": "VIDEO_IDENT",
      "identificationUrl": "text",
      "documentId": "123e4567-e89b-12d3-a456-426614174000",
      "naturalPersonIdentificationId": "123e4567-e89b-12d3-a456-426614174000",
      "createdOn": "2025-06-13T05:43:45.035Z",
      "modifiedOn": "2025-06-13T05:43:45.035Z",
      "status": "RECEIVED"
    }
  ],
  "pagination": {
    "cursor": "text",
    "limit": 1
  }
}

Get Identification Verification

get

Ready to test

Get Identification Verification

Authorizations
Path parameters
identificationVerificationIdstring · uuidRequired
Header parameters
Requestor-IDstring · uuidRequired

Unique requestor identification in UUID format

Responses
200
OK
application/json
400
Bad Request
application/json
get
GET /identification-verifications/{identificationVerificationId} HTTP/1.1
Host: tvda-api.platform-test.tradevest.ai
Authorization: Bearer YOUR_OAUTH2_TOKEN
Requestor-ID: 123e4567-e89b-12d3-a456-426614174000
Accept: */*
{
  "naturalPersonId": "123e4567-e89b-12d3-a456-426614174000",
  "identificationVerificationId": "123e4567-e89b-12d3-a456-426614174000",
  "externalVerifier": "WEB_ID",
  "identificationType": "VIDEO_IDENT",
  "identificationUrl": "text",
  "documentId": "123e4567-e89b-12d3-a456-426614174000",
  "naturalPersonIdentificationId": "123e4567-e89b-12d3-a456-426614174000",
  "createdOn": "2025-06-13T05:43:45.035Z",
  "modifiedOn": "2025-06-13T05:43:45.035Z",
  "status": "RECEIVED"
}

Get Natural Person Customer

get

Ready to test

Get natural person type customer

Authorizations
Path parameters
customerIdstring · uuidRequired

Unique customer identification number in UUID format

Responses
200
OK
application/json
400
Bad Request
application/json
404
Not Found
application/json
get
GET /customers/natural-persons/{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",
  "customerType": "NATURAL_PERSON",
  "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-06-13T05:43:45.035Z",
      "modifiedOn": "2025-06-13T05:43:45.035Z"
    }
  ],
  "createdOn": "2025-06-13T05:43:45.035Z",
  "modifiedOn": "2025-06-13T05:43:45.035Z",
  "approvedOn": "2025-06-13T05:43:45.035Z",
  "cancellationDate": "2025-06-13T05:43:45.035Z",
  "naturalPersonId": "123e4567-e89b-12d3-a456-426614174000",
  "labels": [
    "text"
  ],
  "refAccounts": [
    {
      "bankName": "text",
      "iban": "text",
      "bic": "text",
      "type": "PRIMARY",
      "ownerName": "text"
    }
  ],
  "naturalPerson": {
    "deathDay": "2025-06-13",
    "naturalPersonId": "123e4567-e89b-12d3-a456-426614174000",
    "globalId": "text",
    "createdOn": "2025-06-13T05:43:45.035Z",
    "modifiedOn": "2025-06-13T05:43:45.035Z",
    "verifiedOn": "2025-06-13T05:43:45.035Z",
    "isPep": true,
    "isPepRelated": true,
    "isSanction": true,
    "naturalPersonStatus": "CREATED",
    "naturalPersonIdentifications": [
      {
        "identificationId": "123e4567-e89b-12d3-a456-426614174000",
        "createdOn": "2025-06-13T05:43:45.035Z",
        "modifiedOn": "2025-06-13T05:43:45.035Z",
        "externalVerifier": "WEB_ID",
        "identificationType": "VIDEO_IDENT",
        "identificationDate": "2025-06-13",
        "identificationDocumentType": "ID",
        "documentNumber": "text",
        "documentCountry": "AF",
        "documentIssuer": "text",
        "documentIssueDate": "2025-06-13",
        "documentExpiryDate": "2025-06-13",
        "documentMotherFullName": "text",
        "documentMotherResidenceCity": "text",
        "documentFatherFullName": "text",
        "documentFatherResidenceCity": "text"
      }
    ],
    "naturalPersonSignedDocuments": [
      {
        "partnerDocumentId": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "documentType": "TERMS_AND_CONDITIONS",
        "version": 1,
        "customerId": "123e4567-e89b-12d3-a456-426614174000",
        "createdOn": "2025-06-13T05:43:45.035Z",
        "modifiedOn": "2025-06-13T05:43:45.035Z"
      }
    ],
    "gender": "MALE",
    "title": "PROFESSOR",
    "firstName": "text",
    "lastName": "text",
    "maritalStatus": "MARRIED",
    "birthDay": "2025-06-13",
    "birthPlace": "text",
    "birthCountry": "AF",
    "nationalities": [
      {
        "countryCode": "AF",
        "nationalIdentifier": "text",
        "nationalIdentifierType": "CONCAT"
      }
    ],
    "language": "da",
    "taxDetails": [
      {
        "taxId": "text",
        "taxResidency": "AF"
      }
    ],
    "isUsNationality": true,
    "profession": "text",
    "professionGroup": "EMPLOYED",
    "naceSectors": [
      {
        "section": "text",
        "description": "text"
      }
    ],
    "mainAddress": {
      "street": "text",
      "streetNumber": "text",
      "city": "text",
      "zip": "text",
      "country": "AF",
      "additionalInfo": "text"
    },
    "correspondenceAddress": {
      "street": "text",
      "streetNumber": "text",
      "city": "text",
      "zip": "text",
      "country": "AF",
      "additionalInfo": "text"
    },
    "annualIncomeNet": 1,
    "sourceOfIncome": [
      "INCOME_FROM_EMPLOYMENT"
    ],
    "availableAssets": 1,
    "originOfAssets": [
      "NON_EMPLOYED_LABOR"
    ],
    "contact": {
      "phone": "text",
      "email": "text",
      "fax": "text",
      "website": "text"
    },
    "externalId": "text"
  }
}

Get Proxies

get

Get a list of proxies.

Authorizations
Query parameters
cursorstringOptional

String value used for pagination

limitinteger · min: 1Required

Maximum number of items to return

Default: 20
proxyTypeundefined · enumOptional

Proxy type filter

Possible values:
validityTypeundefined · enumOptional

Defines the period of validity of the power of proxy.

Possible values:
proxyStatusundefined · enumOptional

Proxy status Filter

Possible values:
searchTextstringOptional

proxy search text, the search will be performed on the following fields: name of natural person, proxyId, customerId, naturalPersonId

customerIdstring · uuidOptional

Unique customer identification number in UUID format

naturalPersonIdstring · uuidOptional

Unique natural person identification number in UUID format

customerProductIdsstring · uuid[]Optional

IDs of the customers products for which the proxy is allowed to take actions in behalf of the customer (multiple products possible).

Responses
200
OK
application/json
400
Bad Request
application/json
get
GET /proxies HTTP/1.1
Host: tvda-api.platform-test.tradevest.ai
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
  "data": [
    {
      "proxyId": "123e4567-e89b-12d3-a456-426614174000",
      "proxyStatus": "CREATED",
      "createdOn": "2025-06-13T05:43:45.035Z",
      "modifiedOn": "2025-06-13T05:43:45.035Z",
      "proxyType": "GENERAL_POWER_OF_ATTORNEY",
      "naturalPerson": {
        "deathDay": "2025-06-13",
        "naturalPersonId": "123e4567-e89b-12d3-a456-426614174000",
        "globalId": "text",
        "createdOn": "2025-06-13T05:43:45.035Z",
        "modifiedOn": "2025-06-13T05:43:45.035Z",
        "verifiedOn": "2025-06-13T05:43:45.035Z",
        "isPep": true,
        "isPepRelated": true,
        "isSanction": true,
        "naturalPersonStatus": "CREATED",
        "naturalPersonIdentifications": [
          {
            "identificationId": "123e4567-e89b-12d3-a456-426614174000",
            "createdOn": "2025-06-13T05:43:45.035Z",
            "modifiedOn": "2025-06-13T05:43:45.035Z",
            "externalVerifier": "WEB_ID",
            "identificationType": "VIDEO_IDENT",
            "identificationDate": "2025-06-13",
            "identificationDocumentType": "ID",
            "documentNumber": "text",
            "documentCountry": "AF",
            "documentIssuer": "text",
            "documentIssueDate": "2025-06-13",
            "documentExpiryDate": "2025-06-13",
            "documentMotherFullName": "text",
            "documentMotherResidenceCity": "text",
            "documentFatherFullName": "text",
            "documentFatherResidenceCity": "text"
          }
        ],
        "naturalPersonSignedDocuments": [
          {
            "partnerDocumentId": "123e4567-e89b-12d3-a456-426614174000",
            "name": "text",
            "documentType": "TERMS_AND_CONDITIONS",
            "version": 1,
            "customerId": "123e4567-e89b-12d3-a456-426614174000",
            "createdOn": "2025-06-13T05:43:45.035Z",
            "modifiedOn": "2025-06-13T05:43:45.035Z"
          }
        ],
        "gender": "MALE",
        "title": "PROFESSOR",
        "firstName": "text",
        "lastName": "text",
        "maritalStatus": "MARRIED",
        "birthDay": "2025-06-13",
        "birthPlace": "text",
        "birthCountry": "AF",
        "nationalities": [
          {
            "countryCode": "AF",
            "nationalIdentifier": "text",
            "nationalIdentifierType": "CONCAT"
          }
        ],
        "language": "da",
        "taxDetails": [
          {
            "taxId": "text",
            "taxResidency": "AF"
          }
        ],
        "isUsNationality": true,
        "profession": "text",
        "professionGroup": "EMPLOYED",
        "naceSectors": [
          {
            "section": "text",
            "description": "text"
          }
        ],
        "mainAddress": {
          "street": "text",
          "streetNumber": "text",
          "city": "text",
          "zip": "text",
          "country": "AF",
          "additionalInfo": "text"
        },
        "correspondenceAddress": {
          "street": "text",
          "streetNumber": "text",
          "city": "text",
          "zip": "text",
          "country": "AF",
          "additionalInfo": "text"
        },
        "annualIncomeNet": 1,
        "sourceOfIncome": [
          "INCOME_FROM_EMPLOYMENT"
        ],
        "availableAssets": 1,
        "originOfAssets": [
          "NON_EMPLOYED_LABOR"
        ],
        "contact": {
          "phone": "text",
          "email": "text",
          "fax": "text",
          "website": "text"
        },
        "externalId": "text"
      },
      "customerId": "123e4567-e89b-12d3-a456-426614174000",
      "customerProductIds": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "validityType": "UNTIL_CASE_OF_DEATH",
      "scopeType": "INDIVIDUAL",
      "custodyType": "SINGLE_CUSTODY"
    }
  ],
  "pagination": {
    "cursor": "text",
    "limit": 1
  }
}

Get Proxy

get

Ready to test

Get proxy

Authorizations
Path parameters
proxyIdstring · uuidRequired

Unique proxy identification number in UUID format

Responses
200
OK
application/json
400
Bad Request
application/json
404
Not Found
application/json
get
GET /proxies/{proxyId} HTTP/1.1
Host: tvda-api.platform-test.tradevest.ai
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
  "proxyId": "123e4567-e89b-12d3-a456-426614174000",
  "proxyStatus": "CREATED",
  "createdOn": "2025-06-13T05:43:45.035Z",
  "modifiedOn": "2025-06-13T05:43:45.035Z",
  "proxyType": "GENERAL_POWER_OF_ATTORNEY",
  "naturalPerson": {
    "deathDay": "2025-06-13",
    "naturalPersonId": "123e4567-e89b-12d3-a456-426614174000",
    "globalId": "text",
    "createdOn": "2025-06-13T05:43:45.035Z",
    "modifiedOn": "2025-06-13T05:43:45.035Z",
    "verifiedOn": "2025-06-13T05:43:45.035Z",
    "isPep": true,
    "isPepRelated": true,
    "isSanction": true,
    "naturalPersonStatus": "CREATED",
    "naturalPersonIdentifications": [
      {
        "identificationId": "123e4567-e89b-12d3-a456-426614174000",
        "createdOn": "2025-06-13T05:43:45.035Z",
        "modifiedOn": "2025-06-13T05:43:45.035Z",
        "externalVerifier": "WEB_ID",
        "identificationType": "VIDEO_IDENT",
        "identificationDate": "2025-06-13",
        "identificationDocumentType": "ID",
        "documentNumber": "text",
        "documentCountry": "AF",
        "documentIssuer": "text",
        "documentIssueDate": "2025-06-13",
        "documentExpiryDate": "2025-06-13",
        "documentMotherFullName": "text",
        "documentMotherResidenceCity": "text",
        "documentFatherFullName": "text",
        "documentFatherResidenceCity": "text"
      }
    ],
    "naturalPersonSignedDocuments": [
      {
        "partnerDocumentId": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "documentType": "TERMS_AND_CONDITIONS",
        "version": 1,
        "customerId": "123e4567-e89b-12d3-a456-426614174000",
        "createdOn": "2025-06-13T05:43:45.035Z",
        "modifiedOn": "2025-06-13T05:43:45.035Z"
      }
    ],
    "gender": "MALE",
    "title": "PROFESSOR",
    "firstName": "text",
    "lastName": "text",
    "maritalStatus": "MARRIED",
    "birthDay": "2025-06-13",
    "birthPlace": "text",
    "birthCountry": "AF",
    "nationalities": [
      {
        "countryCode": "AF",
        "nationalIdentifier": "text",
        "nationalIdentifierType": "CONCAT"
      }
    ],
    "language": "da",
    "taxDetails": [
      {
        "taxId": "text",
        "taxResidency": "AF"
      }
    ],
    "isUsNationality": true,
    "profession": "text",
    "professionGroup": "EMPLOYED",
    "naceSectors": [
      {
        "section": "text",
        "description": "text"
      }
    ],
    "mainAddress": {
      "street": "text",
      "streetNumber": "text",
      "city": "text",
      "zip": "text",
      "country": "AF",
      "additionalInfo": "text"
    },
    "correspondenceAddress": {
      "street": "text",
      "streetNumber": "text",
      "city": "text",
      "zip": "text",
      "country": "AF",
      "additionalInfo": "text"
    },
    "annualIncomeNet": 1,
    "sourceOfIncome": [
      "INCOME_FROM_EMPLOYMENT"
    ],
    "availableAssets": 1,
    "originOfAssets": [
      "NON_EMPLOYED_LABOR"
    ],
    "contact": {
      "phone": "text",
      "email": "text",
      "fax": "text",
      "website": "text"
    },
    "externalId": "text"
  },
  "customerId": "123e4567-e89b-12d3-a456-426614174000",
  "customerProductIds": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "validityType": "UNTIL_CASE_OF_DEATH",
  "scopeType": "INDIVIDUAL",
  "custodyType": "SINGLE_CUSTODY"
}

Get Joint Person Customer

get

Ready to test

Get joint person type customer

Authorizations
Path parameters
customerIdstring · uuidRequired

Unique customer identification number in UUID format

Responses
200
OK
application/json
400
Bad Request
application/json
404
Not Found
application/json
get
GET /customers/joint-persons/{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",
  "customerType": "NATURAL_PERSON",
  "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-06-13T05:43:45.035Z",
      "modifiedOn": "2025-06-13T05:43:45.035Z"
    }
  ],
  "createdOn": "2025-06-13T05:43:45.035Z",
  "modifiedOn": "2025-06-13T05:43:45.035Z",
  "approvedOn": "2025-06-13T05:43:45.035Z",
  "cancellationDate": "2025-06-13T05:43:45.035Z",
  "mainAddress": {
    "street": "text",
    "streetNumber": "text",
    "city": "text",
    "zip": "text",
    "country": "AF",
    "additionalInfo": "text"
  },
  "correspondenceAddress": {
    "street": "text",
    "streetNumber": "text",
    "city": "text",
    "zip": "text",
    "country": "AF",
    "additionalInfo": "text"
  },
  "annualIncomeNet": 1,
  "sourceOfIncome": [
    "INCOME_FROM_EMPLOYMENT"
  ],
  "availableAssets": 1,
  "originOfAssets": [
    "NON_EMPLOYED_LABOR"
  ],
  "firstNaturalPersonId": "123e4567-e89b-12d3-a456-426614174000",
  "secondNaturalPersonId": "123e4567-e89b-12d3-a456-426614174000",
  "contact": {
    "phone": "text",
    "email": "text",
    "fax": "text",
    "website": "text"
  },
  "refAccounts": [
    {
      "bankName": "text",
      "iban": "text",
      "bic": "text",
      "type": "PRIMARY",
      "ownerName": "text"
    }
  ],
  "globalId": "text",
  "firstNaturalPerson": {
    "deathDay": "2025-06-13",
    "naturalPersonId": "123e4567-e89b-12d3-a456-426614174000",
    "globalId": "text",
    "createdOn": "2025-06-13T05:43:45.035Z",
    "modifiedOn": "2025-06-13T05:43:45.035Z",
    "verifiedOn": "2025-06-13T05:43:45.035Z",
    "isPep": true,
    "isPepRelated": true,
    "isSanction": true,
    "naturalPersonStatus": "CREATED",
    "naturalPersonIdentifications": [
      {
        "identificationId": "123e4567-e89b-12d3-a456-426614174000",
        "createdOn": "2025-06-13T05:43:45.035Z",
        "modifiedOn": "2025-06-13T05:43:45.035Z",
        "externalVerifier": "WEB_ID",
        "identificationType": "VIDEO_IDENT",
        "identificationDate": "2025-06-13",
        "identificationDocumentType": "ID",
        "documentNumber": "text",
        "documentCountry": "AF",
        "documentIssuer": "text",
        "documentIssueDate": "2025-06-13",
        "documentExpiryDate": "2025-06-13",
        "documentMotherFullName": "text",
        "documentMotherResidenceCity": "text",
        "documentFatherFullName": "text",
        "documentFatherResidenceCity": "text"
      }
    ],
    "naturalPersonSignedDocuments": [
      {
        "partnerDocumentId": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "documentType": "TERMS_AND_CONDITIONS",
        "version": 1,
        "customerId": "123e4567-e89b-12d3-a456-426614174000",
        "createdOn": "2025-06-13T05:43:45.035Z",
        "modifiedOn": "2025-06-13T05:43:45.035Z"
      }
    ],
    "gender": "MALE",
    "title": "PROFESSOR",
    "firstName": "text",
    "lastName": "text",
    "maritalStatus": "MARRIED",
    "birthDay": "2025-06-13",
    "birthPlace": "text",
    "birthCountry": "AF",
    "nationalities": [
      {
        "countryCode": "AF",
        "nationalIdentifier": "text",
        "nationalIdentifierType": "CONCAT"
      }
    ],
    "language": "da",
    "taxDetails": [
      {
        "taxId": "text",
        "taxResidency": "AF"
      }
    ],
    "isUsNationality": true,
    "profession": "text",
    "professionGroup": "EMPLOYED",
    "naceSectors": [
      {
        "section": "text",
        "description": "text"
      }
    ],
    "mainAddress": {
      "street": "text",
      "streetNumber": "text",
      "city": "text",
      "zip": "text",
      "country": "AF",
      "additionalInfo": "text"
    },
    "correspondenceAddress": {
      "street": "text",
      "streetNumber": "text",
      "city": "text",
      "zip": "text",
      "country": "AF",
      "additionalInfo": "text"
    },
    "annualIncomeNet": 1,
    "sourceOfIncome": [
      "INCOME_FROM_EMPLOYMENT"
    ],
    "availableAssets": 1,
    "originOfAssets": [
      "NON_EMPLOYED_LABOR"
    ],
    "contact": {
      "phone": "text",
      "email": "text",
      "fax": "text",
      "website": "text"
    },
    "externalId": "text"
  },
  "secondNaturalPerson": {
    "deathDay": "2025-06-13",
    "naturalPersonId": "123e4567-e89b-12d3-a456-426614174000",
    "globalId": "text",
    "createdOn": "2025-06-13T05:43:45.035Z",
    "modifiedOn": "2025-06-13T05:43:45.035Z",
    "verifiedOn": "2025-06-13T05:43:45.035Z",
    "isPep": true,
    "isPepRelated": true,
    "isSanction": true,
    "naturalPersonStatus": "CREATED",
    "naturalPersonIdentifications": [
      {
        "identificationId": "123e4567-e89b-12d3-a456-426614174000",
        "createdOn": "2025-06-13T05:43:45.035Z",
        "modifiedOn": "2025-06-13T05:43:45.035Z",
        "externalVerifier": "WEB_ID",
        "identificationType": "VIDEO_IDENT",
        "identificationDate": "2025-06-13",
        "identificationDocumentType": "ID",
        "documentNumber": "text",
        "documentCountry": "AF",
        "documentIssuer": "text",
        "documentIssueDate": "2025-06-13",
        "documentExpiryDate": "2025-06-13",
        "documentMotherFullName": "text",
        "documentMotherResidenceCity": "text",
        "documentFatherFullName": "text",
        "documentFatherResidenceCity": "text"
      }
    ],
    "naturalPersonSignedDocuments": [
      {
        "partnerDocumentId": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "documentType": "TERMS_AND_CONDITIONS",
        "version": 1,
        "customerId": "123e4567-e89b-12d3-a456-426614174000",
        "createdOn": "2025-06-13T05:43:45.035Z",
        "modifiedOn": "2025-06-13T05:43:45.035Z"
      }
    ],
    "gender": "MALE",
    "title": "PROFESSOR",
    "firstName": "text",
    "lastName": "text",
    "maritalStatus": "MARRIED",
    "birthDay": "2025-06-13",
    "birthPlace": "text",
    "birthCountry": "AF",
    "nationalities": [
      {
        "countryCode": "AF",
        "nationalIdentifier": "text",
        "nationalIdentifierType": "CONCAT"
      }
    ],
    "language": "da",
    "taxDetails": [
      {
        "taxId": "text",
        "taxResidency": "AF"
      }
    ],
    "isUsNationality": true,
    "profession": "text",
    "professionGroup": "EMPLOYED",
    "naceSectors": [
      {
        "section": "text",
        "description": "text"
      }
    ],
    "mainAddress": {
      "street": "text",
      "streetNumber": "text",
      "city": "text",
      "zip": "text",
      "country": "AF",
      "additionalInfo": "text"
    },
    "correspondenceAddress": {
      "street": "text",
      "streetNumber": "text",
      "city": "text",
      "zip": "text",
      "country": "AF",
      "additionalInfo": "text"
    },
    "annualIncomeNet": 1,
    "sourceOfIncome": [
      "INCOME_FROM_EMPLOYMENT"
    ],
    "availableAssets": 1,
    "originOfAssets": [
      "NON_EMPLOYED_LABOR"
    ],
    "contact": {
      "phone": "text",
      "email": "text",
      "fax": "text",
      "website": "text"
    },
    "externalId": "text"
  }
}

Get Beneficial Owners

get

Ready to test

Get beneficial owners of a customer

Authorizations
Path parameters
customerIdstring · uuidRequired

The UUID of the customer for whom the beneficial owner will be designated.

Query parameters
cursorstringOptional

String value used for pagination

limitinteger · min: 1Required

Maximum number of items to return

Default: 20
beneficialOwnerStatusstring · enumOptional

beneficial owner status filter

Possible values:
startDatestring · date-timeOptional

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

endDatestring · date-timeOptional

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

Responses
200
OK
application/json
400
Bad Request
application/json
get
GET /customers/natural-persons/{customerId}/beneficial-owners HTTP/1.1
Host: tvda-api.platform-test.tradevest.ai
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
  "data": [
    {
      "firstName": "text",
      "lastName": "text",
      "birthDay": "2025-06-13",
      "birthPlace": "text",
      "birthCountry": "AF",
      "taxDetails": [
        {
          "taxId": "text",
          "taxResidency": "AF"
        }
      ],
      "isUsNationality": true,
      "mainAddress": {
        "street": "text",
        "streetNumber": "text",
        "city": "text",
        "zip": "text",
        "country": "AF",
        "additionalInfo": "text"
      },
      "nationalities": [
        {
          "countryCode": "AF",
          "nationalIdentifier": "text",
          "nationalIdentifierType": "CONCAT"
        }
      ],
      "boType": "FICTIVE_UBO",
      "uboRelationship": "DIRECTLY_HOLDING_25",
      "share": 1,
      "fatcaControllingPerson": true,
      "deathDay": "2025-06-13",
      "beneficialOwnerId": "123e4567-e89b-12d3-a456-426614174000",
      "globalId": "text",
      "status": "CREATED",
      "isPep": true,
      "isPepRelated": true,
      "isSanction": true,
      "createdOn": "2025-06-13T05:43:45.035Z",
      "modifiedOn": "2025-06-13T05:43:45.035Z",
      "verifiedOn": "2025-06-13T05:43:45.035Z"
    }
  ],
  "pagination": {
    "cursor": "text",
    "limit": 1
  }
}

Get Beneficial Owner

get

Ready to test

Get beneficial owner of a customer

Authorizations
Path parameters
customerIdstring · uuidRequired

The UUID of the customer for whom the beneficial owner will be designated.

beneficialOwnerIdstring · uuidRequired

The UUID of the beneficial owner

Responses
200
OK
application/json
400
Bad Request
application/json
404
Not Found
application/json
get
GET /customers/natural-persons/{customerId}/beneficial-owners/{beneficialOwnerId} HTTP/1.1
Host: tvda-api.platform-test.tradevest.ai
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
  "firstName": "text",
  "lastName": "text",
  "birthDay": "2025-06-13",
  "birthPlace": "text",
  "birthCountry": "AF",
  "taxDetails": [
    {
      "taxId": "text",
      "taxResidency": "AF"
    }
  ],
  "isUsNationality": true,
  "mainAddress": {
    "street": "text",
    "streetNumber": "text",
    "city": "text",
    "zip": "text",
    "country": "AF",
    "additionalInfo": "text"
  },
  "nationalities": [
    {
      "countryCode": "AF",
      "nationalIdentifier": "text",
      "nationalIdentifierType": "CONCAT"
    }
  ],
  "boType": "FICTIVE_UBO",
  "uboRelationship": "DIRECTLY_HOLDING_25",
  "share": 1,
  "fatcaControllingPerson": true,
  "deathDay": "2025-06-13",
  "beneficialOwnerId": "123e4567-e89b-12d3-a456-426614174000",
  "globalId": "text",
  "status": "CREATED",
  "isPep": true,
  "isPepRelated": true,
  "isSanction": true,
  "createdOn": "2025-06-13T05:43:45.035Z",
  "modifiedOn": "2025-06-13T05:43:45.035Z",
  "verifiedOn": "2025-06-13T05:43:45.035Z"
}
  • POSTCreate Natural Person
  • GETGet Natural Persons
  • GETGet Natural Person
  • PATCHUpdate Natural Person
  • POSTCreate Natural Person Identification
  • POSTCreate Identification Verification
  • GETGet Identification Verifications
  • GETGet Identification Verification
  • POSTCreate Natural Person Customer
  • PATCHUpdate Natural Person Customer
  • GETGet Natural Person Customer
  • POSTCreate Proxy
  • GETGet Proxies
  • GETGet Proxy
  • PATCHUpdate Proxy
  • POSTCreate Joint Person Customer
  • PATCHUpdate Joint Person Customer
  • GETGet Joint Person Customer
  • POSTCreate Beneficial Owner
  • GETGet Beneficial Owners
  • GETGet Beneficial Owner
  • PATCHUpdate Beneficial Owner

Get Natural Persons

get

Ready to test

Get natural persons

Authorizations
Query parameters
cursorstringOptional

String value used for pagination

limitinteger · min: 1Required

Maximum number of items to return

Default: 20
naturalPersonStatusstring · enumOptional

Natural person status Filter

Possible values:
roleundefined · enumOptional

Natural person role

Possible values:
Responses
200
OK
application/json
400
Bad Request
application/json
get
GET /natural-persons HTTP/1.1
Host: tvda-api.platform-test.tradevest.ai
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
  "data": [
    {
      "roles": [
        {
          "roleName": "CUSTOMER",
          "roleId": "123e4567-e89b-12d3-a456-426614174000",
          "relatedCustomerId": "123e4567-e89b-12d3-a456-426614174000"
        }
      ],
      "deathDay": "2025-06-13",
      "naturalPersonId": "123e4567-e89b-12d3-a456-426614174000",
      "globalId": "text",
      "createdOn": "2025-06-13T05:43:45.035Z",
      "modifiedOn": "2025-06-13T05:43:45.035Z",
      "verifiedOn": "2025-06-13T05:43:45.035Z",
      "isPep": true,
      "isPepRelated": true,
      "isSanction": true,
      "naturalPersonStatus": "CREATED",
      "naturalPersonIdentifications": [
        {
          "identificationId": "123e4567-e89b-12d3-a456-426614174000",
          "createdOn": "2025-06-13T05:43:45.035Z",
          "modifiedOn": "2025-06-13T05:43:45.035Z",
          "externalVerifier": "WEB_ID",
          "identificationType": "VIDEO_IDENT",
          "identificationDate": "2025-06-13",
          "identificationDocumentType": "ID",
          "documentNumber": "text",
          "documentCountry": "AF",
          "documentIssuer": "text",
          "documentIssueDate": "2025-06-13",
          "documentExpiryDate": "2025-06-13",
          "documentMotherFullName": "text",
          "documentMotherResidenceCity": "text",
          "documentFatherFullName": "text",
          "documentFatherResidenceCity": "text"
        }
      ],
      "naturalPersonSignedDocuments": [
        {
          "partnerDocumentId": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text",
          "documentType": "TERMS_AND_CONDITIONS",
          "version": 1,
          "customerId": "123e4567-e89b-12d3-a456-426614174000",
          "createdOn": "2025-06-13T05:43:45.035Z",
          "modifiedOn": "2025-06-13T05:43:45.035Z"
        }
      ],
      "gender": "MALE",
      "title": "PROFESSOR",
      "firstName": "text",
      "lastName": "text",
      "maritalStatus": "MARRIED",
      "birthDay": "2025-06-13",
      "birthPlace": "text",
      "birthCountry": "AF",
      "nationalities": [
        {
          "countryCode": "AF",
          "nationalIdentifier": "text",
          "nationalIdentifierType": "CONCAT"
        }
      ],
      "language": "da",
      "taxDetails": [
        {
          "taxId": "text",
          "taxResidency": "AF"
        }
      ],
      "isUsNationality": true,
      "profession": "text",
      "professionGroup": "EMPLOYED",
      "naceSectors": [
        {
          "section": "text",
          "description": "text"
        }
      ],
      "mainAddress": {
        "street": "text",
        "streetNumber": "text",
        "city": "text",
        "zip": "text",
        "country": "AF",
        "additionalInfo": "text"
      },
      "correspondenceAddress": {
        "street": "text",
        "streetNumber": "text",
        "city": "text",
        "zip": "text",
        "country": "AF",
        "additionalInfo": "text"
      },
      "annualIncomeNet": 1,
      "sourceOfIncome": [
        "INCOME_FROM_EMPLOYMENT"
      ],
      "availableAssets": 1,
      "originOfAssets": [
        "NON_EMPLOYED_LABOR"
      ],
      "contact": {
        "phone": "text",
        "email": "text",
        "fax": "text",
        "website": "text"
      },
      "externalId": "text"
    }
  ],
  "pagination": {
    "cursor": "text",
    "limit": 1
  }
}

Create Natural Person

post

Create new natural person

Authorizations
Body
genderstring · enumRequired

Gender

Possible values:
titlestring · enumOptionalPossible values:
firstNamestring · min: 1 · max: 255Required

All first names of the person according to the identification document

Pattern: ^\S+( \S+)*$
lastNamestring · min: 1 · max: 255Required

Natural person last name

maritalStatusstring · enumOptionalPossible values:
birthDaystring · dateRequired
birthPlacestring · min: 1 · max: 255Required
birthCountrystring · enumRequired

Country code in ISO 3166-1 alpha-2 standard

Possible values:
languagestring · enumOptional

Language code in ISO 639-1 two-letter codes (EU only)

Possible values:
isUsNationalitybooleanRequired

FATCA - Question whether the customer is subject to US tax liability (nationality or other references due to a green card, registration address, etc.).

professionstring · min: 1 · max: 255Optional
professionGroupstring · enumOptionalPossible values:
annualIncomeNetnumberOptional

Annual income net

availableAssetsnumberOptional

Available assets

externalIdstring · min: 1Optional

External Id in partner's system. This value has to be unique

Responses
200
OK
application/json
400
Bad Request
application/json
409
Conflict
application/json
post
POST /natural-persons HTTP/1.1
Host: tvda-api.platform-test.tradevest.ai
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 927

{
  "gender": "MALE",
  "title": "PROFESSOR",
  "firstName": "text",
  "lastName": "text",
  "maritalStatus": "MARRIED",
  "birthDay": "2025-06-13",
  "birthPlace": "text",
  "birthCountry": "AF",
  "nationalities": [
    {
      "countryCode": "AF",
      "nationalIdentifier": "text",
      "nationalIdentifierType": "CONCAT"
    }
  ],
  "language": "da",
  "taxDetails": [
    {
      "taxId": "text",
      "taxResidency": "AF"
    }
  ],
  "isUsNationality": true,
  "profession": "text",
  "professionGroup": "EMPLOYED",
  "naceSectors": [
    {
      "section": "text",
      "description": "text"
    }
  ],
  "mainAddress": {
    "street": "text",
    "streetNumber": "text",
    "city": "text",
    "zip": "text",
    "country": "AF",
    "additionalInfo": "text"
  },
  "correspondenceAddress": {
    "street": "text",
    "streetNumber": "text",
    "city": "text",
    "zip": "text",
    "country": "AF",
    "additionalInfo": "text"
  },
  "annualIncomeNet": 1,
  "sourceOfIncome": [
    "INCOME_FROM_EMPLOYMENT"
  ],
  "availableAssets": 1,
  "originOfAssets": [
    "NON_EMPLOYED_LABOR"
  ],
  "contact": {
    "phone": "text",
    "email": "text",
    "fax": "text",
    "website": "text"
  },
  "externalId": "text"
}
{
  "naturalPersonId": "123e4567-e89b-12d3-a456-426614174000"
}

Update Natural Person

patch

Ready to test

Update natural person

Authorizations
Path parameters
naturalPersonIdstring · uuidRequired

Natural Person ID.

Header parameters
Requestor-IDstring · uuidRequired

Unique requestor identification in UUID format

Body
documentIdstring · uuidOptional

Document ID in UUID format for those params where a document upload is required (title, lastName, deathDay)

Responses
200
OK
400
Bad Request
application/json
patch
PATCH /natural-persons/{naturalPersonId} 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: 893

{
  "naturalPersonUpdateData": {
    "annualIncomeNet": 1,
    "sourceOfIncome": [
      "INCOME_FROM_EMPLOYMENT"
    ],
    "availableAssets": 1,
    "originOfAssets": [
      "NON_EMPLOYED_LABOR"
    ],
    "contact": {
      "phone": "text",
      "email": "text",
      "fax": "text",
      "website": "text"
    },
    "mainAddress": {
      "street": "text",
      "streetNumber": "text",
      "city": "text",
      "zip": "text",
      "country": "AF",
      "additionalInfo": "text"
    },
    "correspondenceAddress": {
      "street": "text",
      "streetNumber": "text",
      "city": "text",
      "zip": "text",
      "country": "AF",
      "additionalInfo": "text"
    },
    "title": "PROFESSOR",
    "lastName": "text",
    "maritalStatus": "MARRIED",
    "profession": "text",
    "professionGroup": "EMPLOYED",
    "naceSectors": [
      {
        "section": "text",
        "description": "text"
      }
    ],
    "taxDetails": [
      {
        "taxId": "text",
        "taxResidency": "AF"
      }
    ],
    "nationalities": [
      {
        "countryCode": "AF",
        "nationalIdentifier": "text",
        "nationalIdentifierType": "CONCAT"
      }
    ],
    "externalId": "text",
    "deathDay": "2025-06-13"
  },
  "documentId": "123e4567-e89b-12d3-a456-426614174000"
}

No content

Create Natural Person Identification

post

Ready to test

Create new natural person identification

Authorizations
Path parameters
naturalPersonIdstring · uuidRequired
Header parameters
Requestor-IDstring · uuidRequired

Unique requestor identification in UUID format

Body
externalVerifierstring · enumRequired

The legal name of the vendor/company performing the identification for this natural person

Possible values:
identificationTypestring · enumRequired

Method used to identify the customer

Possible values:
identificationDatestring · dateRequired

Date on which the identification was carried out. The date must be within the last 24 months.

identificationDocumentTypestring · enumRequired

Type of the identification document which has been used for identification of the natural person.

Possible values:
documentNumberstring · min: 1 · max: 255Required

Document number of the identification document.

documentCountrystring · enumRequired

Issuing country of the identification document.

Possible values:
documentIssuerstring · min: 1 · max: 255Required

Issuing authority of the identification document

documentIssueDatestring · dateRequired

Issue date of the identification document

documentExpiryDatestring · dateRequired

Expiry date of the identification document. If the identification document is a birth certificate, the date on which the person comes of age must be entered as the expiry date.

documentMotherFullNamestring · min: 1 · max: 255Optional

Full name of the mother, only mandatory for identificationDocumentType = BIRTH_CERTIFICATE

documentMotherResidenceCitystring · min: 1 · max: 255Optional

Residence city of the mother, only mandatory for identificationDocumentType = BIRTH_CERTIFICATE

documentFatherFullNamestring · min: 1 · max: 255Optional

Full name of the father, only mandatory for identificationDocumentType = BIRTH_CERTIFICATE

documentFatherResidenceCitystring · min: 1 · max: 255Optional

Residence city of the father, only mandatory for identificationDocumentType = BIRTH_CERTIFICATE

Responses
202
Accepted
400
Bad Request
application/json
post
POST /natural-persons/{naturalPersonId}/identification 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: 408

{
  "externalVerifier": "WEB_ID",
  "identificationType": "VIDEO_IDENT",
  "identificationDate": "2025-06-13",
  "identificationDocumentType": "ID",
  "documentNumber": "text",
  "documentCountry": "AF",
  "documentIssuer": "text",
  "documentIssueDate": "2025-06-13",
  "documentExpiryDate": "2025-06-13",
  "documentMotherFullName": "text",
  "documentMotherResidenceCity": "text",
  "documentFatherFullName": "text",
  "documentFatherResidenceCity": "text"
}

No content

Create Identification Verification

post

Ready to test

Create Identification Verification

After successful request link to a video call should be retrieved with Get Identification Verification endpoint from identificationUrl field of the response.

Currently only externalVerifier = WEB_ID and identificationType = VIDEO_IDENT is supported.

Authorizations
Header parameters
Requestor-IDstring · uuidRequired

Unique requestor identification in UUID format

Body
naturalPersonIdstring · uuidRequired
externalVerifierstring · enumRequired

The legal name of the vendor/company performing the identification for this natural person

Possible values:
identificationTypestring · enumRequired

Method used to identify the customer

Possible values:
Responses
200
OK
application/json
400
Bad Request
application/json
post
POST /identification-verifications 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: 121

{
  "naturalPersonId": "123e4567-e89b-12d3-a456-426614174000",
  "externalVerifier": "WEB_ID",
  "identificationType": "VIDEO_IDENT"
}
{
  "identificationVerificationId": "123e4567-e89b-12d3-a456-426614174000"
}

Create Natural Person Customer

post

Ready to test

Create new natural person type customer

Authorizations
Header parameters
Requestor-IDstring · uuidRequired

Unique requestor identification in UUID format

Body
naturalPersonIdstring · uuidRequired

Identifier for the associated Natural Person.

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
400
Bad Request
application/json
409
Conflict
application/json
post
POST /customers/natural-persons 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: 175

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

Update Natural Person Customer

patch

Ready to test

Update existing natural person type customer

Authorizations
Path parameters
customerIdstring · uuidRequired

Unique customer identification number in UUID format

Header parameters
Requestor-IDstring · uuidRequired

Unique requestor identification in UUID format

Body
annualIncomeNetnumberOptional

Annual income net

availableAssetsnumberOptional

Available assets

titlestring · enumOptionalPossible values:
lastNamestring · max: 255Optional

Natural person last name

maritalStatusstring · enumOptionalPossible values:
professionstring · min: 1 · max: 255Optional
professionGroupstring · enumOptionalPossible values:
deathDaystring · dateOptional
labelsstring[] · max: 16Optional

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

Responses
202
Accepted
400
Bad Request
application/json
patch
PATCH /customers/natural-persons/{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: 910

{
  "annualIncomeNet": 1,
  "sourceOfIncome": [
    "INCOME_FROM_EMPLOYMENT"
  ],
  "availableAssets": 1,
  "originOfAssets": [
    "NON_EMPLOYED_LABOR"
  ],
  "contact": {
    "phone": "text",
    "email": "text",
    "fax": "text",
    "website": "text"
  },
  "mainAddress": {
    "street": "text",
    "streetNumber": "text",
    "city": "text",
    "zip": "text",
    "country": "AF",
    "additionalInfo": "text"
  },
  "correspondenceAddress": {
    "street": "text",
    "streetNumber": "text",
    "city": "text",
    "zip": "text",
    "country": "AF",
    "additionalInfo": "text"
  },
  "title": "PROFESSOR",
  "lastName": "text",
  "maritalStatus": "MARRIED",
  "profession": "text",
  "professionGroup": "EMPLOYED",
  "naceSectors": [
    {
      "section": "text",
      "description": "text"
    }
  ],
  "taxDetails": [
    {
      "taxId": "text",
      "taxResidency": "AF"
    }
  ],
  "nationalities": [
    {
      "countryCode": "AF",
      "nationalIdentifier": "text",
      "nationalIdentifierType": "CONCAT"
    }
  ],
  "deathDay": "2025-06-13",
  "labels": [
    "text"
  ],
  "refAccounts": [
    {
      "bankName": "text",
      "iban": "text",
      "bic": "text",
      "type": "PRIMARY",
      "ownerName": "text"
    }
  ]
}

No content

Create Proxy

post

Assign natural persons the role of authorized proxy.

Authorizations
Path parameters
naturalPersonIdstring · uuidRequired
Header parameters
Requestor-IDstring · uuidRequired

Unique requestor identification in UUID format

Body
proxyTypeundefined · enumOptionalPossible values:
customerIdstring · uuidRequired

Identifier of the customer, joint person customer or legal entity customer, who will be managed by the proxy.

customerProductIdsstring · uuid[]Optional

IDs of the customers products for which the proxy is allowed to take actions in behalf of the customer (multiple products possible).

validityTypeundefined · enumRequired

Defines the period of validity of the power of proxy.

Possible values:
scopeTypeundefined · enumOptional

Only mandatory for proxyType SIGNATORY
Defines the scope of the power of representation, which is dependent on the underlying signature authorisation of the legal representative:

  • INDIVIDUAL: If soleSignatureAuthorized of the legal representative = YES
  • JOINT: If soleSignatureAuthorized of the legal representative = NO
Possible values:
custodyTypestring · enumOptional

Only mandatory for proxyType GUARDIAN. Specifies the type of custody associated with the guardian.

  • SINGLE_CUSTODY: Indicates that only one guardian holds legal and physical custody of the child.
  • JOINT_CUSTODY: Indicates that the custody of the child is shared between two guardians, typically implying both have legal rights concerning the child's upbringing.
Possible values:
Responses
200
OK
application/json
400
Bad Request
application/json
409
Conflict
application/json
post
POST /natural-persons/{naturalPersonId}/proxy 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: 248

{
  "proxyType": "GENERAL_POWER_OF_ATTORNEY",
  "customerId": "123e4567-e89b-12d3-a456-426614174000",
  "customerProductIds": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "validityType": "UNTIL_CASE_OF_DEATH",
  "scopeType": "INDIVIDUAL",
  "custodyType": "SINGLE_CUSTODY"
}
{
  "proxyId": "123e4567-e89b-12d3-a456-426614174000"
}

Update Proxy

patch

Ready to test

Update proxy

Authorizations
Path parameters
proxyIdstring · uuidRequired

Unique proxy identification number in UUID format

Header parameters
Requestor-IDstring · uuidRequired

Unique requestor identification in UUID format

Body
documentIdstring · uuidOptional

Document ID in UUID format for those params where a document upload is required (scopeType, custodyType)

Responses
200
OK
400
Bad Request
application/json
patch
PATCH /proxies/{proxyId} 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: 228

{
  "proxyUpdateData": {
    "customerProductIds": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "validityType": "UNTIL_CASE_OF_DEATH",
    "scopeType": "INDIVIDUAL",
    "custodyType": "SINGLE_CUSTODY"
  },
  "documentId": "123e4567-e89b-12d3-a456-426614174000"
}

No content

Create Joint Person Customer

post

Ready to test

Create new joint person customer

Authorizations
Header parameters
Requestor-IDstring · uuidRequired

Unique requestor identification in UUID format

Body
annualIncomeNetnumberOptional

Annual income net

availableAssetsnumberOptional

Available assets

firstNaturalPersonIdstring · uuidRequired

Identifier for the first Natural Person

secondNaturalPersonIdstring · uuidRequired

Identifier for the second Natural Person

Responses
200
OK
application/json
400
Bad Request
application/json
409
Conflict
application/json
post
POST /customers/joint-persons 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: 671

{
  "mainAddress": {
    "street": "text",
    "streetNumber": "text",
    "city": "text",
    "zip": "text",
    "country": "AF",
    "additionalInfo": "text"
  },
  "correspondenceAddress": {
    "street": "text",
    "streetNumber": "text",
    "city": "text",
    "zip": "text",
    "country": "AF",
    "additionalInfo": "text"
  },
  "annualIncomeNet": 1,
  "sourceOfIncome": [
    "INCOME_FROM_EMPLOYMENT"
  ],
  "availableAssets": 1,
  "originOfAssets": [
    "NON_EMPLOYED_LABOR"
  ],
  "firstNaturalPersonId": "123e4567-e89b-12d3-a456-426614174000",
  "secondNaturalPersonId": "123e4567-e89b-12d3-a456-426614174000",
  "contact": {
    "phone": "text",
    "email": "text",
    "fax": "text",
    "website": "text"
  },
  "refAccounts": [
    {
      "bankName": "text",
      "iban": "text",
      "bic": "text",
      "type": "PRIMARY",
      "ownerName": "text"
    }
  ]
}
{
  "customerId": "123e4567-e89b-12d3-a456-426614174000"
}

Update Joint Person Customer

patch

Update existing joint person type customer

Authorizations
Path parameters
customerIdstring · uuidRequired

Unique customer identification number in UUID format

Header parameters
Requestor-IDstring · uuidRequired

Unique requestor identification in UUID format

Body
annualIncomeNetnumberOptional

Annual income net

availableAssetsnumberOptional

Available assets

Responses
202
Accepted
400
Bad Request
application/json
patch
PATCH /customers/joint-persons/{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: 546

{
  "annualIncomeNet": 1,
  "sourceOfIncome": [
    "INCOME_FROM_EMPLOYMENT"
  ],
  "availableAssets": 1,
  "originOfAssets": [
    "NON_EMPLOYED_LABOR"
  ],
  "contact": {
    "phone": "text",
    "email": "text",
    "fax": "text",
    "website": "text"
  },
  "mainAddress": {
    "street": "text",
    "streetNumber": "text",
    "city": "text",
    "zip": "text",
    "country": "AF",
    "additionalInfo": "text"
  },
  "correspondenceAddress": {
    "street": "text",
    "streetNumber": "text",
    "city": "text",
    "zip": "text",
    "country": "AF",
    "additionalInfo": "text"
  },
  "refAccounts": [
    {
      "bankName": "text",
      "iban": "text",
      "bic": "text",
      "type": "PRIMARY",
      "ownerName": "text"
    }
  ]
}

No content

Create Beneficial Owner

post

Ready to test

Creates a new beneficial owner

  • Path Parameter:

    • customerId: The ID of the customer to whom the beneficial owner will be assigned.

  • Payload:

    • Details for the new beneficial owner, such as first name, last name, etc.

Upon successful execution, a new beneficial owner will be created and stored, independent of any existing customer records.

Authorizations
Path parameters
customerIdstring · uuidRequired

The UUID of the customer for whom the beneficial owner will be designated.

Header parameters
Requestor-IDstring · uuidRequired

Unique requestor identification in UUID format

Body
firstNamestring · max: 255Required

All first names of the person according to the identification document

Pattern: ^\S+( \S+)*$
lastNamestring · max: 255Required

Natural person last name

birthDaystring · dateRequired
birthPlacestring · max: 255Required

Location

birthCountrystring · enumRequired

Country code in ISO 3166-1 alpha-2 standard

Possible values:
isUsNationalitybooleanRequired

FATCA - Question whether the customer is subject to US tax liability (nationality or other references due to a green card, registration address, etc.).

boTypestring · enumRequired

Indication of the type of beneficial owner:
In the context of legal entity customers:
REAL_UBO_25 = person who holds more than 25% of the company shares
FICTIVE_UBO = Legal Representative, if no person exists who holds more than 25% of the company shares

Possible values:
uboRelationshipstring · enumOptional

Only mandatory if boType = REAL_UBO_25

Possible values:
sharenumber · max: 100Required

Only mandatory if boType = REAL_UBO_25

fatcaControllingPersonbooleanOptional

Indication of whether this person is a controlling person under FATCA.
TRUE = if fatcaClassification = PASSIVE_NFE

Responses
200
OK
application/json
400
Bad Request
application/json
409
Conflict
application/json
post
POST /customers/natural-persons/{customerId}/beneficial-owners 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: 501

{
  "firstName": "text",
  "lastName": "text",
  "birthDay": "2025-06-13",
  "birthPlace": "text",
  "birthCountry": "AF",
  "taxDetails": [
    {
      "taxId": "text",
      "taxResidency": "AF"
    }
  ],
  "isUsNationality": true,
  "mainAddress": {
    "street": "text",
    "streetNumber": "text",
    "city": "text",
    "zip": "text",
    "country": "AF",
    "additionalInfo": "text"
  },
  "nationalities": [
    {
      "countryCode": "AF",
      "nationalIdentifier": "text",
      "nationalIdentifierType": "CONCAT"
    }
  ],
  "boType": "FICTIVE_UBO",
  "uboRelationship": "DIRECTLY_HOLDING_25",
  "share": 1,
  "fatcaControllingPerson": true
}
{
  "beneficialOwnerId": "123e4567-e89b-12d3-a456-426614174000"
}

Update Beneficial Owner

patch

Ready to test

Update existing beneficial owner

Authorizations
Path parameters
customerIdstring · uuidRequired

The UUID of the customer for whom the beneficial owner will be designated.

beneficialOwnerIdstring · uuidRequired

The UUID of the beneficial owner

Header parameters
Requestor-IDstring · uuidRequired

Unique requestor identification in UUID format

Body
firstNamestring · max: 255Optional

All first names of the person according to the identification document

Pattern: ^\S+( \S+)*$
lastNamestring · max: 255Optional

Natural person last name

birthDaystring · dateOptional
birthPlacestring · max: 255Optional

Location

birthCountrystring · enumOptional

Country code in ISO 3166-1 alpha-2 standard

Possible values:
isUsNationalitybooleanOptional

FATCA - Question whether the customer is subject to US tax liability (nationality or other references due to a green card, registration address, etc.).

boTypestring · enumOptional

Indication of the type of beneficial owner:
In the context of legal entity customers:
REAL_UBO_25 = person who holds more than 25% of the company shares
FICTIVE_UBO = Legal Representative, if no person exists who holds more than 25% of the company shares

Possible values:
uboRelationshipstring · enumOptional

Only mandatory if boType = REAL_UBO_25

Possible values:
sharenumber · max: 100Optional
fatcaControllingPersonbooleanOptional

Indication of whether this person is a controlling person under FATCA.
TRUE = if fatcaClassification = PASSIVE_NFE

Responses
202
Accepted
400
Bad Request
application/json
patch
PATCH /customers/natural-persons/{customerId}/beneficial-owners/{beneficialOwnerId} 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: 501

{
  "firstName": "text",
  "lastName": "text",
  "birthDay": "2025-06-13",
  "birthPlace": "text",
  "birthCountry": "AF",
  "taxDetails": [
    {
      "taxId": "text",
      "taxResidency": "AF"
    }
  ],
  "isUsNationality": true,
  "mainAddress": {
    "street": "text",
    "streetNumber": "text",
    "city": "text",
    "zip": "text",
    "country": "AF",
    "additionalInfo": "text"
  },
  "nationalities": [
    {
      "countryCode": "AF",
      "nationalIdentifier": "text",
      "nationalIdentifierType": "CONCAT"
    }
  ],
  "boType": "FICTIVE_UBO",
  "uboRelationship": "DIRECTLY_HOLDING_25",
  "share": 1,
  "fatcaControllingPerson": true
}

No content