Skip to content

Onboarding

Operations Summary

Method Endpoint Description
GET /api/onboarding/person-identifier-fields/ Person identifier fields
GET /api/onboarding/supported-countries/ Return list of supported countries for validation

Person identifier fields

Return person identifier field specification for a specific validation method. The validation_method parameter should match one of the available methods (e.g., 'ariregister', 'wirtschaftscompass', 'bolagsverket', 'breg').

1
2
3
4
5
http \
  GET \
  https://api.example.com/api/onboarding/person-identifier-fields/ \
  Authorization:"Token YOUR_API_TOKEN" \
  validation_method=="ariregister"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.validation_method_enum import ValidationMethodEnum # (1)
from waldur_api_client.api.onboarding import onboarding_person_identifier_fields_retrieve # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = onboarding_person_identifier_fields_retrieve.sync(
    client=client,
    validation_method=ValidationMethodEnum.ARIREGISTER
)

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

try {
  const response = await onboardingPersonIdentifierFieldsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  query: {
    "validation_method": "ariregister"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required Description
validation_method string ✓ Validation method identifier
Enum: ariregister, wirtschaftscompass, bolagsverket, breg

200 -

Field Type Description
validation_method string The validation method identifier
person_identifier_fields object (free-form) Field specification for person identification. For simple identifiers: {type: 'string', field: 'civil_number', ...}. For composite identifiers: {type: 'object', fields: {...}}

Return list of supported countries for validation

Return list of supported countries for validation.

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

1
2
3
4
5
6
7
8
9
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.onboarding import onboarding_supported_countries_retrieve # (1)

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

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

try {
  const response = await onboardingSupportedCountriesRetrieve({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}

200 -

Field Type
supported_countries array of strings