Skip to content

Onboarding Verifications

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/onboarding-verifications/ List Onboarding Verifications
GET /api/onboarding-verifications/{uuid}/ Retrieve
POST /api/onboarding-verifications/ Create
POST /api/onboarding-verifications/{uuid}/create_customer/ Create customer from successful verification
PUT /api/onboarding-verifications/{uuid}/ Update
PATCH /api/onboarding-verifications/{uuid}/ Partial Update
DELETE /api/onboarding-verifications/{uuid}/ Delete
Other Actions
GET /api/onboarding-verifications/{uuid}/checklist/ Get checklist with questions and existing answers
GET /api/onboarding-verifications/checklist-template/ Get checklist template for creating new objects
GET /api/onboarding-verifications/{uuid}/completion_status/ Get checklist completion status
POST /api/onboarding-verifications/{uuid}/run_validation/ Run validation
POST /api/onboarding-verifications/start_verification/ Start verification
POST /api/onboarding-verifications/{uuid}/submit_answers/ Submit checklist answers

Core CRUD

List Onboarding Verifications

1
2
3
4
http \
  GET \
  https://api.example.com/api/onboarding-verifications/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.onboarding_verifications import onboarding_verifications_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = onboarding_verifications_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: onboarding_verifications_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { onboardingVerificationsList } from 'waldur-js-client';

try {
  const response = await onboardingVerificationsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
uuid string (uuid)
user integer User requesting company onboarding
country string ISO country code (e.g., 'EE' for Estonia)
legal_person_identifier string Official company registration code (required for automatic validation)
legal_name string Company name(optional, for reference)
status any
validation_method any Method used for validation
verified_user_roles any Roles the user has in the company
verified_company_data any Company information retrieved during validation
raw_response any Raw API response for debugging and auditing
error_traceback string
error_message string
validated_at string (date-time) When validation was completed
expires_at string (date-time) When this verification expires
customer integer Customer created after successful validation
onboarding_metadata object (free-form) Onboarding-specific data like intents, purposes extracted from checklist answers
user_submitted_customer_data object (free-form) Get customer data submitted by the user during onboarding.
created string (date-time)
modified string (date-time)

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/onboarding-verifications/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.onboarding_verifications import onboarding_verifications_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = onboarding_verifications_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: onboarding_verifications_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { onboardingVerificationsRetrieve } from 'waldur-js-client';

try {
  const response = await onboardingVerificationsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
uuid string (uuid)
user integer User requesting company onboarding
country string ISO country code (e.g., 'EE' for Estonia)
legal_person_identifier string Official company registration code (required for automatic validation)
legal_name string Company name(optional, for reference)
status any
validation_method any Method used for validation
verified_user_roles any Roles the user has in the company
verified_company_data any Company information retrieved during validation
raw_response any Raw API response for debugging and auditing
error_traceback string
error_message string
validated_at string (date-time) When validation was completed
expires_at string (date-time) When this verification expires
customer integer Customer created after successful validation
onboarding_metadata object (free-form) Onboarding-specific data like intents, purposes extracted from checklist answers
user_submitted_customer_data object (free-form) Get customer data submitted by the user during onboarding.
created string (date-time)
modified string (date-time)

Create

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/onboarding-verifications/ \
  Authorization:"Token YOUR_API_TOKEN" \
  user=123 \
  country="string-value"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.onboarding_verification_request import OnboardingVerificationRequest # (1)
from waldur_api_client.api.onboarding_verifications import onboarding_verifications_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = OnboardingVerificationRequest(
    user=123,
    country="string-value"
)
response = onboarding_verifications_create.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: OnboardingVerificationRequest
  2. API Source: onboarding_verifications_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
import { onboardingVerificationsCreate } from 'waldur-js-client';

try {
  const response = await onboardingVerificationsCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "user": 123,
    "country": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
user integer ✓ User requesting company onboarding
country string ✓ ISO country code (e.g., 'EE' for Estonia)
legal_person_identifier string Official company registration code (required for automatic validation)
legal_name string Company name(optional, for reference)
expires_at string (date-time) When this verification expires

201 -

Field Type Description
uuid string (uuid)
user integer User requesting company onboarding
country string ISO country code (e.g., 'EE' for Estonia)
legal_person_identifier string Official company registration code (required for automatic validation)
legal_name string Company name(optional, for reference)
status any
validation_method any Method used for validation
verified_user_roles any Roles the user has in the company
verified_company_data any Company information retrieved during validation
raw_response any Raw API response for debugging and auditing
error_traceback string
error_message string
validated_at string (date-time) When validation was completed
expires_at string (date-time) When this verification expires
customer integer Customer created after successful validation
onboarding_metadata object (free-form) Onboarding-specific data like intents, purposes extracted from checklist answers
user_submitted_customer_data object (free-form) Get customer data submitted by the user during onboarding.
created string (date-time)
modified string (date-time)

Create customer from successful verification

Create customer from successful verification.

1
2
3
4
http \
  POST \
  https://api.example.com/api/onboarding-verifications/a1b2c3d4-e5f6-7890-abcd-ef1234567890/create_customer/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.onboarding_verifications import onboarding_verifications_create_customer # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = onboarding_verifications_create_customer.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: onboarding_verifications_create_customer
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { onboardingVerificationsCreateCustomer } from 'waldur-js-client';

try {
  const response = await onboardingVerificationsCreateCustomer({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

201 -

Field Type Description
url string (uri)
uuid string (uuid)
created string (date-time)
organization_groups array of objects
organization_groups.uuid string (uuid)
organization_groups.url string (uri)
organization_groups.name string
organization_groups.parent_uuid string (uuid)
organization_groups.parent_name string
organization_groups.parent string (uri)
organization_groups.customers_count integer
display_name string
projects array of objects
projects.url string (uri)
projects.uuid string (uuid)
projects.name string
projects.image string (uri)
projects.resource_count integer
projects.end_date string (date) The date is inclusive. Once reached, all project resource will be scheduled for termination.
backend_id string Organization identifier in another application.
image string (uri)
blocked boolean
archived boolean
display_billing_info_in_projects boolean
default_tax_percent string (decimal)
accounting_start_date string (date-time)
projects_count integer
users_count integer
sponsor_number integer External ID of the sponsor covering the costs
country_name string
max_service_accounts integer Maximum number of service accounts allowed
project_metadata_checklist string (uuid)
grace_period_days integer Number of extra days after project end date before resources are terminated
name string
slug string
native_name string
abbreviation string
description string
contact_details string
agreement_number string
email string (email)
phone_number string
access_subnets string Enter a comma separated list of IPv4 or IPv6 CIDR addresses from where connection to self-service is allowed.
registration_code string
homepage string (uri)
domain string
vat_code string VAT number
postal string
address string
bank_name string
latitude number (double)
longitude number (double)
bank_account string
country any
notification_emails string Comma-separated list of notification email addresses
payment_profiles array of objects
payment_profiles.uuid string (uuid)
payment_profiles.url string (uri)
payment_profiles.name string
payment_profiles.organization_uuid string (uuid)
payment_profiles.organization string (uri)
payment_profiles.attributes object
payment_profiles.attributes.end_date string
payment_profiles.attributes.agreement_number string
payment_profiles.attributes.contract_sum integer
payment_profiles.payment_type string
Enum: fixed_price, invoices, payment_gw_monthly
payment_profiles.payment_type_display string
payment_profiles.is_active boolean
customer_credit number (double)
customer_unallocated_credit number (double)
is_service_provider boolean
service_provider string (uri)
service_provider_uuid string (uuid)
call_managing_organization_uuid string
billing_price_estimate any

Update

1
2
3
4
5
6
http \
  PUT \
  https://api.example.com/api/onboarding-verifications/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  user=123 \
  country="string-value"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.onboarding_verification_request import OnboardingVerificationRequest # (1)
from waldur_api_client.api.onboarding_verifications import onboarding_verifications_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = OnboardingVerificationRequest(
    user=123,
    country="string-value"
)
response = onboarding_verifications_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: OnboardingVerificationRequest
  2. API Source: onboarding_verifications_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
import { onboardingVerificationsUpdate } from 'waldur-js-client';

try {
  const response = await onboardingVerificationsUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "user": 123,
    "country": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
user integer ✓ User requesting company onboarding
country string ✓ ISO country code (e.g., 'EE' for Estonia)
legal_person_identifier string Official company registration code (required for automatic validation)
legal_name string Company name(optional, for reference)
expires_at string (date-time) When this verification expires

200 -

Field Type Description
uuid string (uuid)
user integer User requesting company onboarding
country string ISO country code (e.g., 'EE' for Estonia)
legal_person_identifier string Official company registration code (required for automatic validation)
legal_name string Company name(optional, for reference)
status any
validation_method any Method used for validation
verified_user_roles any Roles the user has in the company
verified_company_data any Company information retrieved during validation
raw_response any Raw API response for debugging and auditing
error_traceback string
error_message string
validated_at string (date-time) When validation was completed
expires_at string (date-time) When this verification expires
customer integer Customer created after successful validation
onboarding_metadata object (free-form) Onboarding-specific data like intents, purposes extracted from checklist answers
user_submitted_customer_data object (free-form) Get customer data submitted by the user during onboarding.
created string (date-time)
modified string (date-time)

Partial Update

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/onboarding-verifications/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_onboarding_verification_request import PatchedOnboardingVerificationRequest # (1)
from waldur_api_client.api.onboarding_verifications import onboarding_verifications_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedOnboardingVerificationRequest()
response = onboarding_verifications_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedOnboardingVerificationRequest
  2. API Source: onboarding_verifications_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { onboardingVerificationsPartialUpdate } from 'waldur-js-client';

try {
  const response = await onboardingVerificationsPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
user integer User requesting company onboarding
country string ISO country code (e.g., 'EE' for Estonia)
legal_person_identifier string Official company registration code (required for automatic validation)
legal_name string Company name(optional, for reference)
expires_at string (date-time) When this verification expires

200 -

Field Type Description
uuid string (uuid)
user integer User requesting company onboarding
country string ISO country code (e.g., 'EE' for Estonia)
legal_person_identifier string Official company registration code (required for automatic validation)
legal_name string Company name(optional, for reference)
status any
validation_method any Method used for validation
verified_user_roles any Roles the user has in the company
verified_company_data any Company information retrieved during validation
raw_response any Raw API response for debugging and auditing
error_traceback string
error_message string
validated_at string (date-time) When validation was completed
expires_at string (date-time) When this verification expires
customer integer Customer created after successful validation
onboarding_metadata object (free-form) Onboarding-specific data like intents, purposes extracted from checklist answers
user_submitted_customer_data object (free-form) Get customer data submitted by the user during onboarding.
created string (date-time)
modified string (date-time)

Delete

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/onboarding-verifications/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.onboarding_verifications import onboarding_verifications_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = onboarding_verifications_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: onboarding_verifications_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { onboardingVerificationsDestroy } from 'waldur-js-client';

try {
  const response = await onboardingVerificationsDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Other Actions

Get checklist with questions and existing answers

Get checklist with questions and existing answers.

1
2
3
4
http \
  GET \
  https://api.example.com/api/onboarding-verifications/a1b2c3d4-e5f6-7890-abcd-ef1234567890/checklist/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.onboarding_verifications import onboarding_verifications_checklist_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = onboarding_verifications_checklist_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: onboarding_verifications_checklist_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { onboardingVerificationsChecklistRetrieve } from 'waldur-js-client';

try {
  const response = await onboardingVerificationsChecklistRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
checklist object (free-form)
completion object
completion.uuid string (uuid)
completion.is_completed boolean Whether all required questions have been answered
completion.completion_percentage number (double)
completion.unanswered_required_questions array of anys
completion.checklist_name string
completion.checklist_description string
completion.created string (date-time)
completion.modified string (date-time)
questions array of objects
questions.uuid string (uuid)
questions.description string
questions.user_guidance string
questions.question_type any Type of question and expected answer format
questions.required boolean
questions.order integer
questions.existing_answer object (free-form)
questions.question_options array of anys
questions.min_value string (decimal) Minimum value allowed for NUMBER type questions
questions.max_value string (decimal) Maximum value allowed for NUMBER type questions
questions.allowed_file_types any List of allowed file extensions (e.g., ['.pdf', '.doc', '.docx']). If empty, all file types are allowed.
questions.allowed_mime_types any List of allowed MIME types (e.g., ['application/pdf', 'application/msword']). If empty, MIME type validation is not enforced. When both extensions and MIME types are specified, files must match both criteria for security.
questions.max_file_size_mb integer Maximum file size in megabytes. If not set, no size limit is enforced.
questions.max_files_count integer Maximum number of files allowed for MULTIPLE_FILES type questions. If not set, no count limit is enforced.

400 -

404 -

Get checklist template for creating new objects

Get checklist template for creating new objects.

1
2
3
4
5
http \
  GET \
  https://api.example.com/api/onboarding-verifications/checklist-template/ \
  Authorization:"Token YOUR_API_TOKEN" \
  parent_uuid=="a1b2c3d4-e5f6-7890-abcd-ef1234567890"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.onboarding_verifications import onboarding_verifications_checklist_template_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = onboarding_verifications_checklist_template_retrieve.sync(
    client=client,
    parent_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890"
)

print(response)
  1. API Source: onboarding_verifications_checklist_template_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { onboardingVerificationsChecklistTemplateRetrieve } from 'waldur-js-client';

try {
  const response = await onboardingVerificationsChecklistTemplateRetrieve({
  auth: "Token YOUR_API_TOKEN",
  query: {
    "parent_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required Description
parent_uuid string (uuid) ✓ UUID of the parent object (e.g., customer UUID for new projects)

200 -

Field Type Description
checklist object (free-form)
questions array of objects
questions.uuid string (uuid)
questions.required boolean
questions.description string
questions.user_guidance string Additional guidance text visible to users when answering and reviewing
questions.question_options array of objects
questions.question_options.uuid string (uuid)
questions.question_options.label string
questions.question_options.order integer
questions.question_type any Type of question and expected answer format
questions.order integer
questions.min_value string (decimal) Minimum value allowed for NUMBER type questions
questions.max_value string (decimal) Maximum value allowed for NUMBER type questions
questions.allowed_file_types any List of allowed file extensions (e.g., ['.pdf', '.doc', '.docx']). If empty, all file types are allowed.
questions.allowed_mime_types any List of allowed MIME types (e.g., ['application/pdf', 'application/msword']). If empty, MIME type validation is not enforced. When both extensions and MIME types are specified, files must match both criteria for security.
questions.max_file_size_mb integer Maximum file size in megabytes. If not set, no size limit is enforced.
questions.max_files_count integer Maximum number of files allowed for MULTIPLE_FILES type questions. If not set, no count limit is enforced.
questions.operator any
questions.review_answer_value any Answer value that trigger review.
questions.always_requires_review boolean This question always requires review regardless of answer
questions.guidance_answer_value any Answer value that triggers display of user guidance.
questions.guidance_operator any Operator to use when comparing answer with guidance_answer_value
questions.always_show_guidance boolean Show user guidance always, regardless of answer. If False, guidance is conditional on answer matching guidance_answer_value with guidance_operator
questions.dependency_logic_operator any Defines how multiple dependencies are evaluated. AND: All dependencies must be satisfied. OR: At least one dependency must be satisfied.
initial_visible_questions array of objects
initial_visible_questions.uuid string (uuid)
initial_visible_questions.required boolean
initial_visible_questions.description string
initial_visible_questions.user_guidance string Additional guidance text visible to users when answering and reviewing
initial_visible_questions.question_options array of objects
initial_visible_questions.question_options.uuid string (uuid)
initial_visible_questions.question_options.label string
initial_visible_questions.question_options.order integer
initial_visible_questions.question_type any Type of question and expected answer format
initial_visible_questions.order integer
initial_visible_questions.min_value string (decimal) Minimum value allowed for NUMBER type questions
initial_visible_questions.max_value string (decimal) Maximum value allowed for NUMBER type questions
initial_visible_questions.allowed_file_types any List of allowed file extensions (e.g., ['.pdf', '.doc', '.docx']). If empty, all file types are allowed.
initial_visible_questions.allowed_mime_types any List of allowed MIME types (e.g., ['application/pdf', 'application/msword']). If empty, MIME type validation is not enforced. When both extensions and MIME types are specified, files must match both criteria for security.
initial_visible_questions.max_file_size_mb integer Maximum file size in megabytes. If not set, no size limit is enforced.
initial_visible_questions.max_files_count integer Maximum number of files allowed for MULTIPLE_FILES type questions. If not set, no count limit is enforced.
initial_visible_questions.operator any
initial_visible_questions.review_answer_value any Answer value that trigger review.
initial_visible_questions.always_requires_review boolean This question always requires review regardless of answer
initial_visible_questions.guidance_answer_value any Answer value that triggers display of user guidance.
initial_visible_questions.guidance_operator any Operator to use when comparing answer with guidance_answer_value
initial_visible_questions.always_show_guidance boolean Show user guidance always, regardless of answer. If False, guidance is conditional on answer matching guidance_answer_value with guidance_operator
initial_visible_questions.dependency_logic_operator any Defines how multiple dependencies are evaluated. AND: All dependencies must be satisfied. OR: At least one dependency must be satisfied.

400 -

404 -

Get checklist completion status

Get checklist completion status.

1
2
3
4
http \
  GET \
  https://api.example.com/api/onboarding-verifications/a1b2c3d4-e5f6-7890-abcd-ef1234567890/completion_status/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.onboarding_verifications import onboarding_verifications_completion_status_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = onboarding_verifications_completion_status_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: onboarding_verifications_completion_status_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { onboardingVerificationsCompletionStatusRetrieve } from 'waldur-js-client';

try {
  const response = await onboardingVerificationsCompletionStatusRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
uuid string (uuid)
is_completed boolean Whether all required questions have been answered
completion_percentage number (double)
unanswered_required_questions array of anys
checklist_name string
checklist_description string
created string (date-time)
modified string (date-time)

400 -

404 -

Run validation

Run automatic validation using the required fields provided during verification creation. Checklist answers (if any) are only used for supplemental customer/intent data.

1
2
3
4
http \
  POST \
  https://api.example.com/api/onboarding-verifications/a1b2c3d4-e5f6-7890-abcd-ef1234567890/run_validation/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.onboarding_verifications import onboarding_verifications_run_validation # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = onboarding_verifications_run_validation.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: onboarding_verifications_run_validation
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { onboardingVerificationsRunValidation } from 'waldur-js-client';

try {
  const response = await onboardingVerificationsRunValidation({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
uuid string (uuid)
user integer User requesting company onboarding
country string ISO country code (e.g., 'EE' for Estonia)
legal_person_identifier string Official company registration code (required for automatic validation)
legal_name string Company name(optional, for reference)
status any
validation_method any Method used for validation
verified_user_roles any Roles the user has in the company
verified_company_data any Company information retrieved during validation
raw_response any Raw API response for debugging and auditing
error_traceback string
error_message string
validated_at string (date-time) When validation was completed
expires_at string (date-time) When this verification expires
customer integer Customer created after successful validation
onboarding_metadata object (free-form) Onboarding-specific data like intents, purposes extracted from checklist answers
user_submitted_customer_data object (free-form) Get customer data submitted by the user during onboarding.
created string (date-time)
modified string (date-time)

Start verification

Start company validation process by creating a verification record. If a checklist is configured for the country, use checklist endpoints to submit additional answers. Then call run_validation to perform automatic validation.

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/onboarding-verifications/start_verification/ \
  Authorization:"Token YOUR_API_TOKEN" \
  country="string-value"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.onboarding_company_validation_request_request import OnboardingCompanyValidationRequestRequest # (1)
from waldur_api_client.api.onboarding_verifications import onboarding_verifications_start_verification # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = OnboardingCompanyValidationRequestRequest(
    country="string-value"
)
response = onboarding_verifications_start_verification.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: OnboardingCompanyValidationRequestRequest
  2. API Source: onboarding_verifications_start_verification
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { onboardingVerificationsStartVerification } from 'waldur-js-client';

try {
  const response = await onboardingVerificationsStartVerification({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "country": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
country string ✓ ISO country code (e.g., 'EE' for Estonia)
legal_person_identifier string Official company registration code
legal_name string Company name (optional)
is_manual_validation boolean Indicates if the validation is to be performed manually
Constraints: default: False
person_identifier string Personal identifier (temporary workaround for Estonian civil_number)
first_name string User's first name (temporary workaround for Austrian validation)
last_name string User's last name (temporary workaround for Austrian validation)
birth_date string (date) User's birth date (temporary workaround for Austrian validation)

200 -

Field Type Description
uuid string (uuid)
user integer User requesting company onboarding
country string ISO country code (e.g., 'EE' for Estonia)
legal_person_identifier string Official company registration code (required for automatic validation)
legal_name string Company name(optional, for reference)
status any
validation_method any Method used for validation
verified_user_roles any Roles the user has in the company
verified_company_data any Company information retrieved during validation
raw_response any Raw API response for debugging and auditing
error_traceback string
error_message string
validated_at string (date-time) When validation was completed
expires_at string (date-time) When this verification expires
customer integer Customer created after successful validation
onboarding_metadata object (free-form) Onboarding-specific data like intents, purposes extracted from checklist answers
user_submitted_customer_data object (free-form) Get customer data submitted by the user during onboarding.
created string (date-time)
modified string (date-time)

Submit checklist answers

Submit checklist answers.

1
2
3
4
echo '[{"question_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "answer_data": null}]' | http \
  POST \
  https://api.example.com/api/onboarding-verifications/a1b2c3d4-e5f6-7890-abcd-ef1234567890/submit_answers/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.onboarding_verifications import onboarding_verifications_submit_answers # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = onboarding_verifications_submit_answers.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: onboarding_verifications_submit_answers
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
import { onboardingVerificationsSubmitAnswers } from 'waldur-js-client';

try {
  const response = await onboardingVerificationsSubmitAnswers({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: [{"question_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "answer_data": null}]
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

The request body is an array of objects, where each object has the following structure:

Field Type Required
question_uuid string (uuid) ✓
answer_data any ✓

200 -

Field Type Description
detail string
completion object
completion.uuid string (uuid)
completion.is_completed boolean Whether all required questions have been answered
completion.completion_percentage number (double)
completion.unanswered_required_questions array of anys
completion.checklist_name string
completion.checklist_description string
completion.created string (date-time)
completion.modified string (date-time)

400 -

404 -