[Deprecated] Onboarding Wizard

Create natural person wizard instance

post

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

/natural-persons-wizard

Creates new onboarding process wizard instance for a natural person. Each natural person data section can be added by using patch endpoint.

Authorizations

Bearer

OAuth2clientCredentialsRequired

Token URL:

Responses

200

OK

application/json

400

Bad Request

application/json

post

/natural-persons-wizard

HTTPcURLJavaScriptPython

POST /natural-persons-wizard HTTP/1.1
Host: tvda-api.platform-test.tradevest.ai
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "wizardInstanceId": "123e4567-e89b-12d3-a456-426614174000"
}

Get natural person wizard instances

get

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

/natural-persons-wizard

Get list of natural person wizard instances

Authorizations

Bearer

OAuth2clientCredentialsRequired

Token URL:

Query parameters

wizardStatusstring · enumOptional

wizard instance status

Possible values:

cursorstringOptional

String value used for pagination

limitinteger · min: 1Required

Maximum number of items to return

Default: 20

Responses

200

OK

application/json

400

Bad Request

application/json

get

/natural-persons-wizard

HTTPcURLJavaScriptPython

GET /natural-persons-wizard?limit=20 HTTP/1.1
Host: tvda-api.platform-test.tradevest.ai
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "openWizardCount": 1,
  "data": [
    {
      "wizardInstanceId": "123e4567-e89b-12d3-a456-426614174000",
      "wizardStatus": "IN_PROGRESS",
      "externalStatus": "text",
      "externalId": "text",
      "personalData": {
        "gender": "MALE",
        "title": "PROFESSOR",
        "firstName": "text",
        "lastName": "text",
        "maritalStatus": "MARRIED"
      },
      "birthData": {
        "birthDay": "2025-12-25",
        "birthPlace": "text",
        "birthCountry": "AF",
        "nationalities": [
          {
            "countryCode": "AF",
            "nationalIdentifier": "text",
            "nationalIdentifierType": "CONCAT"
          }
        ],
        "language": "da"
      },
      "addressData": {
        "mainAddress": {
          "street": "text",
          "streetNumber": "text",
          "city": "text",
          "zip": "text",
          "state": "text",
          "country": "AF",
          "additionalInfo": "text"
        },
        "correspondenceAddress": {
          "street": "text",
          "streetNumber": "text",
          "city": "text",
          "zip": "text",
          "state": "text",
          "country": "AF",
          "additionalInfo": "text"
        }
      },
      "contact": {
        "phone": "text",
        "email": "text",
        "fax": "text",
        "website": "text"
      },
      "taxData": {
        "taxDetails": [
          {
            "taxId": "text",
            "taxResidency": "AF"
          }
        ],
        "isUsNationality": true
      },
      "employmentData": {
        "profession": "text",
        "professionGroup": "EMPLOYED",
        "naceSectors": [
          {
            "section": "text",
            "description": "text"
          }
        ]
      },
      "assetDisclosuresData": {
        "annualIncomeNet": 1,
        "sourceOfIncome": [
          "INCOME_FROM_EMPLOYMENT"
        ],
        "availableAssets": 1,
        "originOfAssets": [
          "NON_EMPLOYED_LABOR"
        ]
      },
      "createdOn": "2025-12-25T10:24:35.093Z",
      "modifiedOn": "2025-12-25T10:24:35.093Z"
    }
  ],
  "pagination": {
    "cursor": "text",
    "limit": 1
  }
}

Get natural person wizard by instance ID

get

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

/natural-persons-wizard/{wizardInstanceId}

Get wizard data (wizard status, wizard instance id, natural person data) for given wizard instance ID

Authorizations

Bearer

OAuth2clientCredentialsRequired

Token URL:

Path parameters

wizardInstanceIdstring · uuidRequired

Unique wizard instance identification number in UUID format

Responses

200

OK

application/json

400

Bad Request

application/json

404

Not Found

application/json

get

/natural-persons-wizard/{wizardInstanceId}

HTTPcURLJavaScriptPython

GET /natural-persons-wizard/{wizardInstanceId} HTTP/1.1
Host: tvda-api.platform-test.tradevest.ai
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "wizardInstanceId": "123e4567-e89b-12d3-a456-426614174000",
  "wizardStatus": "IN_PROGRESS",
  "externalStatus": "text",
  "externalId": "text",
  "personalData": {
    "gender": "MALE",
    "title": "PROFESSOR",
    "firstName": "text",
    "lastName": "text",
    "maritalStatus": "MARRIED"
  },
  "birthData": {
    "birthDay": "2025-12-25",
    "birthPlace": "text",
    "birthCountry": "AF",
    "nationalities": [
      {
        "countryCode": "AF",
        "nationalIdentifier": "text",
        "nationalIdentifierType": "CONCAT"
      }
    ],
    "language": "da"
  },
  "addressData": {
    "mainAddress": {
      "street": "text",
      "streetNumber": "text",
      "city": "text",
      "zip": "text",
      "state": "text",
      "country": "AF",
      "additionalInfo": "text"
    },
    "correspondenceAddress": {
      "street": "text",
      "streetNumber": "text",
      "city": "text",
      "zip": "text",
      "state": "text",
      "country": "AF",
      "additionalInfo": "text"
    }
  },
  "contact": {
    "phone": "text",
    "email": "text",
    "fax": "text",
    "website": "text"
  },
  "taxData": {
    "taxDetails": [
      {
        "taxId": "text",
        "taxResidency": "AF"
      }
    ],
    "isUsNationality": true
  },
  "employmentData": {
    "profession": "text",
    "professionGroup": "EMPLOYED",
    "naceSectors": [
      {
        "section": "text",
        "description": "text"
      }
    ]
  },
  "assetDisclosuresData": {
    "annualIncomeNet": 1,
    "sourceOfIncome": [
      "INCOME_FROM_EMPLOYMENT"
    ],
    "availableAssets": 1,
    "originOfAssets": [
      "NON_EMPLOYED_LABOR"
    ]
  },
  "createdOn": "2025-12-25T10:24:35.093Z",
  "modifiedOn": "2025-12-25T10:24:35.093Z"
}

Update natural person wizard instance

patch

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

/natural-persons-wizard/{wizardInstanceId}

Updates natural person data from wizard. Only opened wizard instances (status other than FULLY_COMPLETED) can be updated. Any number of sections can be send as a request body. Each send section is validated. All send section data overwrites previously send sections data. Flag createNaturalPerson will create natural person from all send sections. It will return error if natural person could not be created.

Authorizations

Bearer

OAuth2clientCredentialsRequired

Token URL:

Path parameters

wizardInstanceIdstring · uuidRequired

Unique wizard instance identification number in UUID format

Body

application/json

createNaturalPersonbooleanRequired

externalStatusstring · min: 1Optional

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

patch

/natural-persons-wizard/{wizardInstanceId}

HTTPcURLJavaScriptPython

PATCH /natural-persons-wizard/{wizardInstanceId} HTTP/1.1
Host: tvda-api.platform-test.tradevest.ai
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1111

{
  "personalData": {
    "gender": "MALE",
    "title": "PROFESSOR",
    "firstName": "text",
    "lastName": "text",
    "maritalStatus": "MARRIED"
  },
  "birthData": {
    "birthDay": "2025-12-25",
    "birthPlace": "text",
    "birthCountry": "AF",
    "nationalities": [
      {
        "countryCode": "AF",
        "nationalIdentifier": "text",
        "nationalIdentifierType": "CONCAT"
      }
    ],
    "language": "da"
  },
  "addressData": {
    "mainAddress": {
      "street": "text",
      "streetNumber": "text",
      "city": "text",
      "zip": "text",
      "state": "text",
      "country": "AF",
      "additionalInfo": "text"
    },
    "correspondenceAddress": {
      "street": "text",
      "streetNumber": "text",
      "city": "text",
      "zip": "text",
      "state": "text",
      "country": "AF",
      "additionalInfo": "text"
    }
  },
  "contact": {
    "phone": "text",
    "email": "text",
    "fax": "text",
    "website": "text"
  },
  "taxData": {
    "taxDetails": [
      {
        "taxId": "text",
        "taxResidency": "AF"
      }
    ],
    "isUsNationality": true
  },
  "employmentData": {
    "profession": "text",
    "professionGroup": "EMPLOYED",
    "naceSectors": [
      {
        "section": "text",
        "description": "text"
      }
    ]
  },
  "assetDisclosuresData": {
    "annualIncomeNet": 1,
    "sourceOfIncome": [
      "INCOME_FROM_EMPLOYMENT"
    ],
    "availableAssets": 1,
    "originOfAssets": [
      "NON_EMPLOYED_LABOR"
    ]
  },
  "createNaturalPerson": true,
  "externalStatus": "text",
  "externalId": "text"
}

{
  "naturalPersonId": "123e4567-e89b-12d3-a456-426614174000"
}

Delete natural person wizard instance

delete

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

/natural-persons-wizard/{wizardInstanceId}

Deletes wizard instance with all natural person data.

Authorizations

Bearer

OAuth2clientCredentialsRequired

Token URL:

Path parameters

wizardInstanceIdstring · uuidRequired

Unique wizard instance identification number in UUID format

Responses

200

Wizard instance deleted

No content

400

Bad Request

application/json

404

Not Found

application/json

delete

/natural-persons-wizard/{wizardInstanceId}

HTTPcURLJavaScriptPython

DELETE /natural-persons-wizard/{wizardInstanceId} HTTP/1.1
Host: tvda-api.platform-test.tradevest.ai
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

No content