Skip to content
/AML follow-up

Compliance features (1.0)

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

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

AML follow-up

Operations

(Sandbox only) Update person's AML follow-up date

Request

Updates the AML follow-up date for a person. Only available on Sandbox for testing purposes.

Path
idstringrequired
Bodyapplication/json

The content of the request

aml_follow_up_datestring

A new AML follow-up date for the person.

Example: "2021-09-27T00:00:00.000Z"
aml_confirmed_onstring

A new AML confirmed on date for the person.

Example: "2021-07-27T00:00:00.000Z"
birth_citystring

A new birth_city for the person.

Example: "Berlin"
application/json
{
  "aml_follow_up_date": "2021-09-27T00:00:00.000Z",
  "aml_confirmed_on": "2021-07-27T00:00:00.000Z",
  "birth_city": "Berlin"
}

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

The country in which the person was born.

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

The business' industry. This field is deprecated; please use nace_code instead.

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

Additional information about the industry in which the business operates. This field is deprecated; please use nace_code instead.

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

(For freelancers) The NACE code that describes the industry in which the freelancer works. For a list of values to implement in your site, check this site.

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

(For freelancers) The person's business country.

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"
}

Testing endpoints for Postbox API

Operations

Postbox Items

Operations

Postbox Confirmations

Operations

Questions and Answers

Operations

Terms and Conditions events

Operations