Skip to content

Onboarding Country Configs

Operations Summary

Method Endpoint Description
GET /api/onboarding-country-configs/ List Onboarding Country Configs
GET /api/onboarding-country-configs/{uuid}/ Retrieve
POST /api/onboarding-country-configs/ Create
PUT /api/onboarding-country-configs/{uuid}/ Update
PATCH /api/onboarding-country-configs/{uuid}/ Partial Update
DELETE /api/onboarding-country-configs/{uuid}/ Delete

List Onboarding Country Configs

1
2
3
4
http \
  GET \
  https://api.example.com/api/onboarding-country-configs/ \
  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_country_configs import onboarding_country_configs_list # (1)

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

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

try {
  const response = await onboardingCountryConfigsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
country string
is_active boolean
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
url string (uri)
uuid string (uuid)
country string ISO country code (e.g., 'EE' for Estonia)
checklist string (uri) Checklist to use for this country's onboarding
checklist_name string
checklist_uuid string (uuid)
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_options.url string (uri)
questions.question_options.question string (uri)
questions.question_options.question_uuid string (uuid)
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.
questions.url string (uri)
questions.checklist_name string
questions.checklist_uuid string (uuid)
questions.checklist string (uri)
is_active boolean Whether this country configuration is active
created string (date-time)
modified string (date-time)

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/onboarding-country-configs/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_country_configs import onboarding_country_configs_retrieve # (1)

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

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

try {
  const response = await onboardingCountryConfigsRetrieve({
  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
url string (uri)
uuid string (uuid)
country string ISO country code (e.g., 'EE' for Estonia)
checklist string (uri) Checklist to use for this country's onboarding
checklist_name string
checklist_uuid string (uuid)
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_options.url string (uri)
questions.question_options.question string (uri)
questions.question_options.question_uuid string (uuid)
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.
questions.url string (uri)
questions.checklist_name string
questions.checklist_uuid string (uuid)
questions.checklist string (uri)
is_active boolean Whether this country configuration is active
created string (date-time)
modified string (date-time)

Create

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

 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_country_checklist_configuration_request import OnboardingCountryChecklistConfigurationRequest # (1)
from waldur_api_client.api.onboarding_country_configs import onboarding_country_configs_create # (2)

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

body_data = OnboardingCountryChecklistConfigurationRequest(
    country="string-value",
    checklist="https://api.example.com/api/checklist/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = onboarding_country_configs_create.sync(
    client=client,
    body=body_data
)

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

try {
  const response = await onboardingCountryConfigsCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "country": "string-value",
    "checklist": "https://api.example.com/api/checklist/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
country string ✓ ISO country code (e.g., 'EE' for Estonia)
checklist string (uri) ✓ Checklist to use for this country's onboarding
is_active boolean Whether this country configuration is active

201 -

Field Type Description
url string (uri)
uuid string (uuid)
country string ISO country code (e.g., 'EE' for Estonia)
checklist string (uri) Checklist to use for this country's onboarding
checklist_name string
checklist_uuid string (uuid)
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_options.url string (uri)
questions.question_options.question string (uri)
questions.question_options.question_uuid string (uuid)
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.
questions.url string (uri)
questions.checklist_name string
questions.checklist_uuid string (uuid)
questions.checklist string (uri)
is_active boolean Whether this country configuration is active
created string (date-time)
modified string (date-time)

Update

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

 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_country_checklist_configuration_request import OnboardingCountryChecklistConfigurationRequest # (1)
from waldur_api_client.api.onboarding_country_configs import onboarding_country_configs_update # (2)

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

body_data = OnboardingCountryChecklistConfigurationRequest(
    country="string-value",
    checklist="https://api.example.com/api/checklist/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = onboarding_country_configs_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

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

try {
  const response = await onboardingCountryConfigsUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "country": "string-value",
    "checklist": "https://api.example.com/api/checklist/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
country string ✓ ISO country code (e.g., 'EE' for Estonia)
checklist string (uri) ✓ Checklist to use for this country's onboarding
is_active boolean Whether this country configuration is active

200 -

Field Type Description
url string (uri)
uuid string (uuid)
country string ISO country code (e.g., 'EE' for Estonia)
checklist string (uri) Checklist to use for this country's onboarding
checklist_name string
checklist_uuid string (uuid)
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_options.url string (uri)
questions.question_options.question string (uri)
questions.question_options.question_uuid string (uuid)
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.
questions.url string (uri)
questions.checklist_name string
questions.checklist_uuid string (uuid)
questions.checklist string (uri)
is_active boolean Whether this country configuration is active
created string (date-time)
modified string (date-time)

Partial Update

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/onboarding-country-configs/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_country_checklist_configuration_request import PatchedOnboardingCountryChecklistConfigurationRequest # (1)
from waldur_api_client.api.onboarding_country_configs import onboarding_country_configs_partial_update # (2)

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

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

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

try {
  const response = await onboardingCountryConfigsPartialUpdate({
  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
country string ISO country code (e.g., 'EE' for Estonia)
checklist string (uri) Checklist to use for this country's onboarding
is_active boolean Whether this country configuration is active

200 -

Field Type Description
url string (uri)
uuid string (uuid)
country string ISO country code (e.g., 'EE' for Estonia)
checklist string (uri) Checklist to use for this country's onboarding
checklist_name string
checklist_uuid string (uuid)
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_options.url string (uri)
questions.question_options.question string (uri)
questions.question_options.question_uuid string (uuid)
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.
questions.url string (uri)
questions.checklist_name string
questions.checklist_uuid string (uuid)
questions.checklist string (uri)
is_active boolean Whether this country configuration is active
created string (date-time)
modified string (date-time)

Delete

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/onboarding-country-configs/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_country_configs import onboarding_country_configs_destroy # (1)

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

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

try {
  const response = await onboardingCountryConfigsDestroy({
  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