Skip to content
Persons
/
/
Create a person

Persons (1.0)

Download OpenAPI description
persons.json
persons.yaml
Languages
Servers
Mock Server

https://docs.solarisgroup.com/_mock/api-reference/onboarding/persons/

Persons

Operations

Create a person

Request

Creates a person resource for a new customer.
The mandatory data points you must provide when creating a person vary based on the country, product and customer segment (e.g., B2C or freelancers). See the onboarding requirements guide for information on the required data points in each use case.
Important:

  • Please collect the customer's tax residence country separately. Do not default to their residence country for their tax country.
  • Don't use any real personal data when testing this endpoint on Sandbox.

Bodyapplication/json

The content of the request.

salutationstring

The person's salutation. Use null to indicate nonbinary (Germany only).

Enum"MR""MS"
Example: "MR"
titlestring

The person's title.

Enum"DR""MAGISTER""PROF""PROF_DR""BOTSCH""DIPL_PAD""DIPL_BETRIEBSW""DIPL_ING""DIPL_KFFR""DIPL_KFM"
Example: "DR"
first_namestring

The person's first name. (Max 50 characters and must not start with any whitespace or include symbols or emojis.)

Example: "Peter"
last_namestring

The person's last name. (Max 50 characters and must not start with any whitespace or include symbols or emojis. When no last name is available, N/A should be used. This will result in empty last_name in all following api calls)

Example: "Mustermann"
addressobject

The person's address.

Example: {"line_1":"Musterstrasse","line_2":"Musterstrasse","postal_code":"10409","city":"Berlin","country":"DE","state":"BE"}
contact_addressobject

The person's contact address.

Example: {"line_1":"Musterstrasse","line_2":"Musterstrasse","postal_code":"10409","city":"Berlin","country":"DE","state":"BE"}
emailstring

The person's email.

Example: "person@example.com"
mobile_numberstring

Person mobile number: spaces, dashes, underscores, forward slashes are are removed. Important: This field is only used to pass the mobile number to our KYC provider IDnow for the Videoident KYC flow. To create and verify a mobile number for your customer, use the dedicated mobile number endpoints.

Example: "49301234567"
birth_namestring

The person's birth name.

Example: "Doe"
birth_datestring

The person's birth date.

Example: "1972-12-24"
birth_citystring

The city in which the person was born (must be a valid city).

Example: "Berlin"
birth_countrystring
Enum"AD""AE""AF""AG""AI""AL""AM""AO""AQ""AR"
Example: "DE"
birth_provincestring

The province in which the person was born (if applicable).

Example: "BE"
birth_post_codestring

The postal code in which the person was born.

Example: "10233"
nationalitystring
Enum"AD""AE""AF""AG""AI""AL""AM""AO""AQ""AR"
Example: "DE"
employment_statusstring

The person's employment status.

Enum"EMPLOYED""UNEMPLOYED""PUBLIC_SECTOR_EMPLOYEE""PROFESSIONAL_SOLDIER""FREELANCER""HOUSEWORK""APPRENTICE""MANAGEMENT""RETIRED""STUDENT"
Example: "FREELANCER"
job_titlestring

The person's job title.

Example: "Head of everything"
tax_informationobject
Example: {"tax_assessment":"SEPARATE","marital_status":"MARRIED"}
fatca_relevantboolean

Indicates whether or not the person is FATCA relevant.

fatca_crs_confirmed_atstring

UTC timestamp from when the person confirmed their FATCA relevance.

Example: "2017-01-01T00:00:00.000Z"
business_purposestring

The purpose of the person's freelance business.

Example: "helping people to find themselves"
industrystring
Enum"BUILDING_INDUSTRY""CHEMICAL_INDUSTRY_COKE_OVEN_MINERAL_OIL""CONSUMER_INSTALMENT_CREDITS""DEBIT_BALANCE_SALARY_ACCOUNT""FARMER_FORESTRY_FISHING_AND_AQUACULTURE""FINANCIAL_INSTITUTIONS_INSURANCE""FINANCIAL_LEASING_COMPANIES""FOOD_INDUSTRY_TOBACCO_PRODUCTS""GASTRONOMY""HEALTH_CARE_VETERIN_A_WELFARE_FIRM_FREELANCE"
Example: "OTHER_SERVICES"
industry_keystring
Enum"ACCOMMODATION""ACTIVITIES_OF_BUSINESS_EMPLOYERS_AND_PROFESSIONAL_MEMBERSHIP_ORGANISATIONS""ACTIVITIES_OF_HEAD_OFFICES""ACTIVITIES_OF_INVESTMENT_STOCK_CORPORATIONS_AND_FUNDS_OF_INVESTMENT_MANAGEMENT_COMPANIES_EXCL_MONEY_MARKET_FUNDS""ADULT_ENTERTAINMENT_AND_ONLINE_DATING_AND_RELATED""ADVERTISING_AND_MARKET_RESEARCH""AIR_TRANSPORT""ARCHITECTURAL_AND_ENGINEERING_ACTIVITIES_TECHNICAL_TESTING_AND_ANALYSIS""BUYING_AND_SELLING_OF_OWN_NON_RESIDENTIAL_REAL_ESTATE""BUYING_AND_SELLING_OF_OWN_RESIDENTIAL_REAL_ESTATE"
Example: "EDUCATION"
terms_conditions_signed_atstring

UTC timestamp from when the person agreed to the Solaris Terms & Conditions.

Example: "2017-01-01T00:00:00.000Z"
own_economic_interest_signed_atstring

UTC timestamp from when the customer confirmed that they act on behalf of their own economic interest.

Example: "2017-01-01T00:00:00.000Z"
expected_monthly_revenue_centsinteger

(For freelancers) The person's expected monthly revenue, in Euro cents.

Example: 20000
vat_numberstring

(For freelancers) The person's VAT number.

Example: "DE123456789"
website_social_mediastring

(For freelancers) The person's business website/social media.

Example: "http://social-network.com/my-company"
business_trading_namestring

(For freelancers) The person's business trading name.

Example: "My Business"
nace_codestring
Enum"I 55.10""I 55.20""I 55.30""I 55.90""I 56.10""I 56.21""I 56.29""I 56.30""J 58.11""J 58.12"
Example: "I 56.30"
business_address_line_1string

(For freelancers) Business address line 1

Example: "StreetStrasse, 42"
business_address_line_2string

(For freelancers) Business address line 2

Example: "4th floor"
business_postal_codestring

(For freelancers) Business postal code

Example: "12345"
business_citystring

(For freelancers) Business city

Example: "Berlin"
business_countrystring
Enum"AD""AE""AF""AG""AI""AL""AM""AO""AQ""AR"
Example: "DE"
data_terms_signed_atstring

The date and time when the person signed the Solaris data processing agreement.

Example: "2017-01-01T00:00:00.000Z"
annual_income_rangestring

The person's annual income range.

Enum"RANGE_1""RANGE_2""RANGE_3""RANGE_4""RANGE_5""RANGE_6""RANGE_7"
Example: "RANGE_1"
branchstring

The Solaris branch under which the person will have an account.

Enum"DE""ES""FR""IT"
Example: "DE"
main_income_sourcestring

The person's main source of income.

Enum"SALARY_INCOME_OR_OWN_BUSINESS""REAL_ESTATE_INCOME""INCOME_FROM_SAVINGS""SALES_OF_ASSETS""FAMILY_INCOME""DONATIONS""INHERITANCE""PENSION""PUBLIC_SUBSIDIES"
Example: "PUBLIC_SUBSIDIES"
purpose_of_account_openingstring

The person's purpose for opening the account.

Enum"SAVINGS""DAILY_EXPENSES""TRAVELLING_AND_RELOCATING""FREELANCER_ACTIVITY""ONLINE_SHOPPING""SALARY_OR_PENSION_ACCREDITATION""TRADING"
Example: "DAILY_EXPENSES"
socioprofessional_categorystring

The person's socio-professional category.

Enum"FARMERS""CRAFTSMEN""MERCHANTS_AND_COMPANY_MANAGERS""MANAGERS_AND_HIGHER_INTELLECTUAL_PROFESSIONS""INTERMEDIATE_PROFESSIONS""EMPLOYEES""WORKERS"
Example: "EMPLOYEES"
work_countrystring
Enum"AD""AE""AF""AG""AI""AL""AM""AO""AQ""AR"
Example: "IT"
work_provincestring

The person's province of work (if applicable).

Example: "VE"
self_declared_as_pepboolean

Indicates whether the person has self-declared their status as a politically exposed person (PEP).

international_operativity_expectationArray of strings

(For freelancers) Regions where the person expects to conduct business.

Items Enum"AFRICA""ASIA""MIDDLE_EAST""NORTH_AMERICA""SOUTH_AMERICA""NATIONAL_ACTIVITY_ONLY"
Example: ["AFRICA","ASIA"]
registration_numberstring

(For freelancers) The person's freelance registration number.

Example: "1234567890"
external_idstring

(Internal use only) The id assigned to the person by an external source.

Example: "abc123"
landlinestring

Person's landline number.

external_business_relationship_start_datestring(date)

Person's external business relationship start date.

Example: "2020-02-02"
application/json
{
  "salutation": "MR",
  "title": "DR",
  "first_name": "Peter",
  "last_name": "Mustermann",
  "address": {
    "line_1": "Musterstrasse",
    "line_2": "Musterstrasse",
    "postal_code": "10409",
    "city": "Berlin",
    "country": "DE",
    "state": "BE"
  },
  "contact_address": {
    "line_1": "Musterstrasse",
    "line_2": "Musterstrasse",
    "postal_code": "10409",
    "city": "Berlin",
    "country": "DE",
    "state": "BE"
  },
  "email": "person@example.com",
  "mobile_number": "49301234567",
  "birth_name": "Doe",
  "birth_date": "1972-12-24",
  "birth_city": "Berlin",
  "birth_country": "DE",
  "birth_province": "BE",
  "birth_post_code": "10233",
  "nationality": "DE",
  "employment_status": "FREELANCER",
  "job_title": "Head of everything",
  "tax_information": {
    "tax_assessment": "SEPARATE",
    "marital_status": "MARRIED"
  },
  "fatca_relevant": false,
  "fatca_crs_confirmed_at": "2017-01-01T00:00:00.000Z",
  "business_purpose": "helping people to find themselves",
  "industry": "OTHER_SERVICES",
  "industry_key": "EDUCATION",
  "terms_conditions_signed_at": "2017-01-01T00:00:00.000Z",
  "own_economic_interest_signed_at": "2017-01-01T00:00:00.000Z",
  "expected_monthly_revenue_cents": 20000,
  "vat_number": "DE123456789",
  "website_social_media": "http://social-network.com/my-company",
  "business_trading_name": "My Business",
  "nace_code": "I 56.30",
  "business_address_line_1": "StreetStrasse, 42",
  "business_address_line_2": "4th floor",
  "business_postal_code": "12345",
  "business_city": "Berlin",
  "business_country": "DE",
  "data_terms_signed_at": "2017-01-01T00:00:00.000Z",
  "annual_income_range": "RANGE_1",
  "branch": "DE",
  "main_income_source": "PUBLIC_SUBSIDIES",
  "purpose_of_account_opening": "DAILY_EXPENSES",
  "socioprofessional_category": "EMPLOYEES",
  "work_country": "IT",
  "work_province": "VE",
  "self_declared_as_pep": false,
  "international_operativity_expectation": [
    "AFRICA",
    "ASIA"
  ],
  "registration_number": "1234567890",
  "external_id": "abc123",
  "external_business_relationship_start_date": "2020-02-02"
}

Responses

Successful result of the operation

Bodyapplication/json
idstring

The unique ID of the person resource created for a customer.

Example: "dc1a6812a14f6cc338cd084208535bcdcper"
salutationstring

The person's salutation. Use null to indicate nonbinary.

Enum"MR""MS"
Example: "MR"
titlestring

The person's title.

Enum"DR""MAGISTER""PROF""PROF_DR""BOTSCH""DIPL_PAD""DIPL_BETRIEBSW""DIPL_ING""DIPL_KFFR""DIPL_KFM"
Example: "DR"
first_namestring

The person's first name.

Example: "Peter"
last_namestring

The person's last name.

Example: "Mustermann"
addressobject

The person's address.

Example: {"line_1":"Musterstrasse","line_2":"Musterstrasse","postal_code":"10409","city":"Berlin","country":"DE","state":"BE"}
contact_addressobject

The person's contact address. Use this field only if they have lived at their current address for less than 2 years.

Example: {"line_1":"Musterstrasse","line_2":"Musterstrasse","postal_code":"10409","city":"Berlin","country":"DE","state":"BE"}
emailstring

The person's email.

Example: "person@example.com"
mobile_numberstring

The person mobile number. Spaces, dashes, underscores, and forward slashes are removed. Important: This field is only used to pass the mobile number to our KYC provider IDnow for the Videoident KYC flow. To create and verify a mobile number for your customer, use the dedicated mobile number endpoints.

Example: "49301234567"
birth_namestring

The person's birth name.

Example: "Doe"
birth_datestring

The person's date of birth.

Example: "1972-12-24"
birth_citystring

The city in which the person was born.

Example: "Berlin"
birth_countrystring
Enum"AD""AE""AF""AG""AI""AL""AM""AO""AQ""AR"
Example: "DE"
nationalitystring

The customer's nationality.

Example: "DE"
employment_statusstring

The customer's employment status.

Enum"EMPLOYED""UNEMPLOYED""PUBLIC_SECTOR_EMPLOYEE""PROFESSIONAL_SOLDIER""FREELANCER""HOUSEWORK""APPRENTICE""MANAGEMENT""RETIRED""STUDENT"
Example: "FREELANCER"
job_titlestring

The person's job title.

Example: "Head of everything"
tax_informationobject
Example: {"tax_assessment":"SEPARATE","marital_status":"MARRIED"}
fatca_relevantboolean

Indicates whether or not the person is FATCA relevant.

fatca_crs_confirmed_atstring

UTC timestamp from when the person confirmed their FATCA relevance.

Example: "2017-01-01T00:00:00.000Z"
business_purposestring

The purpose of the person's freelance business.

Example: "helping people to find themselves"
industrystring
Enum"BUILDING_INDUSTRY""CHEMICAL_INDUSTRY_COKE_OVEN_MINERAL_OIL""CONSUMER_INSTALMENT_CREDITS""DEBIT_BALANCE_SALARY_ACCOUNT""FARMER_FORESTRY_FISHING_AND_AQUACULTURE""FINANCIAL_INSTITUTIONS_INSURANCE""FINANCIAL_LEASING_COMPANIES""FOOD_INDUSTRY_TOBACCO_PRODUCTS""GASTRONOMY""HEALTH_CARE_VETERIN_A_WELFARE_FIRM_FREELANCE"
Example: "OTHER_SERVICES"
industry_keystring
Enum"ACCOMMODATION""ACTIVITIES_OF_BUSINESS_EMPLOYERS_AND_PROFESSIONAL_MEMBERSHIP_ORGANISATIONS""ACTIVITIES_OF_HEAD_OFFICES""ACTIVITIES_OF_INVESTMENT_STOCK_CORPORATIONS_AND_FUNDS_OF_INVESTMENT_MANAGEMENT_COMPANIES_EXCL_MONEY_MARKET_FUNDS""ADULT_ENTERTAINMENT_AND_ONLINE_DATING_AND_RELATED""ADVERTISING_AND_MARKET_RESEARCH""AIR_TRANSPORT""ARCHITECTURAL_AND_ENGINEERING_ACTIVITIES_TECHNICAL_TESTING_AND_ANALYSIS""BUYING_AND_SELLING_OF_OWN_NON_RESIDENTIAL_REAL_ESTATE""BUYING_AND_SELLING_OF_OWN_RESIDENTIAL_REAL_ESTATE"
Example: "EDUCATION"
terms_conditions_signed_atstring

UTC timestamp from when the person agreed to the Solaris Terms & Conditions.

Example: "2017-01-01T00:00:00.000Z"
own_economic_interest_signed_atstring(date-time)

UTC timestamp from when the customer confirmed that they act on behalf of their own economic interest.

Example: "2017-01-01T00:00:00.000Z"
flagged_by_complianceboolean

Indicates whether the person is flagged by compliance and must answer any compliance questions.

expected_monthly_revenue_centsinteger

(For freelancers) The person's expected monthly revenue, in Euro cents.

Example: 20000
vat_numberstring

(For freelancers) The person's VAT number.

Example: "DE123456789"
website_social_mediastring

(For freelancers) The person's business website/social media.

Example: "http://social-network.com/my-company"
business_trading_namestring

(For freelancers) The person's business trading name.

Example: "My Business"
nace_codestring
Enum"I 55.10""I 55.20""I 55.30""I 55.90""I 56.10""I 56.21""I 56.29""I 56.30""J 58.11""J 58.12"
Example: "I 56.30"
business_address_line_1string

(For freelancers) Business address line 1

Example: "StreetStrasse, 42"
business_address_line_2string

(For freelancers) Business address line 2

Example: "4th floor"
business_postal_codestring

(For freelancers) Business postal code

Example: "12345"
business_citystring

(For freelancers) Business city

Example: "Berlin"
business_countrystring
Enum"AD""AE""AF""AG""AI""AL""AM""AO""AQ""AR"
Example: "DE"
screening_progressstring

The status of the person screening process.

Enum"NOT_SCREENED""POTENTIAL_MATCH""SCREENED_ACCEPTED""SCREENED_DECLINED"
Example: "SCREENED_ACCEPTED"
annual_income_rangestring

The person's annual income range.

Enum"RANGE_1""RANGE_2""RANGE_3""RANGE_4""RANGE_5""RANGE_6""RANGE_7"
Example: "RANGE_1"
data_terms_signed_atstring(date-time)

UTC timestamp from when the customer signed Solaris' data processing agreement.

Example: "2017-01-01T00:00:00.000Z"
aml_follow_up_datestring(date)

The follow-up date for the anti-money laundering department.

Example: "2017-01-15"
aml_confirmed_onstring(date)

The confirmation date of the anti-money laundering department.

Example: "2017-01-30"
self_declared_as_pepboolean

Indicates whether the person has self-declared their status as a politically exposed person (PEP).

international_operativity_expectationArray of strings

(For freelancers) Regions where the person expects to conduct business.

Items Enum"AFRICA""ASIA""MIDDLE_EAST""NORTH_AMERICA""SOUTH_AMERICA""NATIONAL_ACTIVITY_ONLY"
Example: ["AFRICA","ASIA"]
registration_numberstring

(For freelancers) The person's freelance registration number.

Example: "1234567890"
risk_classification_statusstring

The status of the person's risk classification.

Enum"NOT_SCORED""POTENTIAL_RISK""NORMAL_RISK""INFORMATION_REQUESTED""INFORMATION_RECEIVED""RISK_ACCEPTED""RISK_REJECTED""CUSTOMER_UNRESPONSIVE""SCORING_NOT_REQUIRED"
Example: "NORMAL_RISK"
customer_vetting_statusstring

The status of the person's vetting process.

Enum"NOT_VETTED""NO_MATCH""POTENTIAL_MATCH""INFORMATION_REQUESTED""INFORMATION_RECEIVED""RISK_ACCEPTED""RISK_REJECTED""CUSTOMER_UNRESPONSIVE""VETTING_NOT_REQUIRED"
Example: "NO_MATCH"
legitimation_valid_untilstring(date)

Date when the legitimation data becomes invalid.

Example: "2025-12-31"
Response
application/json
{
  "id": "dc1a6812a14f6cc338cd084208535bcdcper",
  "salutation": "MR",
  "title": "DR",
  "first_name": "Peter",
  "last_name": "Mustermann",
  "address": {
    "line_1": "Musterstrasse",
    "line_2": "Musterstrasse",
    "postal_code": "10409",
    "city": "Berlin",
    "country": "DE",
    "state": "BE"
  },
  "contact_address": {
    "line_1": "Musterstrasse",
    "line_2": "Musterstrasse",
    "postal_code": "10409",
    "city": "Berlin",
    "country": "DE",
    "state": "BE"
  },
  "email": "person@example.com",
  "mobile_number": "49301234567",
  "birth_name": "Doe",
  "birth_date": "1972-12-24",
  "birth_city": "Berlin",
  "birth_country": "DE",
  "birth_province": "BE",
  "birth_post_code": "10233",
  "nationality": "DE",
  "employment_status": "FREELANCER",
  "job_title": "Head of everything",
  "tax_information": {
    "tax_assessment": "SEPARATE",
    "marital_status": "MARRIED"
  },
  "fatca_relevant": false,
  "fatca_crs_confirmed_at": "2017-01-01T00:00:00.000Z",
  "business_purpose": "helping people to find themselves",
  "industry": "OTHER_SERVICES",
  "industry_key": "EDUCATION",
  "terms_conditions_signed_at": "2017-01-01T00:00:00.000Z",
  "own_economic_interest_signed_at": "2017-01-01T00:00:00.000Z",
  "expected_monthly_revenue_cents": 20000,
  "vat_number": "DE123456789",
  "website_social_media": "http://social-network.com/my-company",
  "business_trading_name": "My Business",
  "nace_code": "I 56.30",
  "business_address_line_1": "StreetStrasse, 42",
  "business_address_line_2": "4th floor",
  "business_postal_code": "12345",
  "business_city": "Berlin",
  "business_country": "DE",
  "data_terms_signed_at": "2017-01-01T00:00:00.000Z",
  "annual_income_range": "RANGE_1",
  "branch": "DE",
  "main_income_source": "PUBLIC_SUBSIDIES",
  "purpose_of_account_opening": "DAILY_EXPENSES",
  "socioprofessional_category": "EMPLOYEES",
  "work_country": "IT",
  "work_province": "VE",
  "self_declared_as_pep": false,
  "international_operativity_expectation": [
    "AFRICA",
    "ASIA"
  ],
  "registration_number": "1234567890",
  "flagged_by_compliance": false,
  "screening_progress": "SCREENED_ACCEPTED",
  "aml_follow_up_date": "2017-01-15",
  "aml_confirmed_on": "2017-01-30",
  "risk_classification_status": "NORMAL_RISK",
  "customer_vetting_status": "NO_MATCH",
  "legitimation_valid_until": "2025-12-31"
}

Index persons

Request

Returns an array containing all the persons you have created.

Query
page[number]string

The number of results pages to return.

page[size]string

The size of each page in the response.

sortstring
filter[first_name]string

Filter the results by first name.

filter[last_name]string

Filter the results by last name.

filter[birth_date]string

Filter the results by birth date.

filter[birth_date][min]string

Filter the results by birth date starting from a given date.

filter[birth_date][max]string

Filter the results by birth date up until a given date.

No request payload

Responses

Successful result of the operation

Bodyapplication/jsonArray [
idstring

The unique ID of the person resource created for a customer.

Example: "dc1a6812a14f6cc338cd084208535bcdcper"
salutationstring

The person's salutation. Use null to indicate nonbinary.

Enum"MR""MS"
Example: "MR"
titlestring

The person's title.

Enum"DR""MAGISTER""PROF""PROF_DR""BOTSCH""DIPL_PAD""DIPL_BETRIEBSW""DIPL_ING""DIPL_KFFR""DIPL_KFM"
Example: "DR"
first_namestring

The person's first name.

Example: "Peter"
last_namestring

The person's last name.

Example: "Mustermann"
addressobject

The person's address.

Example: {"line_1":"Musterstrasse","line_2":"Musterstrasse","postal_code":"10409","city":"Berlin","country":"DE","state":"BE"}
contact_addressobject

The person's contact address. Use this field only if they have lived at their current address for less than 2 years.

Example: {"line_1":"Musterstrasse","line_2":"Musterstrasse","postal_code":"10409","city":"Berlin","country":"DE","state":"BE"}
emailstring

The person's email.

Example: "person@example.com"
mobile_numberstring

The person mobile number. Spaces, dashes, underscores, and forward slashes are removed. Important: This field is only used to pass the mobile number to our KYC provider IDnow for the Videoident KYC flow. To create and verify a mobile number for your customer, use the dedicated mobile number endpoints.

Example: "49301234567"
birth_namestring

The person's birth name.

Example: "Doe"
birth_datestring

The person's date of birth.

Example: "1972-12-24"
birth_citystring

The city in which the person was born.

Example: "Berlin"
birth_countrystring
Enum"AD""AE""AF""AG""AI""AL""AM""AO""AQ""AR"
Example: "DE"
nationalitystring

The customer's nationality.

Example: "DE"
employment_statusstring

The customer's employment status.

Enum"EMPLOYED""UNEMPLOYED""PUBLIC_SECTOR_EMPLOYEE""PROFESSIONAL_SOLDIER""FREELANCER""HOUSEWORK""APPRENTICE""MANAGEMENT""RETIRED""STUDENT"
Example: "FREELANCER"
job_titlestring

The person's job title.

Example: "Head of everything"
tax_informationobject
Example: {"tax_assessment":"SEPARATE","marital_status":"MARRIED"}
fatca_relevantboolean

Indicates whether or not the person is FATCA relevant.

fatca_crs_confirmed_atstring

UTC timestamp from when the person confirmed their FATCA relevance.

Example: "2017-01-01T00:00:00.000Z"
business_purposestring

The purpose of the person's freelance business.

Example: "helping people to find themselves"
industrystring
Enum"BUILDING_INDUSTRY""CHEMICAL_INDUSTRY_COKE_OVEN_MINERAL_OIL""CONSUMER_INSTALMENT_CREDITS""DEBIT_BALANCE_SALARY_ACCOUNT""FARMER_FORESTRY_FISHING_AND_AQUACULTURE""FINANCIAL_INSTITUTIONS_INSURANCE""FINANCIAL_LEASING_COMPANIES""FOOD_INDUSTRY_TOBACCO_PRODUCTS""GASTRONOMY""HEALTH_CARE_VETERIN_A_WELFARE_FIRM_FREELANCE"
Example: "OTHER_SERVICES"
industry_keystring
Enum"ACCOMMODATION""ACTIVITIES_OF_BUSINESS_EMPLOYERS_AND_PROFESSIONAL_MEMBERSHIP_ORGANISATIONS""ACTIVITIES_OF_HEAD_OFFICES""ACTIVITIES_OF_INVESTMENT_STOCK_CORPORATIONS_AND_FUNDS_OF_INVESTMENT_MANAGEMENT_COMPANIES_EXCL_MONEY_MARKET_FUNDS""ADULT_ENTERTAINMENT_AND_ONLINE_DATING_AND_RELATED""ADVERTISING_AND_MARKET_RESEARCH""AIR_TRANSPORT""ARCHITECTURAL_AND_ENGINEERING_ACTIVITIES_TECHNICAL_TESTING_AND_ANALYSIS""BUYING_AND_SELLING_OF_OWN_NON_RESIDENTIAL_REAL_ESTATE""BUYING_AND_SELLING_OF_OWN_RESIDENTIAL_REAL_ESTATE"
Example: "EDUCATION"
terms_conditions_signed_atstring

UTC timestamp from when the person agreed to the Solaris Terms & Conditions.

Example: "2017-01-01T00:00:00.000Z"
own_economic_interest_signed_atstring(date-time)

UTC timestamp from when the customer confirmed that they act on behalf of their own economic interest.

Example: "2017-01-01T00:00:00.000Z"
flagged_by_complianceboolean

Indicates whether the person is flagged by compliance and must answer any compliance questions.

expected_monthly_revenue_centsinteger

(For freelancers) The person's expected monthly revenue, in Euro cents.

Example: 20000
vat_numberstring

(For freelancers) The person's VAT number.

Example: "DE123456789"
website_social_mediastring

(For freelancers) The person's business website/social media.

Example: "http://social-network.com/my-company"
business_trading_namestring

(For freelancers) The person's business trading name.

Example: "My Business"
nace_codestring
Enum"I 55.10""I 55.20""I 55.30""I 55.90""I 56.10""I 56.21""I 56.29""I 56.30""J 58.11""J 58.12"
Example: "I 56.30"
business_address_line_1string

(For freelancers) Business address line 1

Example: "StreetStrasse, 42"
business_address_line_2string

(For freelancers) Business address line 2

Example: "4th floor"
business_postal_codestring

(For freelancers) Business postal code

Example: "12345"
business_citystring

(For freelancers) Business city

Example: "Berlin"
business_countrystring
Enum"AD""AE""AF""AG""AI""AL""AM""AO""AQ""AR"
Example: "DE"
screening_progressstring

The status of the person screening process.

Enum"NOT_SCREENED""POTENTIAL_MATCH""SCREENED_ACCEPTED""SCREENED_DECLINED"
Example: "SCREENED_ACCEPTED"
annual_income_rangestring

The person's annual income range.

Enum"RANGE_1""RANGE_2""RANGE_3""RANGE_4""RANGE_5""RANGE_6""RANGE_7"
Example: "RANGE_1"
data_terms_signed_atstring(date-time)

UTC timestamp from when the customer signed Solaris' data processing agreement.

Example: "2017-01-01T00:00:00.000Z"
aml_follow_up_datestring(date)

The follow-up date for the anti-money laundering department.

Example: "2017-01-15"
aml_confirmed_onstring(date)

The confirmation date of the anti-money laundering department.

Example: "2017-01-30"
self_declared_as_pepboolean

Indicates whether the person has self-declared their status as a politically exposed person (PEP).

international_operativity_expectationArray of strings

(For freelancers) Regions where the person expects to conduct business.

Items Enum"AFRICA""ASIA""MIDDLE_EAST""NORTH_AMERICA""SOUTH_AMERICA""NATIONAL_ACTIVITY_ONLY"
Example: ["AFRICA","ASIA"]
registration_numberstring

(For freelancers) The person's freelance registration number.

Example: "1234567890"
risk_classification_statusstring

The status of the person's risk classification.

Enum"NOT_SCORED""POTENTIAL_RISK""NORMAL_RISK""INFORMATION_REQUESTED""INFORMATION_RECEIVED""RISK_ACCEPTED""RISK_REJECTED""CUSTOMER_UNRESPONSIVE""SCORING_NOT_REQUIRED"
Example: "NORMAL_RISK"
customer_vetting_statusstring

The status of the person's vetting process.

Enum"NOT_VETTED""NO_MATCH""POTENTIAL_MATCH""INFORMATION_REQUESTED""INFORMATION_RECEIVED""RISK_ACCEPTED""RISK_REJECTED""CUSTOMER_UNRESPONSIVE""VETTING_NOT_REQUIRED"
Example: "NO_MATCH"
legitimation_valid_untilstring(date)

Date when the legitimation data becomes invalid.

Example: "2025-12-31"
]
Response
application/json
[
  {
    "id": "dc1a6812a14f6cc338cd084208535bcdcper",
    "salutation": "MR",
    "title": "DR",
    "first_name": "Peter",
    "last_name": "Mustermann",
    "address": { … },
    "contact_address": { … },
    "email": "person@example.com",
    "mobile_number": "49301234567",
    "birth_name": "Doe",
    "birth_date": "1972-12-24",
    "birth_city": "Berlin",
    "birth_country": "DE",
    "birth_province": "BE",
    "birth_post_code": "10233",
    "nationality": "DE",
    "employment_status": "FREELANCER",
    "job_title": "Head of everything",
    "tax_information": { … },
    "fatca_relevant": false,
    "fatca_crs_confirmed_at": "2017-01-01T00:00:00.000Z",
    "business_purpose": "helping people to find themselves",
    "industry": "OTHER_SERVICES",
    "industry_key": "EDUCATION",
    "terms_conditions_signed_at": "2017-01-01T00:00:00.000Z",
    "own_economic_interest_signed_at": "2017-01-01T00:00:00.000Z",
    "expected_monthly_revenue_cents": 20000,
    "vat_number": "DE123456789",
    "website_social_media": "http://social-network.com/my-company",
    "business_trading_name": "My Business",
    "nace_code": "I 56.30",
    "business_address_line_1": "StreetStrasse, 42",
    "business_address_line_2": "4th floor",
    "business_postal_code": "12345",
    "business_city": "Berlin",
    "business_country": "DE",
    "data_terms_signed_at": "2017-01-01T00:00:00.000Z",
    "annual_income_range": "RANGE_1",
    "branch": "DE",
    "main_income_source": "PUBLIC_SUBSIDIES",
    "purpose_of_account_opening": "DAILY_EXPENSES",
    "socioprofessional_category": "EMPLOYEES",
    "work_country": "IT",
    "work_province": "VE",
    "self_declared_as_pep": false,
    "international_operativity_expectation": [ … ],
    "registration_number": "1234567890",
    "flagged_by_compliance": false,
    "screening_progress": "SCREENED_ACCEPTED",
    "aml_follow_up_date": "2017-01-15",
    "aml_confirmed_on": "2017-01-30",
    "risk_classification_status": "NORMAL_RISK",
    "customer_vetting_status": "NO_MATCH",
    "legitimation_valid_until": "2025-12-31"
  }
]

Retrieve a person

Request

Returns the person resource specified in the request URL.

Path
idstringrequired
No request payload

Responses

Successful result of the operation

Bodyapplication/json
idstring

The unique ID of the person resource created for a customer.

Example: "dc1a6812a14f6cc338cd084208535bcdcper"
salutationstring

The person's salutation. Use null to indicate nonbinary.

Enum"MR""MS"
Example: "MR"
titlestring

The person's title.

Enum"DR""MAGISTER""PROF""PROF_DR""BOTSCH""DIPL_PAD""DIPL_BETRIEBSW""DIPL_ING""DIPL_KFFR""DIPL_KFM"
Example: "DR"
first_namestring

The person's first name.

Example: "Peter"
last_namestring

The person's last name.

Example: "Mustermann"
addressobject

The person's address.

Example: {"line_1":"Musterstrasse","line_2":"Musterstrasse","postal_code":"10409","city":"Berlin","country":"DE","state":"BE"}
contact_addressobject

The person's contact address. Use this field only if they have lived at their current address for less than 2 years.

Example: {"line_1":"Musterstrasse","line_2":"Musterstrasse","postal_code":"10409","city":"Berlin","country":"DE","state":"BE"}
emailstring

The person's email.

Example: "person@example.com"
mobile_numberstring

The person mobile number. Spaces, dashes, underscores, and forward slashes are removed. Important: This field is only used to pass the mobile number to our KYC provider IDnow for the Videoident KYC flow. To create and verify a mobile number for your customer, use the dedicated mobile number endpoints.

Example: "49301234567"
birth_namestring

The person's birth name.

Example: "Doe"
birth_datestring

The person's date of birth.

Example: "1972-12-24"
birth_citystring

The city in which the person was born.

Example: "Berlin"
birth_countrystring
Enum"AD""AE""AF""AG""AI""AL""AM""AO""AQ""AR"
Example: "DE"
nationalitystring

The customer's nationality.

Example: "DE"
employment_statusstring

The customer's employment status.

Enum"EMPLOYED""UNEMPLOYED""PUBLIC_SECTOR_EMPLOYEE""PROFESSIONAL_SOLDIER""FREELANCER""HOUSEWORK""APPRENTICE""MANAGEMENT""RETIRED""STUDENT"
Example: "FREELANCER"
job_titlestring

The person's job title.

Example: "Head of everything"
tax_informationobject
Example: {"tax_assessment":"SEPARATE","marital_status":"MARRIED"}
fatca_relevantboolean

Indicates whether or not the person is FATCA relevant.

fatca_crs_confirmed_atstring

UTC timestamp from when the person confirmed their FATCA relevance.

Example: "2017-01-01T00:00:00.000Z"
business_purposestring

The purpose of the person's freelance business.

Example: "helping people to find themselves"
industrystring
Enum"BUILDING_INDUSTRY""CHEMICAL_INDUSTRY_COKE_OVEN_MINERAL_OIL""CONSUMER_INSTALMENT_CREDITS""DEBIT_BALANCE_SALARY_ACCOUNT""FARMER_FORESTRY_FISHING_AND_AQUACULTURE""FINANCIAL_INSTITUTIONS_INSURANCE""FINANCIAL_LEASING_COMPANIES""FOOD_INDUSTRY_TOBACCO_PRODUCTS""GASTRONOMY""HEALTH_CARE_VETERIN_A_WELFARE_FIRM_FREELANCE"
Example: "OTHER_SERVICES"
industry_keystring
Enum"ACCOMMODATION""ACTIVITIES_OF_BUSINESS_EMPLOYERS_AND_PROFESSIONAL_MEMBERSHIP_ORGANISATIONS""ACTIVITIES_OF_HEAD_OFFICES""ACTIVITIES_OF_INVESTMENT_STOCK_CORPORATIONS_AND_FUNDS_OF_INVESTMENT_MANAGEMENT_COMPANIES_EXCL_MONEY_MARKET_FUNDS""ADULT_ENTERTAINMENT_AND_ONLINE_DATING_AND_RELATED""ADVERTISING_AND_MARKET_RESEARCH""AIR_TRANSPORT""ARCHITECTURAL_AND_ENGINEERING_ACTIVITIES_TECHNICAL_TESTING_AND_ANALYSIS""BUYING_AND_SELLING_OF_OWN_NON_RESIDENTIAL_REAL_ESTATE""BUYING_AND_SELLING_OF_OWN_RESIDENTIAL_REAL_ESTATE"
Example: "EDUCATION"
terms_conditions_signed_atstring

UTC timestamp from when the person agreed to the Solaris Terms & Conditions.

Example: "2017-01-01T00:00:00.000Z"
own_economic_interest_signed_atstring(date-time)

UTC timestamp from when the customer confirmed that they act on behalf of their own economic interest.

Example: "2017-01-01T00:00:00.000Z"
flagged_by_complianceboolean

Indicates whether the person is flagged by compliance and must answer any compliance questions.

expected_monthly_revenue_centsinteger

(For freelancers) The person's expected monthly revenue, in Euro cents.

Example: 20000
vat_numberstring

(For freelancers) The person's VAT number.

Example: "DE123456789"
website_social_mediastring

(For freelancers) The person's business website/social media.

Example: "http://social-network.com/my-company"
business_trading_namestring

(For freelancers) The person's business trading name.

Example: "My Business"
nace_codestring
Enum"I 55.10""I 55.20""I 55.30""I 55.90""I 56.10""I 56.21""I 56.29""I 56.30""J 58.11""J 58.12"
Example: "I 56.30"
business_address_line_1string

(For freelancers) Business address line 1

Example: "StreetStrasse, 42"
business_address_line_2string

(For freelancers) Business address line 2

Example: "4th floor"
business_postal_codestring

(For freelancers) Business postal code

Example: "12345"
business_citystring

(For freelancers) Business city

Example: "Berlin"
business_countrystring
Enum"AD""AE""AF""AG""AI""AL""AM""AO""AQ""AR"
Example: "DE"
screening_progressstring

The status of the person screening process.

Enum"NOT_SCREENED""POTENTIAL_MATCH""SCREENED_ACCEPTED""SCREENED_DECLINED"
Example: "SCREENED_ACCEPTED"
annual_income_rangestring

The person's annual income range.

Enum"RANGE_1""RANGE_2""RANGE_3""RANGE_4""RANGE_5""RANGE_6""RANGE_7"
Example: "RANGE_1"
data_terms_signed_atstring(date-time)

UTC timestamp from when the customer signed Solaris' data processing agreement.

Example: "2017-01-01T00:00:00.000Z"
aml_follow_up_datestring(date)

The follow-up date for the anti-money laundering department.

Example: "2017-01-15"
aml_confirmed_onstring(date)

The confirmation date of the anti-money laundering department.

Example: "2017-01-30"
self_declared_as_pepboolean

Indicates whether the person has self-declared their status as a politically exposed person (PEP).

international_operativity_expectationArray of strings

(For freelancers) Regions where the person expects to conduct business.

Items Enum"AFRICA""ASIA""MIDDLE_EAST""NORTH_AMERICA""SOUTH_AMERICA""NATIONAL_ACTIVITY_ONLY"
Example: ["AFRICA","ASIA"]
registration_numberstring

(For freelancers) The person's freelance registration number.

Example: "1234567890"
risk_classification_statusstring

The status of the person's risk classification.

Enum"NOT_SCORED""POTENTIAL_RISK""NORMAL_RISK""INFORMATION_REQUESTED""INFORMATION_RECEIVED""RISK_ACCEPTED""RISK_REJECTED""CUSTOMER_UNRESPONSIVE""SCORING_NOT_REQUIRED"
Example: "NORMAL_RISK"
customer_vetting_statusstring

The status of the person's vetting process.

Enum"NOT_VETTED""NO_MATCH""POTENTIAL_MATCH""INFORMATION_REQUESTED""INFORMATION_RECEIVED""RISK_ACCEPTED""RISK_REJECTED""CUSTOMER_UNRESPONSIVE""VETTING_NOT_REQUIRED"
Example: "NO_MATCH"
legitimation_valid_untilstring(date)

Date when the legitimation data becomes invalid.

Example: "2025-12-31"
Response
application/json
{
  "id": "dc1a6812a14f6cc338cd084208535bcdcper",
  "salutation": "MR",
  "title": "DR",
  "first_name": "Peter",
  "last_name": "Mustermann",
  "address": {
    "line_1": "Musterstrasse",
    "line_2": "Musterstrasse",
    "postal_code": "10409",
    "city": "Berlin",
    "country": "DE",
    "state": "BE"
  },
  "contact_address": {
    "line_1": "Musterstrasse",
    "line_2": "Musterstrasse",
    "postal_code": "10409",
    "city": "Berlin",
    "country": "DE",
    "state": "BE"
  },
  "email": "person@example.com",
  "mobile_number": "49301234567",
  "birth_name": "Doe",
  "birth_date": "1972-12-24",
  "birth_city": "Berlin",
  "birth_country": "DE",
  "birth_province": "BE",
  "birth_post_code": "10233",
  "nationality": "DE",
  "employment_status": "FREELANCER",
  "job_title": "Head of everything",
  "tax_information": {
    "tax_assessment": "SEPARATE",
    "marital_status": "MARRIED"
  },
  "fatca_relevant": false,
  "fatca_crs_confirmed_at": "2017-01-01T00:00:00.000Z",
  "business_purpose": "helping people to find themselves",
  "industry": "OTHER_SERVICES",
  "industry_key": "EDUCATION",
  "terms_conditions_signed_at": "2017-01-01T00:00:00.000Z",
  "own_economic_interest_signed_at": "2017-01-01T00:00:00.000Z",
  "expected_monthly_revenue_cents": 20000,
  "vat_number": "DE123456789",
  "website_social_media": "http://social-network.com/my-company",
  "business_trading_name": "My Business",
  "nace_code": "I 56.30",
  "business_address_line_1": "StreetStrasse, 42",
  "business_address_line_2": "4th floor",
  "business_postal_code": "12345",
  "business_city": "Berlin",
  "business_country": "DE",
  "data_terms_signed_at": "2017-01-01T00:00:00.000Z",
  "annual_income_range": "RANGE_1",
  "branch": "DE",
  "main_income_source": "PUBLIC_SUBSIDIES",
  "purpose_of_account_opening": "DAILY_EXPENSES",
  "socioprofessional_category": "EMPLOYEES",
  "work_country": "IT",
  "work_province": "VE",
  "self_declared_as_pep": false,
  "international_operativity_expectation": [
    "AFRICA",
    "ASIA"
  ],
  "registration_number": "1234567890",
  "flagged_by_compliance": false,
  "screening_progress": "SCREENED_ACCEPTED",
  "aml_follow_up_date": "2017-01-15",
  "aml_confirmed_on": "2017-01-30",
  "risk_classification_status": "NORMAL_RISK",
  "customer_vetting_status": "NO_MATCH",
  "legitimation_valid_until": "2025-12-31"
}

Update a person

Request

Updates one or more properties on a person resource.
Note: You can update some and not all properties using this endpoint. This API reference lists only the properties you can update with this call. This call triggers the change request process (unless the property being updated has a value of null).

Path
idstringrequired
Bodyapplication/json

The content of the request.

salutationstring

The person's salutation. Use null to indicate nonbinary (Germany only).

Enum"MR""MS"
Example: "MR"
titlestring

The person's title.

Enum"DR""MAGISTER""PROF""PROF_DR""BOTSCH""DIPL_PAD""DIPL_BETRIEBSW""DIPL_ING""DIPL_KFFR""DIPL_KFM"
Example: "DR"
addressobject

The person's address.

Example: {"line_1":"Musterstrasse","line_2":"Musterstrasse","postal_code":"10409","city":"Berlin","country":"DE","state":"BE"}
contact_addressobject

The person's contact address.

Example: {"line_1":"Musterstrasse","line_2":"Musterstrasse","postal_code":"10409","city":"Berlin","country":"DE","state":"BE"}
emailstring

The person's email.

Example: "person@example.com"
birth_provincestring

The province in which the person was born (if applicable).

Example: "BE"
birth_post_codestring

The postal code in which the person was born.

Example: "10233"
employment_statusstring

The person's employment status.

Enum"EMPLOYED""UNEMPLOYED""PUBLIC_SECTOR_EMPLOYEE""PROFESSIONAL_SOLDIER""FREELANCER""HOUSEWORK""APPRENTICE""MANAGEMENT""RETIRED""STUDENT"
Example: "FREELANCER"
job_titlestring

The person's job title.

Example: "Head of everything"
tax_informationobject
Example: {"tax_assessment":"SEPARATE","marital_status":"MARRIED"}
fatca_relevantboolean

Indicates whether or not the person is FATCA relevant.

Example: true
fatca_crs_confirmed_atstring

UTC timestamp from when the person confirmed their FATCA relevance.

Example: "2017-01-01T00:00:00.000Z"
business_purposestring

The purpose of the person's freelance business.

Example: "helping people to find themselves"
industrystring
Enum"BUILDING_INDUSTRY""CHEMICAL_INDUSTRY_COKE_OVEN_MINERAL_OIL""CONSUMER_INSTALMENT_CREDITS""DEBIT_BALANCE_SALARY_ACCOUNT""FARMER_FORESTRY_FISHING_AND_AQUACULTURE""FINANCIAL_INSTITUTIONS_INSURANCE""FINANCIAL_LEASING_COMPANIES""FOOD_INDUSTRY_TOBACCO_PRODUCTS""GASTRONOMY""HEALTH_CARE_VETERIN_A_WELFARE_FIRM_FREELANCE"
Example: "OTHER_SERVICES"
industry_keystring
Enum"ACCOMMODATION""ACTIVITIES_OF_BUSINESS_EMPLOYERS_AND_PROFESSIONAL_MEMBERSHIP_ORGANISATIONS""ACTIVITIES_OF_HEAD_OFFICES""ACTIVITIES_OF_INVESTMENT_STOCK_CORPORATIONS_AND_FUNDS_OF_INVESTMENT_MANAGEMENT_COMPANIES_EXCL_MONEY_MARKET_FUNDS""ADULT_ENTERTAINMENT_AND_ONLINE_DATING_AND_RELATED""ADVERTISING_AND_MARKET_RESEARCH""AIR_TRANSPORT""ARCHITECTURAL_AND_ENGINEERING_ACTIVITIES_TECHNICAL_TESTING_AND_ANALYSIS""BUYING_AND_SELLING_OF_OWN_NON_RESIDENTIAL_REAL_ESTATE""BUYING_AND_SELLING_OF_OWN_RESIDENTIAL_REAL_ESTATE"
Example: "EDUCATION"
own_economic_interest_signed_atstring

UTC timestamp from when the customer confirmed that they act on behalf of their own economic interest.

Example: "2017-01-01T00:00:00.000Z"
expected_monthly_revenue_centsinteger

(For freelancers) The person's expected monthly revenue, in Euro cents.

Example: 20000
vat_numberstring

(For freelancers) The person's VAT number.

Example: "DE999999999"
website_social_mediastring

(For freelancers) The person's business website/social media.

Example: "http://social-network.com/my-company"
business_trading_namestring

(For freelancers) The person's business trading name.

Example: "My Business"
nace_codestring
Enum"I 55.10""I 55.20""I 55.30""I 55.90""I 56.10""I 56.21""I 56.29""I 56.30""J 58.11""J 58.12"
Example: "I 56.30"
business_address_line_1string

(For freelancers) Business address line 1

Example: "StreetStrasse, 42"
business_address_line_2string

(For freelancers) Business address line 2

Example: "4th floor"
business_postal_codestring

(For freelancers) Business postal code

Example: "12345"
business_citystring

(For freelancers) Business city

Example: "Berlin"
business_countrystring
Enum"AD""AE""AF""AG""AI""AL""AM""AO""AQ""AR"
Example: "DE"
data_terms_signed_atstring

The date and time when the person signed the Solaris data processing agreement.

Example: "2017-01-01T00:00:00.000Z"
annual_income_rangestring

The person's annual income range.

Enum"RANGE_1""RANGE_2""RANGE_3""RANGE_4""RANGE_5""RANGE_6""RANGE_7"
Example: "RANGE_1"
branchstring

The Solaris branch under which the person will have an account.

Enum"DE""ES""FR""IT"
Example: "DE"
main_income_sourcestring

The person's main source of income.

Enum"SALARY_INCOME_OR_OWN_BUSINESS""REAL_ESTATE_INCOME""INCOME_FROM_SAVINGS""SALES_OF_ASSETS""FAMILY_INCOME""DONATIONS""INHERITANCE""PENSION""PUBLIC_SUBSIDIES"
Example: "PUBLIC_SUBSIDIES"
purpose_of_account_openingstring

The person's purpose for opening the account.

Enum"SAVINGS""DAILY_EXPENSES""TRAVELLING_AND_RELOCATING""FREELANCER_ACTIVITY""ONLINE_SHOPPING""SALARY_OR_PENSION_ACCREDITATION""TRADING"
Example: "DAILY_EXPENSES"
socioprofessional_categorystring

The person's socio-professional category.

Enum"FARMERS""CRAFTSMEN""MERCHANTS_AND_COMPANY_MANAGERS""MANAGERS_AND_HIGHER_INTELLECTUAL_PROFESSIONS""INTERMEDIATE_PROFESSIONS""EMPLOYEES""WORKERS"
Example: "EMPLOYEES"
work_countrystring
Enum"AD""AE""AF""AG""AI""AL""AM""AO""AQ""AR"
Example: "DE"
work_provincestring

The person's province of work (if applicable).

self_declared_as_pepboolean

Indicates whether the person has self-declared their status as a politically exposed person (PEP).

international_operativity_expectationArray of strings

(For freelancers) Regions where the person expects to conduct business.

Items Enum"AFRICA""ASIA""MIDDLE_EAST""NORTH_AMERICA""SOUTH_AMERICA""NATIONAL_ACTIVITY_ONLY"
registration_numberstring

(For freelancers) The person's freelance registration number.

Example: "1234567890"
device_datastring

Encoded device fingerprint generated using the Seon SDK. See the device monitoring guide for more information about generating this value.

Example: "Web;179ac83968ab42f79e960c1753a4078fdcon;jVl14emA+OcyALb9F+CMFg==;NU7aFh0jdzM15wj8hQtqbA5LbzEFWDI1bUwZf/zbau0P2MIEUE+LsifBKvxjCYNUyz647bpSjnQ6Tu8IK22sxFlTGEFaHKBigzmP8Nc8FvVSWKzslmSWTFJM5AYc+EGTZLprlcdrLldsZLS5PpHfPMmvtqCXVTnGhYV7GvutI1w5/67yK7pCQDxDicKjqlMg1naMiwCuqP1U1lUtf+lTdmJ1T1lXMPARffTn4XAr66vUxN++sy7qytkdcOeCsaxZnLspUEvqu+2ILHF8pOJFG7gYC11rqWOyHG3Ns1E1dZ57ybrgGTKfctFOdx2IMXnz1/i/pDC5QokRr2BTIZZ/9Tj+xXzWpzNwHtRWWK5VEufyVRPyMXQdmry7UYKrouAzlLCYSMv7GcPwOZz+gDjCkrNia7/DGBBFLOvtlufDztPpvkH2jmN32/oJHl1Qu6zpxG3Lyl8RNdyukuNYfiPw0ECoXsXObwQc7Ja8R+V5S7QZeV1VV9aavlH1+Xl9v0OlOJ1XujO7izWESMIfzAuaL6ACYhdkmkC3kicjOWUjaY3OJYrrXxQ+MScnJOQ9neMRWij7YqNxP8F259zVjqqyaL6hN8EZU/pi+cZUVkfFvMYT5ugE9JXjkFfyy4UQeSmNRjDXRzu40LyweqUns8u3GOIFzfZ9eVOv+q7OV+RpVLOJLz1Za8RPIh3UKltCzOTmO8OpDz2aGoqNdL4zAaLl4EKRoarEiSG9K2/GoyHchi6xdHYA6DqQg5xQM4s50RUySGwWLxBB3ZlMpZpdZAVBrLSyl1SWqYTosdyURtiiX0So+kdik5XJ5Vsh0v75rNP5Yrv3t5/u94wx51zKlpDH8Uiap7kP0eibRmmN196kxMcOf8Q50JM1Yt8cJiawTWdGHzGRcNtEkpon5VLp/kwDU+4IPwlW976hKsom0PTB/EVxo5CWuL6kPiaEWUrWOL7BZ2jkuebHT2jBAJuFBaeac7IYnrAMoLgfY33Vs3EtVk8H12iDX3O9JmGsDGXP0/vBx0uFEgrTt6HjwabWGRHpPPPCorSrjfuySwKlnZtp1KkeNrOso8K8DBW6e+6j1YYaxTjBUZSLl1qgzd1dpz85vB/trWdyS3i+APHw/AsP/Y4cmu/CFZqpe1Sgye1+YNP3Hs3LpxJKM3prnAoaCmrHp5aUKo5KdicAnilBTzBAV2zGBWHrBwWLWHl+RDQpncyWD2/ZCswxtXbQAhlmVD7FvBXnT0Yyg5gaFo5GVBcURzBYtwbdl3+6sqKtR3XC22GBw0OOqZ9/QvMHmCO/K89rEjfLEaVX4eKhrdzjxOwOxmE5lXrLqfscV90Yo9Uj1awvpF5TL5vW85asT2iVHYjZ1JsQ5oLp3VUfIAqTNmpcjRk763hMsTUIrn3VfpLkGajZbtxD2FuNNMoRZQBfiOAxPUDFmspxWagNSbmUZ8FqPX/6asQIJIyvAk4cvzgV9OjzdkoEcFP2OGjFnddZtLmBh9BZDWtS3VOL98lp+cH/JAn8pDab2l6zIwHRccePbuBcGZZgU39FOVpI+sbHZJ6QEhiUA8SdT7SLcTf4P1tBbdN5+dpjaWfTph1cgZyW8EsAIFc81vR6tBqSSpxmS164ADWZW+PYz4b4SRVklT3Cs2tJ/TTMM240pnkNJUd3G/0PbBGVPea5+XUs1bF5cT0fiHWA032Dm87biMEU89fdPkvnSlIsN/MbLT2kj2tPZqhOrqTxCg26jimd+2kNdZ2fwvT8JQfO0hVidnPDPLXH5aA6T6+bKqfpvJE6USAif8fPQ0rW4+315LKH5wG8Qj0omO2Ynii0IE6cR0lAGrtoLsXMf3kDqFms+Z2h79pYQrnhUSntZ3tjt3pwgejJ8ZKXdN7kYWT8UiQnLnkfLJnh1e8a4UURe7GU9UwnqqFXeHrstb8XXxiIX7syFG5iLdN9IExi5BefYnAikCTU+ssMWnnhppX6jFV43u+KEaa1/7AqibMc3Kt+kUxHlQsAo2TCg+u/39rsgNs5eWym7YptvBCN6L4Q4QRoKNFo8CJerS4dTxksD2zeGL4BLIsvMbcm6rlHrKCR5PeWRiFpK8QwwaOyiTGL5NN2Xl6F0M4vf5gnWikZTrppv7bLUYZhrU1uGiv968ZGEq+A7w2oLvbZS7l+DZuN4rPF5SzPWq94jC1NiYjaPrGyTQIISRiBLXil5puqCobYHAIeVQzHBgki3/N+Pwk4iCrxf3pqnUSNmtrmvphmo9Vp3xAaPSFsUYfIyOPiO5gcNUoGQ1kHZ3Yoksqh6U1hRCzlkMSbX6kzDYUNEgc47t2AKxLM5IpYCWAv+uefNAAb/4+f7Qh4sMqtXHc5lGK3GN8ABTIVeFphtJg36Y6xg8OTrBR5ItS/tdy6zyfTLfZFocRbfjsLfoiCeHJO0sEZIWgHsu80FVZmo4G84N6zNZkdjnFDZkgRYP9OSqMbPCXyb5Xj1H6g67rNjtY67B3613uGJ0pHCQpl0Lmz2apUMq9EVRz5tZT+RA8sCRcK4mkBEWzdC7ngI5+dfX2dEqu157rsc0yU4OWNElLWC3F1TXOsB2/n1+LBHpjKLIMok2afui1H9+eof1zLAba4hrnYEFI4WjvEAvcsyPI/eONNdxk7liVNNaD7j6vvwYKOxTZoriKwvGxeNApC+Z8xQ8HpnEaRIUqb2Eh1SfpyDta8J1dXnRF1HTq2pOvfitomb701g0diB7+StEpCxiRLCx3TEJcroqBiCE3szXdc9VSVyfklkHmbJE33CY8tGm1YEvaXAY7a5yWLHWHzqQvNuZkQ1DNbJAkP9dt1t8Fv3njG2lXFmAOJkZwpvm9qEHZTmuUmflIMhu9nMsgZd5VMjalTmHqZdy7zmnAz8LhYiUDMbPDNOd4UTehvTanDEBBYTJB6CYv6QnBYwuAPsZwRnZdHbpl6lIXStmgsxV3DLtKAUy8eoqCdDOMyep9L4ArSWEJstEBNkZ5zgk7bOspvF1V8HrhFzJCiwR7WC+GHJTHLH1S8FfmHFTXJHecvq6tpMncaJFbo4jSfm9ozBAVAAN2mCn/yBbmX9tPmXdGEsTSpdp6vVWKEdHZ1rjCqmgDENxh75H5uT9DeZ0mAKwkP5Ai+bN3hT0y1XGE44b/aJ7PEObogYAioej/Z690zKx+fHxP50juTgt+UIQ+l/mpcYnbcYe4lkXrqGpwxFU8OrRzzfJX/s90VVlzrQVAPNW/mvYkt+MqSVwI1EP62faXlXnDqbmVFUmMGeoquP58cwqSBaNL/oi2Rg7GVvdvus+i2Qpm1SHtnPVUhTwWFigiWw/T2ZZeUs4nk+Q/xOFa/"
application/json
{
  "salutation": "MR",
  "title": "DR",
  "address": {
    "line_1": "Musterstrasse",
    "line_2": "Musterstrasse",
    "postal_code": "10409",
    "city": "Berlin",
    "country": "DE",
    "state": "BE"
  },
  "contact_address": {
    "line_1": "Musterstrasse",
    "line_2": "Musterstrasse",
    "postal_code": "10409",
    "city": "Berlin",
    "country": "DE",
    "state": "BE"
  },
  "email": "person@example.com",
  "birth_province": "BE",
  "birth_post_code": "10233",
  "employment_status": "FREELANCER",
  "job_title": "Head of everything",
  "tax_information": {
    "tax_assessment": "SEPARATE",
    "marital_status": "MARRIED"
  },
  "fatca_relevant": true,
  "fatca_crs_confirmed_at": "2017-01-01T00:00:00.000Z",
  "business_purpose": "helping people to find themselves",
  "industry": "OTHER_SERVICES",
  "industry_key": "EDUCATION",
  "own_economic_interest_signed_at": "2017-01-01T00:00:00.000Z",
  "expected_monthly_revenue_cents": 20000,
  "vat_number": "DE999999999",
  "website_social_media": "http://social-network.com/my-company",
  "business_trading_name": "My Business",
  "nace_code": "I 56.30",
  "business_address_line_1": "StreetStrasse, 42",
  "business_address_line_2": "4th floor",
  "business_postal_code": "12345",
  "business_city": "Berlin",
  "business_country": "DE",
  "data_terms_signed_at": "2017-01-01T00:00:00.000Z",
  "annual_income_range": "RANGE_1",
  "branch": "DE",
  "main_income_source": "PUBLIC_SUBSIDIES",
  "purpose_of_account_opening": "DAILY_EXPENSES",
  "socioprofessional_category": "EMPLOYEES",
  "work_country": "DE",
  "work_province": "",
  "self_declared_as_pep": false,
  "registration_number": "1234567890",
  "device_data": "Web;179ac83968ab42f79e960c1753a4078fdcon;jVl14emA+OcyALb9F+CMFg==;NU7aFh0jdzM15wj8hQtqbA5LbzEFWDI1bUwZf/zbau0P2MIEUE+LsifBKvxjCYNUyz647bpSjnQ6Tu8IK22sxFlTGEFaHKBigzmP8Nc8FvVSWKzslmSWTFJM5AYc+EGTZLprlcdrLldsZLS5PpHfPMmvtqCXVTnGhYV7GvutI1w5/67yK7pCQDxDicKjqlMg1naMiwCuqP1U1lUtf+lTdmJ1T1lXMPARffTn4XAr66vUxN++sy7qytkdcOeCsaxZnLspUEvqu+2ILHF8pOJFG7gYC11rqWOyHG3Ns1E1dZ57ybrgGTKfctFOdx2IMXnz1/i/pDC5QokRr2BTIZZ/9Tj+xXzWpzNwHtRWWK5VEufyVRPyMXQdmry7UYKrouAzlLCYSMv7GcPwOZz+gDjCkrNia7/DGBBFLOvtlufDztPpvkH2jmN32/oJHl1Qu6zpxG3Lyl8RNdyukuNYfiPw0ECoXsXObwQc7Ja8R+V5S7QZeV1VV9aavlH1+Xl9v0OlOJ1XujO7izWESMIfzAuaL6ACYhdkmkC3kicjOWUjaY3OJYrrXxQ+MScnJOQ9neMRWij7YqNxP8F259zVjqqyaL6hN8EZU/pi+cZUVkfFvMYT5ugE9JXjkFfyy4UQeSmNRjDXRzu40LyweqUns8u3GOIFzfZ9eVOv+q7OV+RpVLOJLz1Za8RPIh3UKltCzOTmO8OpDz2aGoqNdL4zAaLl4EKRoarEiSG9K2/GoyHchi6xdHYA6DqQg5xQM4s50RUySGwWLxBB3ZlMpZpdZAVBrLSyl1SWqYTosdyURtiiX0So+kdik5XJ5Vsh0v75rNP5Yrv3t5/u94wx51zKlpDH8Uiap7kP0eibRmmN196kxMcOf8Q50JM1Yt8cJiawTWdGHzGRcNtEkpon5VLp/kwDU+4IPwlW976hKsom0PTB/EVxo5CWuL6kPiaEWUrWOL7BZ2jkuebHT2jBAJuFBaeac7IYnrAMoLgfY33Vs3EtVk8H12iDX3O9JmGsDGXP0/vBx0uFEgrTt6HjwabWGRHpPPPCorSrjfuySwKlnZtp1KkeNrOso8K8DBW6e+6j1YYaxTjBUZSLl1qgzd1dpz85vB/trWdyS3i+APHw/AsP/Y4cmu/CFZqpe1Sgye1+YNP3Hs3LpxJKM3prnAoaCmrHp5aUKo5KdicAnilBTzBAV2zGBWHrBwWLWHl+RDQpncyWD2/ZCswxtXbQAhlmVD7FvBXnT0Yyg5gaFo5GVBcURzBYtwbdl3+6sqKtR3XC22GBw0OOqZ9/QvMHmCO/K89rEjfLEaVX4eKhrdzjxOwOxmE5lXrLqfscV90Yo9Uj1awvpF5TL5vW85asT2iVHYjZ1JsQ5oLp3VUfIAqTNmpcjRk763hMsTUIrn3VfpLkGajZbtxD2FuNNMoRZQBfiOAxPUDFmspxWagNSbmUZ8FqPX/6asQIJIyvAk4cvzgV9OjzdkoEcFP2OGjFnddZtLmBh9BZDWtS3VOL98lp+cH/JAn8pDab2l6zIwHRccePbuBcGZZgU39FOVpI+sbHZJ6QEhiUA8SdT7SLcTf4P1tBbdN5+dpjaWfTph1cgZyW8EsAIFc81vR6tBqSSpxmS164ADWZW+PYz4b4SRVklT3Cs2tJ/TTMM240pnkNJUd3G/0PbBGVPea5+XUs1bF5cT0fiHWA032Dm87biMEU89fdPkvnSlIsN/MbLT2kj2tPZqhOrqTxCg26jimd+2kNdZ2fwvT8JQfO0hVidnPDPLXH5aA6T6+bKqfpvJE6USAif8fPQ0rW4+315LKH5wG8Qj0omO2Ynii0IE6cR0lAGrtoLsXMf3kDqFms+Z2h79pYQrnhUSntZ3tjt3pwgejJ8ZKXdN7kYWT8UiQnLnkfLJnh1e8a4UURe7GU9UwnqqFXeHrstb8XXxiIX7syFG5iLdN9IExi5BefYnAikCTU+ssMWnnhppX6jFV43u+KEaa1/7AqibMc3Kt+kUxHlQsAo2TCg+u/39rsgNs5eWym7YptvBCN6L4Q4QRoKNFo8CJerS4dTxksD2zeGL4BLIsvMbcm6rlHrKCR5PeWRiFpK8QwwaOyiTGL5NN2Xl6F0M4vf5gnWikZTrppv7bLUYZhrU1uGiv968ZGEq+A7w2oLvbZS7l+DZuN4rPF5SzPWq94jC1NiYjaPrGyTQIISRiBLXil5puqCobYHAIeVQzHBgki3/N+Pwk4iCrxf3pqnUSNmtrmvphmo9Vp3xAaPSFsUYfIyOPiO5gcNUoGQ1kHZ3Yoksqh6U1hRCzlkMSbX6kzDYUNEgc47t2AKxLM5IpYCWAv+uefNAAb/4+f7Qh4sMqtXHc5lGK3GN8ABTIVeFphtJg36Y6xg8OTrBR5ItS/tdy6zyfTLfZFocRbfjsLfoiCeHJO0sEZIWgHsu80FVZmo4G84N6zNZkdjnFDZkgRYP9OSqMbPCXyb5Xj1H6g67rNjtY67B3613uGJ0pHCQpl0Lmz2apUMq9EVRz5tZT+RA8sCRcK4mkBEWzdC7ngI5+dfX2dEqu157rsc0yU4OWNElLWC3F1TXOsB2/n1+LBHpjKLIMok2afui1H9+eof1zLAba4hrnYEFI4WjvEAvcsyPI/eONNdxk7liVNNaD7j6vvwYKOxTZoriKwvGxeNApC+Z8xQ8HpnEaRIUqb2Eh1SfpyDta8J1dXnRF1HTq2pOvfitomb701g0diB7+StEpCxiRLCx3TEJcroqBiCE3szXdc9VSVyfklkHmbJE33CY8tGm1YEvaXAY7a5yWLHWHzqQvNuZkQ1DNbJAkP9dt1t8Fv3njG2lXFmAOJkZwpvm9qEHZTmuUmflIMhu9nMsgZd5VMjalTmHqZdy7zmnAz8LhYiUDMbPDNOd4UTehvTanDEBBYTJB6CYv6QnBYwuAPsZwRnZdHbpl6lIXStmgsxV3DLtKAUy8eoqCdDOMyep9L4ArSWEJstEBNkZ5zgk7bOspvF1V8HrhFzJCiwR7WC+GHJTHLH1S8FfmHFTXJHecvq6tpMncaJFbo4jSfm9ozBAVAAN2mCn/yBbmX9tPmXdGEsTSpdp6vVWKEdHZ1rjCqmgDENxh75H5uT9DeZ0mAKwkP5Ai+bN3hT0y1XGE44b/aJ7PEObogYAioej/Z690zKx+fHxP50juTgt+UIQ+l/mpcYnbcYe4lkXrqGpwxFU8OrRzzfJX/s90VVlzrQVAPNW/mvYkt+MqSVwI1EP62faXlXnDqbmVFUmMGeoquP58cwqSBaNL/oi2Rg7GVvdvus+i2Qpm1SHtnPVUhTwWFigiWw/T2ZZeUs4nk+Q/xOFa/"
}

Responses

Successful result of the operation

Bodyapplication/json
idstring

The unique ID of the person resource created for a customer.

Example: "dc1a6812a14f6cc338cd084208535bcdcper"
salutationstring

The person's salutation. Use null to indicate nonbinary.

Enum"MR""MS"
Example: "MR"
titlestring

The person's title.

Enum"DR""MAGISTER""PROF""PROF_DR""BOTSCH""DIPL_PAD""DIPL_BETRIEBSW""DIPL_ING""DIPL_KFFR""DIPL_KFM"
Example: "DR"
first_namestring

The person's first name.

Example: "Peter"
last_namestring

The person's last name.

Example: "Mustermann"
addressobject

The person's address.

Example: {"line_1":"Musterstrasse","line_2":"Musterstrasse","postal_code":"10409","city":"Berlin","country":"DE","state":"BE"}
contact_addressobject

The person's contact address. Use this field only if they have lived at their current address for less than 2 years.

Example: {"line_1":"Musterstrasse","line_2":"Musterstrasse","postal_code":"10409","city":"Berlin","country":"DE","state":"BE"}
emailstring

The person's email.

Example: "person@example.com"
mobile_numberstring

The person mobile number. Spaces, dashes, underscores, and forward slashes are removed. Important: This field is only used to pass the mobile number to our KYC provider IDnow for the Videoident KYC flow. To create and verify a mobile number for your customer, use the dedicated mobile number endpoints.

Example: "49301234567"
birth_namestring

The person's birth name.

Example: "Doe"
birth_datestring

The person's date of birth.

Example: "1972-12-24"
birth_citystring

The city in which the person was born.

Example: "Berlin"
birth_countrystring
Enum"AD""AE""AF""AG""AI""AL""AM""AO""AQ""AR"
Example: "DE"
nationalitystring

The customer's nationality.

Example: "DE"
employment_statusstring

The customer's employment status.

Enum"EMPLOYED""UNEMPLOYED""PUBLIC_SECTOR_EMPLOYEE""PROFESSIONAL_SOLDIER""FREELANCER""HOUSEWORK""APPRENTICE""MANAGEMENT""RETIRED""STUDENT"
Example: "FREELANCER"
job_titlestring

The person's job title.

Example: "Head of everything"
tax_informationobject
Example: {"tax_assessment":"SEPARATE","marital_status":"MARRIED"}
fatca_relevantboolean

Indicates whether or not the person is FATCA relevant.

fatca_crs_confirmed_atstring

UTC timestamp from when the person confirmed their FATCA relevance.

Example: "2017-01-01T00:00:00.000Z"
business_purposestring

The purpose of the person's freelance business.

Example: "helping people to find themselves"
industrystring
Enum"BUILDING_INDUSTRY""CHEMICAL_INDUSTRY_COKE_OVEN_MINERAL_OIL""CONSUMER_INSTALMENT_CREDITS""DEBIT_BALANCE_SALARY_ACCOUNT""FARMER_FORESTRY_FISHING_AND_AQUACULTURE""FINANCIAL_INSTITUTIONS_INSURANCE""FINANCIAL_LEASING_COMPANIES""FOOD_INDUSTRY_TOBACCO_PRODUCTS""GASTRONOMY""HEALTH_CARE_VETERIN_A_WELFARE_FIRM_FREELANCE"
Example: "OTHER_SERVICES"
industry_keystring
Enum"ACCOMMODATION""ACTIVITIES_OF_BUSINESS_EMPLOYERS_AND_PROFESSIONAL_MEMBERSHIP_ORGANISATIONS""ACTIVITIES_OF_HEAD_OFFICES""ACTIVITIES_OF_INVESTMENT_STOCK_CORPORATIONS_AND_FUNDS_OF_INVESTMENT_MANAGEMENT_COMPANIES_EXCL_MONEY_MARKET_FUNDS""ADULT_ENTERTAINMENT_AND_ONLINE_DATING_AND_RELATED""ADVERTISING_AND_MARKET_RESEARCH""AIR_TRANSPORT""ARCHITECTURAL_AND_ENGINEERING_ACTIVITIES_TECHNICAL_TESTING_AND_ANALYSIS""BUYING_AND_SELLING_OF_OWN_NON_RESIDENTIAL_REAL_ESTATE""BUYING_AND_SELLING_OF_OWN_RESIDENTIAL_REAL_ESTATE"
Example: "EDUCATION"
terms_conditions_signed_atstring

UTC timestamp from when the person agreed to the Solaris Terms & Conditions.

Example: "2017-01-01T00:00:00.000Z"
own_economic_interest_signed_atstring(date-time)

UTC timestamp from when the customer confirmed that they act on behalf of their own economic interest.

Example: "2017-01-01T00:00:00.000Z"
flagged_by_complianceboolean

Indicates whether the person is flagged by compliance and must answer any compliance questions.

expected_monthly_revenue_centsinteger

(For freelancers) The person's expected monthly revenue, in Euro cents.

Example: 20000
vat_numberstring

(For freelancers) The person's VAT number.

Example: "DE123456789"
website_social_mediastring

(For freelancers) The person's business website/social media.

Example: "http://social-network.com/my-company"
business_trading_namestring

(For freelancers) The person's business trading name.

Example: "My Business"
nace_codestring
Enum"I 55.10""I 55.20""I 55.30""I 55.90""I 56.10""I 56.21""I 56.29""I 56.30""J 58.11""J 58.12"
Example: "I 56.30"
business_address_line_1string

(For freelancers) Business address line 1

Example: "StreetStrasse, 42"
business_address_line_2string

(For freelancers) Business address line 2

Example: "4th floor"
business_postal_codestring

(For freelancers) Business postal code

Example: "12345"
business_citystring

(For freelancers) Business city

Example: "Berlin"
business_countrystring
Enum"AD""AE""AF""AG""AI""AL""AM""AO""AQ""AR"
Example: "DE"
screening_progressstring

The status of the person screening process.

Enum"NOT_SCREENED""POTENTIAL_MATCH""SCREENED_ACCEPTED""SCREENED_DECLINED"
Example: "SCREENED_ACCEPTED"
annual_income_rangestring

The person's annual income range.

Enum"RANGE_1""RANGE_2""RANGE_3""RANGE_4""RANGE_5""RANGE_6""RANGE_7"
Example: "RANGE_1"
data_terms_signed_atstring(date-time)

UTC timestamp from when the customer signed Solaris' data processing agreement.

Example: "2017-01-01T00:00:00.000Z"
aml_follow_up_datestring(date)

The follow-up date for the anti-money laundering department.

Example: "2017-01-15"
aml_confirmed_onstring(date)

The confirmation date of the anti-money laundering department.

Example: "2017-01-30"
self_declared_as_pepboolean

Indicates whether the person has self-declared their status as a politically exposed person (PEP).

international_operativity_expectationArray of strings

(For freelancers) Regions where the person expects to conduct business.

Items Enum"AFRICA""ASIA""MIDDLE_EAST""NORTH_AMERICA""SOUTH_AMERICA""NATIONAL_ACTIVITY_ONLY"
Example: ["AFRICA","ASIA"]
registration_numberstring

(For freelancers) The person's freelance registration number.

Example: "1234567890"
risk_classification_statusstring

The status of the person's risk classification.

Enum"NOT_SCORED""POTENTIAL_RISK""NORMAL_RISK""INFORMATION_REQUESTED""INFORMATION_RECEIVED""RISK_ACCEPTED""RISK_REJECTED""CUSTOMER_UNRESPONSIVE""SCORING_NOT_REQUIRED"
Example: "NORMAL_RISK"
customer_vetting_statusstring

The status of the person's vetting process.

Enum"NOT_VETTED""NO_MATCH""POTENTIAL_MATCH""INFORMATION_REQUESTED""INFORMATION_RECEIVED""RISK_ACCEPTED""RISK_REJECTED""CUSTOMER_UNRESPONSIVE""VETTING_NOT_REQUIRED"
Example: "NO_MATCH"
legitimation_valid_untilstring(date)

Date when the legitimation data becomes invalid.

Example: "2025-12-31"
Response
application/json
{
  "id": "dc1a6812a14f6cc338cd084208535bcdcper",
  "salutation": "MR",
  "title": "DR",
  "first_name": "Peter",
  "last_name": "Mustermann",
  "address": {
    "line_1": "Musterstrasse",
    "line_2": "Musterstrasse",
    "postal_code": "10409",
    "city": "Berlin",
    "country": "DE",
    "state": "BE"
  },
  "contact_address": {
    "line_1": "Musterstrasse",
    "line_2": "Musterstrasse",
    "postal_code": "10409",
    "city": "Berlin",
    "country": "DE",
    "state": "BE"
  },
  "email": "person@example.com",
  "mobile_number": "49301234567",
  "birth_name": "Doe",
  "birth_date": "1972-12-24",
  "birth_city": "Berlin",
  "birth_country": "DE",
  "birth_province": "BE",
  "birth_post_code": "10233",
  "nationality": "DE",
  "employment_status": "FREELANCER",
  "job_title": "Head of everything",
  "tax_information": {
    "tax_assessment": "SEPARATE",
    "marital_status": "MARRIED"
  },
  "fatca_relevant": false,
  "fatca_crs_confirmed_at": "2017-01-01T00:00:00.000Z",
  "business_purpose": "helping people to find themselves",
  "industry": "OTHER_SERVICES",
  "industry_key": "EDUCATION",
  "terms_conditions_signed_at": "2017-01-01T00:00:00.000Z",
  "own_economic_interest_signed_at": "2017-01-01T00:00:00.000Z",
  "expected_monthly_revenue_cents": 20000,
  "vat_number": "DE123456789",
  "website_social_media": "http://social-network.com/my-company",
  "business_trading_name": "My Business",
  "nace_code": "I 56.30",
  "business_address_line_1": "StreetStrasse, 42",
  "business_address_line_2": "4th floor",
  "business_postal_code": "12345",
  "business_city": "Berlin",
  "business_country": "DE",
  "data_terms_signed_at": "2017-01-01T00:00:00.000Z",
  "annual_income_range": "RANGE_1",
  "branch": "DE",
  "main_income_source": "PUBLIC_SUBSIDIES",
  "purpose_of_account_opening": "DAILY_EXPENSES",
  "socioprofessional_category": "EMPLOYEES",
  "work_country": "IT",
  "work_province": "VE",
  "self_declared_as_pep": false,
  "international_operativity_expectation": [
    "AFRICA",
    "ASIA"
  ],
  "registration_number": "1234567890",
  "flagged_by_compliance": false,
  "screening_progress": "SCREENED_ACCEPTED",
  "aml_follow_up_date": "2017-01-15",
  "aml_confirmed_on": "2017-01-30",
  "risk_classification_status": "NORMAL_RISK",
  "customer_vetting_status": "NO_MATCH",
  "legitimation_valid_until": "2025-12-31"
}

Person mobile numbers

Operations

Person tax identifications

Operations

Person documents

Operations

Person language settings

Operations

Authorized persons

Operations