Onboarding Wizard

Last updated 10 days ago

Create natural person wizard instance

post

Ready to test

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

Authorizations

Responses

200

application/json

400

Bad Request

application/json

post

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

Ready to test

Get list of natural person wizard instances

Authorizations

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

application/json

400

Bad Request

application/json

get

GET /natural-persons-wizard 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",
        "middleName": "text",
        "maritalStatus": "MARRIED"
      },
      "birthData": {
        "birthDay": "2025-06-16",
        "birthPlace": "text",
        "birthCountry": "AF",
        "nationalities": [
          {
            "countryCode": "AF",
            "nationalIdentifier": "text",
            "nationalIdentifierType": "CONCAT"
          }
        ],
        "language": "da"
      },
      "addressData": {
        "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"
        }
      },
      "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-06-16T12:36:36.151Z",
      "modifiedOn": "2025-06-16T12:36:36.151Z"
    }
  ],
  "pagination": {
    "cursor": "text",
    "limit": 1
  }
}

Get natural person wizard by instance ID

get

Ready to test

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

Authorizations

Path parameters

wizardInstanceIdstring · uuidRequired

Unique wizard instance identification number in UUID format

Responses

200

application/json

400

Bad Request

application/json

404

Not Found

application/json

get

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",
    "middleName": "text",
    "maritalStatus": "MARRIED"
  },
  "birthData": {
    "birthDay": "2025-06-16",
    "birthPlace": "text",
    "birthCountry": "AF",
    "nationalities": [
      {
        "countryCode": "AF",
        "nationalIdentifier": "text",
        "nationalIdentifierType": "CONCAT"
      }
    ],
    "language": "da"
  },
  "addressData": {
    "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"
    }
  },
  "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-06-16T12:36:36.151Z",
  "modifiedOn": "2025-06-16T12:36:36.151Z"
}

Delete natural person wizard instance

delete

Ready to test

Deletes wizard instance with all natural person data.

Authorizations

Path parameters

wizardInstanceIdstring · uuidRequired

Unique wizard instance identification number in UUID format

Responses

200

Wizard instance deleted

400

Bad Request

application/json

404

Not Found

application/json

delete

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

No content

Update natural person wizard instance

patch

Ready to test

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

Path parameters

wizardInstanceIdstring · uuidRequired

Unique wizard instance identification number in UUID format

Body

createNaturalPersonbooleanRequired

externalStatusstring · min: 1Optional

externalIdstring · min: 1Optional

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

Responses

200

application/json

400

Bad Request

application/json

patch

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: 1101

{
  "personalData": {
    "gender": "MALE",
    "title": "PROFESSOR",
    "firstName": "text",
    "lastName": "text",
    "middleName": "text",
    "maritalStatus": "MARRIED"
  },
  "birthData": {
    "birthDay": "2025-06-16",
    "birthPlace": "text",
    "birthCountry": "AF",
    "nationalities": [
      {
        "countryCode": "AF",
        "nationalIdentifier": "text",
        "nationalIdentifierType": "CONCAT"
      }
    ],
    "language": "da"
  },
  "addressData": {
    "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"
    }
  },
  "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"
}