Identification

Identification for Natural Person

Create Natural Person Identification

post

Create new natural person identification

Authorizations
Path parameters
naturalPersonIdstring · uuidRequired

Natural Person ID

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

post
POST /entities/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-10-14",
  "identificationDocumentType": "ID",
  "documentNumber": "text",
  "documentCountry": "AF",
  "documentIssuer": "text",
  "documentIssueDate": "2025-10-14",
  "documentExpiryDate": "2025-10-14",
  "documentMotherFullName": "text",
  "documentMotherResidenceCity": "text",
  "documentFatherFullName": "text",
  "documentFatherResidenceCity": "text"
}
No content

Create Identification Verification

post

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
post
POST /entities/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"
}

Get Identification Verifications

get

Get Identification Verifications

Authorizations
Query parameters
cursorstringOptional

String value used for pagination

limitinteger · min: 1Required

Maximum number of items to return

Default: 20
Responses
200

OK

application/json
get
GET /entities/identification-verifications?limit=20 HTTP/1.1
Host: tvda-api.platform-test.tradevest.ai
Authorization: Bearer YOUR_OAUTH2_TOKEN
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-10-14T11:28:39.739Z",
      "modifiedOn": "2025-10-14T11:28:39.739Z",
      "status": "RECEIVED"
    }
  ],
  "pagination": {
    "cursor": "text",
    "limit": 1
  }
}

Get Identification Verification

get

Get Identification Verification

Authorizations
Path parameters
identificationVerificationIdstring · uuidRequired

Identification Verification ID

Responses
200

OK

application/json
get
GET /entities/identification-verifications/{identificationVerificationId} HTTP/1.1
Host: tvda-api.platform-test.tradevest.ai
Authorization: Bearer YOUR_OAUTH2_TOKEN
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-10-14T11:28:39.739Z",
  "modifiedOn": "2025-10-14T11:28:39.739Z",
  "status": "RECEIVED"
}

Last updated