Persons (1.0)

Download OpenAPI specification:Download

Persons

Create a person

Creates a person resource for a new customer.
The mandatory data points you must provide when creating a person vary based on the country where you are opening the account. See the required data points guide for information about which data points are required for each country.
Important: Please collect the customer's tax residence country separately. Do not default to their residence country for their tax country.

Request
Security:
Request Body schema: application/json

The content of the request.

salutation
string

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

Enum: "MR" "MS"
title
string

The person's title.

Enum: "DR" "MAGISTER" "PROF" "PROF_DR"
first_name
string

The person's first name.

last_name
string

The person's last name.

object

The person's address.

object

The person's contact address.

email
string

The person's email.

mobile_number
string

Person mobile number: spaces, dashes, underscores, forward slashes are removed.

birth_name
string

The person's birth name.

birth_date
string

The person's birth date.

birth_city
string

The city in which the person was born.

birth_country
string

The country in which the person was born.

Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AO" "AQ" "AR" "AS" "AT" "AU" "AW" "AX" "AZ" "BA" "BB" "BD" "BE" "BF" "BG" "BH" "BI" "BJ" "BL" "BM" "BN" "BO" "BQ" "BR" "BS" "BT" "BV" "BW" "BY" "BZ" "CA" "CC" "CD" "CF" "CG" "CH" "CI" "CK" "CL" "CM" "CN" "CO" "CR" "CU" "CV" "CW" "CX" "CY" "CZ" "DE" "DJ" "DK" "DM" "DO" "DZ" "EC" "EE" "EG" "EH" "ER" "ES" "ET" "FI" "FJ" "FK" "FM" "FO" "FR" "GA" "GB" "GD" "GE" "GF" "GG" "GH" "GI" "GL" "GM" "GN" "GP" "GQ" "GR" "GS" "GT" "GU" "GW" "GY" "HK" "HM" "HN" "HR" "HT" "HU" "ID" "IE" "IL" "IM" "IN" "IO" "IQ" "IR" "IS" "IT" "JE" "JM" "JO" "JP" "KE" "KG" "KH" "KI" "KM" "KN" "KP" "KR" "KW" "KY" "KZ" "LA" "LB" "LC" "LI" "LK" "LR" "LS" "LT" "LU" "LV" "LY" "MA" "MC" "MD" "ME" "MF" "MG" "MH" "MK" "ML" "MM" "MN" "MO" "MP" "MQ" "MR" "MS" "MT" "MU" "MV" "MW" "MX" "MY" "MZ" "NA" "NC" "NE" "NF" "NG" "NI" "NL" "NO" "NP" "NR" "NU" "NZ" "OM" "PA" "PE" "PF" "PG" "PH" "PK" "PL" "PM" "PN" "PR" "PS" "PT" "PW" "PY" "QA" "RE" "RO" "RS" "RU" "RW" "SA" "SB" "SC" "SD" "SE" "SG" "SH" "SI" "SJ" "SK" "SL" "SM" "SN" "SO" "SR" "SS" "ST" "SV" "SX" "SY" "SZ" "TC" "TD" "TF" "TG" "TH" "TJ" "TK" "TL" "TM" "TN" "TO" "TR" "TT" "TV" "TW" "TZ" "UA" "UG" "UM" "US" "UY" "UZ" "VA" "VC" "VE" "VG" "VI" "VN" "VU" "WF" "WS" "XK" "YE" "YT" "ZA" "ZM" "ZW"
birth_province
string

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

birth_post_code
string

The postal code in which the person was born.

nationality
string

The person's nationality.

Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AO" "AQ" "AR" "AS" "AT" "AU" "AW" "AX" "AZ" "BA" "BB" "BD" "BE" "BF" "BG" "BH" "BI" "BJ" "BL" "BM" "BN" "BO" "BQ" "BR" "BS" "BT" "BV" "BW" "BY" "BZ" "CA" "CC" "CD" "CF" "CG" "CH" "CI" "CK" "CL" "CM" "CN" "CO" "CR" "CU" "CV" "CW" "CX" "CY" "CZ" "DE" "DJ" "DK" "DM" "DO" "DZ" "EC" "EE" "EG" "EH" "ER" "ES" "ET" "FI" "FJ" "FK" "FM" "FO" "FR" "GA" "GB" "GD" "GE" "GF" "GG" "GH" "GI" "GL" "GM" "GN" "GP" "GQ" "GR" "GS" "GT" "GU" "GW" "GY" "HK" "HM" "HN" "HR" "HT" "HU" "ID" "IE" "IL" "IM" "IN" "IO" "IQ" "IR" "IS" "IT" "JE" "JM" "JO" "JP" "KE" "KG" "KH" "KI" "KM" "KN" "KP" "KR" "KW" "KY" "KZ" "LA" "LB" "LC" "LI" "LK" "LR" "LS" "LT" "LU" "LV" "LY" "MA" "MC" "MD" "ME" "MF" "MG" "MH" "MK" "ML" "MM" "MN" "MO" "MP" "MQ" "MR" "MS" "MT" "MU" "MV" "MW" "MX" "MY" "MZ" "NA" "NC" "NE" "NF" "NG" "NI" "NL" "NO" "NP" "NR" "NU" "NZ" "OM" "PA" "PE" "PF" "PG" "PH" "PK" "PL" "PM" "PN" "PR" "PS" "PT" "PW" "PY" "QA" "RE" "RO" "RS" "RU" "RW" "SA" "SB" "SC" "SD" "SE" "SG" "SH" "SI" "SJ" "SK" "SL" "SM" "SN" "SO" "SR" "SS" "ST" "SV" "SX" "SY" "SZ" "TC" "TD" "TF" "TG" "TH" "TJ" "TK" "TL" "TM" "TN" "TO" "TR" "TT" "TV" "TW" "TZ" "UA" "UG" "UM" "US" "UY" "UZ" "VA" "VC" "VE" "VG" "VI" "VN" "VU" "WF" "WS" "XK" "YE" "YT" "ZA" "ZM" "ZW"
employment_status
string

The person's employment status.

Enum: "EMPLOYED" "UNEMPLOYED" "PUBLIC_SECTOR_EMPLOYEE" "PROFESSIONAL_SOLDIER" "FREELANCER" "HOUSEWORK" "APPRENTICE" "MANAGEMENT" "RETIRED" "STUDENT" "SELF_EMPLOYED" "MILITARY_OR_COMMUNITY_SERVICE"
job_title
string

The person's job title.

object
fatca_relevant
boolean

Indicates whether or not the person is FATCA relevant.

fatca_crs_confirmed_at
string

UTC timestamp from when the person confirmed their FATCA relevance.

business_purpose
string

The purpose of the person's freelance business.

industry
string

The industry in which the person works as a freelancer. 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" "HOLDING_COMPANIES" "HOUSING_COMPANIES" "INFORMATION_AND_COMMUNICATION" "INSTALMENT_CREDITS" "LEASING_OF_MOVABLE_OBJECTS" "LEATHER_TEXTILE_CLOTHES_INDUSTRY" "MANUFACTURE_DATA_PROC_EQUIPMENT_ELECTRIC_OPTICS" "MANUFACTURE_PLASTICS_RUBBER_GOODS" "MECHANICAL_ENGINEERING_VEHICLE_MANUFACTURING" "METAL_PRODUCTION_PROCESSING" "NONE" "OTHER_ECONOMIC_SERVICES" "OTHER_PROPERTY_MANAGEMENT" "OTHER_SERVICES" "POWER_WATER_SUPPLY_DISPOSAL_MINING" "SCIENTIFIC_TECHNICAL_CONSULTING_SERVICES" "STONE_SOIL_CERAMICS_GLASS" "TRADE_MAINTENANCE_AND_REPAIR_OF_VEHICLES" "TRANSPORT_AND_STORAGE_AND_NEWS_TRANSMISSION" "WOOD_PAPER_PRINT_INDUSTRY_FURNITURE_ETC" "NON_PROFIT_ORGANIZATION" "NON_MARKET_PRODUCERS" "ORGANIZATION_WITHOUT_ACQUIRING_HOUSE_BUILDING" "OTHER_INDUSTRY"
industry_key
string

The industry in which the person works as a freelancer. 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" "CAPITAL_HOLDING_COMPANY" "CIVIL_ENGINEERING" "COMPUTER_PROGRAMMING_CONSULTANCY_AND_RELATED_ACTIVITIES" "CONSTRUCTION_OF_BUILDINGS" "CREATIVE_ARTS_AND_ENTERTAINMENT_ACTIVITIES" "CROP_AND_ANIMAL_PRODUCTION_HUNTING_AND_RELATED_SERVICE_ACTIVITIES" "ECONOMICALLY_DEPENDENT_INDIVIDUALS" "EDUCATION" "ELECTRICITY_GAS_STEAM_AND_AIR_CONDITIONING_SUPPLY" "EMPLOYMENT_ACTIVITIES" "IMPORT_EXPORT_OF_RAW_MATERIALS_SUCH_AS_OIL_GAS_MINING_AND_EXPLOITATION" "INSURANCE_REINSURANCE_EXCEPT_PENSION_FUNDING" "FINANCIAL_LEASING" "FISHING_AND_AQUACULTURE" "FOOD_AND_BEVERAGE_SERVICE_ACTIVITIES" "FORESTRY_AND_LOGGING" "GAMBLING_AND_BETTING_ACTIVITIES" "HOLDING_COMPANIES_WITHOUT_MANAGEMENT_FUNCTION" "HUMAN_HEALTH_ACTIVITIES" "INFORMATION_SERVICE_ACTIVITIES" "LAND_TRANSPORT_AND_TRANSPORT_VIA_PIPELINES" "LEGAL_AND_ACCOUNTING_ACTIVITIES" "LIBRARIES_ARCHIVES_MUSEUMS_AND_OTHER_CULTURAL_ACTIVITIES" "MANAGEMENT_CONSULTANCY_ACTIVITIES" "MANUFACTURE_OF_BASIC_METALS" "MANUFACTURE_OF_BASIC_PHARMACEUTICAL_PRODUCTS_AND_PHARMACEUTICAL_PREPARATIONS" "MANUFACTURE_OF_BEVERAGES" "MANUFACTURE_OF_CHEMICALS_AND_CHEMICAL_PRODUCTS" "MANUFACTURE_OF_COKE_AND_REFINED_PETROLEUM_PRODUCTS" "MANUFACTURE_OF_COMPUTER_ELECTRONIC_AND_OPTICAL_PRODUCTS" "MANUFACTURE_OF_ELECTRICAL_EQUIPMENT" "MANUFACTURE_OF_FABRICATED_METAL_PRODUCTS_EXCEPT_MACHINERY_AND_EQUIPMENT" "MANUFACTURE_OF_FOOD_PRODUCTS" "MANUFACTURE_OF_FURNITURE" "MANUFACTURE_OF_LEATHER_AND_RELATED_PRODUCTS" "MANUFACTURE_OF_MACHINERY_AND_EQUIPMENT_N_E_C" "MANUFACTURE_OF_MOTOR_VEHICLES_TRAILERS_AND_SEMI_TRAILERS" "MANUFACTURE_OF_PRECIOUS_METALS_OR_STONES" "MANUFACTURE_OF_OTHER_TRANSPORT_EQUIPMENT" "MANUFACTURE_OF_PAPER_AND_PAPER_PRODUCTS" "MANUFACTURE_OF_RUBBER_AND_PLASTIC_PRODUCTS" "MANUFACTURE_OF_TEXTILES" "MANUFACTURE_OR_TRADE_OF_ALCOHOL_OR_CIGARETTES" "MANUFACTURE_OF_WEARING_APPAREL" "MANUFACTURE_OF_WOOD_AND_OF_PRODUCTS_OF_WOOD_AND_CORK_EXCEPT_FURNITURE_MANUFACTURE_OF_ARTICLES_OF_STRAW_AND_PLAITING_MATERIALS" "MINING_OF_COAL_AND_LIGNITE" "MINING_OF_METAL_ORES" "MOTION_PICTURE_VIDEO_AND_TELEVISION_PROGRAMME_PRODUCTION_SOUND_RECORDING_AND_MUSIC_PUBLISHING_ACTIVITIES" "NONE" "OFFICE_ADMINISTRATIVE_OFFICE_SUPPORT_AND_OTHER_BUSINESS_SUPPORT_ACTIVITIES" "OTHER_MANUFACTURING" "WHOLESALE_RETAIL_OF_PRECIOUS_METALS_OR_STONES" "OTHER_CREDIT_GRANTING" "OTHER_PERSONAL_SERVICE_ACTIVITIES" "OTHER_PROFESSIONAL_SCIENTIFIC_AND_TECHNICAL_ACTIVITIES" "OWN_ASSET_MANAGEMENT" "PENSION_FUNDING_EXCEPT_COMPULSORY_SOCIAL_SECURITY" "POSTAL_AND_COURIER_ACTIVITIES" "PRINTING_AND_REPRODUCTION_OF_RECORDED_MEDIA" "PROGRAMMING_AND_BROADCASTING_ACTIVITIES" "PUBLISHING_ACTIVITIES" "REMEDIATION_ACTIVITIES_AND_OTHER_WASTE_MANAGEMENT_SERVICES" "RENTAL_AND_LEASING_ACTIVITIES" "REPAIR_AND_INSTALLATION_OF_MACHINERY_AND_EQUIPMENT" "REPAIR_OF_COMPUTERS_AND_PERSONAL_AND_HOUSEHOLD_GOODS" "RESIDENTIAL_CARE_ACTIVITIES" "RETAIL_TRADE_EXCEPT_OF_MOTOR_VEHICLES_AND_MOTORCYCLES" "SCIENTIFIC_RESEARCH_AND_DEVELOPMENT" "SECURITY_AND_INVESTIGATION_ACTIVITIES" "SERVICES_TO_BUILDINGS_AND_LANDSCAPE_ACTIVITIES" "SEWERAGE" "SOCIAL_WORK_ACTIVITIES_WITHOUT_ACCOMMODATION" "SPECIALISED_CONSTRUCTION_ACTIVITIES" "SPORTS_ACTIVITIES_AND_AMUSEMENT_AND_RECREATION_ACTIVITIES" "TELECOMMUNICATIONS" "TRAVEL_AGENCY_TOUR_OPERATOR_AND_OTHER_RESERVATION_SERVICE_AND_RELATED_ACTIVITIES" "TRUSTS_FUNDS_AND_SIMILAR_FINANCIAL_ENTITIES" "VETERINARY_ACTIVITIES" "WAREHOUSING_AND_SUPPORT_ACTIVITIES_FOR_TRANSPORTATION" "WASTE_COLLECTION_TREATMENT_AND_DISPOSAL_ACTIVITIES_MATERIALS_RECOVERY" "WATER_COLLECTION_TREATMENT_AND_SUPPLY" "WATER_TRANSPORT" "WHOLESALE_AND_RETAIL_TRADE_AND_REPAIR_OF_MOTOR_VEHICLES_AND_MOTORCYCLES" "WHOLESALE_TRADE_EXCEPT_OF_MOTOR_VEHICLES_AND_MOTORCYCLES" "PRIVATE_NON_PROFIT_ORGANIZATIONS" "ACTIVITIES_AUXILIARY_TO_FINANCIAL_SERVICES_AND_INSURANCE_ACTIVITIES" "ADMINISTRATION_OF_THE_STATE_AND_THE_ECONOMIC_AND_SOCIAL_POLICY_OF_THE_COMMUNITY" "COMPULSORY_SOCIAL_SECURITY_ACTIVITIES" "OTHER_INDUSTRY_KE"
terms_conditions_signed_at
string

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

own_economic_interest_signed_at
string

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

expected_monthly_revenue_cents
integer

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

vat_number
string

(For freelancers) The person's VAT number.

website_social_media
string

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

business_trading_name
string

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

nace_code
string

(For freelancers) The NACE code that describes the industry in which the freelancer works.

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" "J 58.13" "J 58.14" "J 58.19" "J 58.21" "J 58.29" "J 59.11" "J 59.12" "J 59.13" "J 59.14" "J 59.20" "J 60.10" "J 60.20" "J 61.10" "J 61.20" "J 61.30" "J 61.90" "J 62.01" "J 62.02" "J 62.03" "J 62.09" "J 63.11" "J 63.12" "J 63.91" "J 63.99" "K 64.11" "K 64.19" "L 68.10" "L 68.20" "L 68.31" "L 68.32" "M 69.10" "M 69.20" "M 70.10" "M 70.21" "M 70.22" "M 71.11" "M 71.12" "M 71.20" "M 72.11" "M 72.19" "M 72.20" "M 73.11" "M 73.12" "M 73.20" "M 74.10" "M 74.20" "M 74.30" "M 74.90" "M 75.00" "N 77.11" "N 77.12" "N 77.21" "N 77.22" "N 77.29" "N 77.31" "N 77.32" "N 77.33" "N 77.34" "N 77.35" "N 77.39" "N 77.40" "N 78.10" "N 78.20" "N 78.30" "N 80.10" "N 80.20" "N 80.30" "N 81.10" "N 81.21" "N 81.22" "N 81.29" "N 81.30" "N 82.11" "N 82.19" "N 82.20" "N 82.30" "N 82.91" "N 82.92" "N 82.99" "P 85.10" "P 85.20" "P 85.31" "P 85.32" "P 85.41" "P 85.42" "P 85.51" "P 85.52" "P 85.53" "P 85.59" "P 85.60" "Q 86.10" "Q 86.21" "Q 86.22" "Q 86.23" "Q 86.90" "Q 87.10" "Q 87.20" "Q 87.30" "Q 87.90" "Q 88.10" "Q 88.91" "Q 88.99" "R 90.01" "R 90.02" "R 90.03" "R 90.04" "R 91.01" "R 91.02" "R 91.03" "R 91.04" "R 92.00" "R 93.11" "R 93.12" "R 93.13" "R 93.19" "R 93.21" "R 93.29" "S 94.11" "S 94.12" "S 94.20" "S 94.91" "S 94.92" "S 94.99" "S 96.01" "S 96.02" "S 96.03" "S 96.04" "S 96.09"
business_address_line_1
string

(For freelancers) Business address line 1

business_address_line_2
string

(For freelancers) Business address line 2

business_postal_code
string

(For freelancers) Business postal code

business_city
string

(For freelancers) Business city

business_country
string

(For freelancers) The person's business country.

Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AO" "AQ" "AR" "AS" "AT" "AU" "AW" "AX" "AZ" "BA" "BB" "BD" "BE" "BF" "BG" "BH" "BI" "BJ" "BL" "BM" "BN" "BO" "BQ" "BR" "BS" "BT" "BV" "BW" "BY" "BZ" "CA" "CC" "CD" "CF" "CG" "CH" "CI" "CK" "CL" "CM" "CN" "CO" "CR" "CU" "CV" "CW" "CX" "CY" "CZ" "DE" "DJ" "DK" "DM" "DO" "DZ" "EC" "EE" "EG" "EH" "ER" "ES" "ET" "FI" "FJ" "FK" "FM" "FO" "FR" "GA" "GB" "GD" "GE" "GF" "GG" "GH" "GI" "GL" "GM" "GN" "GP" "GQ" "GR" "GS" "GT" "GU" "GW" "GY" "HK" "HM" "HN" "HR" "HT" "HU" "ID" "IE" "IL" "IM" "IN" "IO" "IQ" "IR" "IS" "IT" "JE" "JM" "JO" "JP" "KE" "KG" "KH" "KI" "KM" "KN" "KP" "KR" "KW" "KY" "KZ" "LA" "LB" "LC" "LI" "LK" "LR" "LS" "LT" "LU" "LV" "LY" "MA" "MC" "MD" "ME" "MF" "MG" "MH" "MK" "ML" "MM" "MN" "MO" "MP" "MQ" "MR" "MS" "MT" "MU" "MV" "MW" "MX" "MY" "MZ" "NA" "NC" "NE" "NF" "NG" "NI" "NL" "NO" "NP" "NR" "NU" "NZ" "OM" "PA" "PE" "PF" "PG" "PH" "PK" "PL" "PM" "PN" "PR" "PS" "PT" "PW" "PY" "QA" "RE" "RO" "RS" "RU" "RW" "SA" "SB" "SC" "SD" "SE" "SG" "SH" "SI" "SJ" "SK" "SL" "SM" "SN" "SO" "SR" "SS" "ST" "SV" "SX" "SY" "SZ" "TC" "TD" "TF" "TG" "TH" "TJ" "TK" "TL" "TM" "TN" "TO" "TR" "TT" "TV" "TW" "TZ" "UA" "UG" "UM" "US" "UY" "UZ" "VA" "VC" "VE" "VG" "VI" "VN" "VU" "WF" "WS" "XK" "YE" "YT" "ZA" "ZM" "ZW"
data_terms_signed_at
string

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

annual_income_range
string

The person's annual income range.

Enum: "RANGE_1" "RANGE_2" "RANGE_3" "RANGE_4" "RANGE_5" "RANGE_6" "RANGE_7"
branch
string

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

Enum: "DE" "ES" "FR" "IT"
main_income_source
string

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"
purpose_of_account_opening
string

The person's purpose for opening the account.

Enum: "SAVINGS" "DAILY_EXPENSES" "TRAVELLING_AND_RELOCATING" "FREELANCER_ACTIVITY" "ONLINE_SHOPPING" "SALARY_OR_PENSION_ACCREDITATION" "TRADING"
socioprofessional_category
string

The person's socio-professional category.

Enum: "FARMERS" "CRAFTSMEN" "MERCHANTS_AND_COMPANY_MANAGERS" "MANAGERS_AND_HIGHER_INTELLECTUAL_PROFESSIONS" "INTERMEDIATE_PROFESSIONS" "EMPLOYEES" "WORKERS"
work_country
string

The person's country of work.

Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AO" "AQ" "AR" "AS" "AT" "AU" "AW" "AX" "AZ" "BA" "BB" "BD" "BE" "BF" "BG" "BH" "BI" "BJ" "BL" "BM" "BN" "BO" "BQ" "BR" "BS" "BT" "BV" "BW" "BY" "BZ" "CA" "CC" "CD" "CF" "CG" "CH" "CI" "CK" "CL" "CM" "CN" "CO" "CR" "CU" "CV" "CW" "CX" "CY" "CZ" "DE" "DJ" "DK" "DM" "DO" "DZ" "EC" "EE" "EG" "EH" "ER" "ES" "ET" "FI" "FJ" "FK" "FM" "FO" "FR" "GA" "GB" "GD" "GE" "GF" "GG" "GH" "GI" "GL" "GM" "GN" "GP" "GQ" "GR" "GS" "GT" "GU" "GW" "GY" "HK" "HM" "HN" "HR" "HT" "HU" "ID" "IE" "IL" "IM" "IN" "IO" "IQ" "IR" "IS" "IT" "JE" "JM" "JO" "JP" "KE" "KG" "KH" "KI" "KM" "KN" "KP" "KR" "KW" "KY" "KZ" "LA" "LB" "LC" "LI" "LK" "LR" "LS" "LT" "LU" "LV" "LY" "MA" "MC" "MD" "ME" "MF" "MG" "MH" "MK" "ML" "MM" "MN" "MO" "MP" "MQ" "MR" "MS" "MT" "MU" "MV" "MW" "MX" "MY" "MZ" "NA" "NC" "NE" "NF" "NG" "NI" "NL" "NO" "NP" "NR" "NU" "NZ" "OM" "PA" "PE" "PF" "PG" "PH" "PK" "PL" "PM" "PN" "PR" "PS" "PT" "PW" "PY" "QA" "RE" "RO" "RS" "RU" "RW" "SA" "SB" "SC" "SD" "SE" "SG" "SH" "SI" "SJ" "SK" "SL" "SM" "SN" "SO" "SR" "SS" "ST" "SV" "SX" "SY" "SZ" "TC" "TD" "TF" "TG" "TH" "TJ" "TK" "TL" "TM" "TN" "TO" "TR" "TT" "TV" "TW" "TZ" "UA" "UG" "UM" "US" "UY" "UZ" "VA" "VC" "VE" "VG" "VI" "VN" "VU" "WF" "WS" "XK" "YE" "YT" "ZA" "ZM" "ZW"
work_province
string

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

self_declared_as_pep
boolean

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

international_operativity_expectation
Array 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_number
string

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

Responses
201

Successful result of the operation

400

Invalid request.

403

You are not authorized to perform this action.

404

The resource could not be found.

500

Internal server error.

default

Unexpected error

post/v1/persons
Request samples
application/json
{
  • "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-24T00:00:00.000Z",
  • "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": true,
  • "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": "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"
}
Response samples
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",
  • "nationality": "DE",
  • "employment_status": "FREELANCER",
  • "job_title": "Head of everything",
  • "tax_information": {
    },
  • "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",
  • "terms_conditions_signed_at": "2017-01-01T00:00:00.000Z",
  • "own_economic_interest_signed_at": "2017-01-01T00:00:00.000Z",
  • "flagged_by_compliance": false,
  • "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",
  • "screening_progress": "SCREENED_ACCEPTED",
  • "data_terms_signed_at": "2017-01-01T00:00:00.000Z",
  • "aml_follow_up_date": "2017-01-15",
  • "aml_confirmed_on": "2017-01-30",
  • "annual_income_range": "RANGE_1",
  • "branch": "DE",
  • "work_country": "DE",
  • "work_province": "",
  • "self_declared_as_pep": false,
  • "international_operativity_expectation": [
    ],
  • "risk_classification_status": "NORMAL_RISK",
  • "customer_vetting_status": "NO_MATCH",
  • "registration_number": "1234567890",
  • "legitimation_valid_until": "2025-12-31"
}

Index persons

Returns an array containing all the persons you have created.

Request
Security:
query Parameters
page[number]
string

The number of results pages to return.

page[size]
string

The size of each page in the response.

sort
string
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.

Responses
200

Successful result of the operation

400

Invalid request.

403

You are not authorized to perform this action.

404

The resource could not be found.

500

Internal server error.

default

Unexpected error

get/v1/persons
Request samples
curl -i -X GET \
  'https://api.solaris-sandbox.de/v1/persons?page%5Bnumber%5D=string&page%5Bsize%5D=string&sort=string&filter%5Bfirst_name%5D=string&filter%5Blast_name%5D=string&filter%5Bbirth_date%5D=string&filter%5Bbirth_date%5D%5Bmin%5D=string&filter%5Bbirth_date%5D%5Bmax%5D=string'
Response samples
application/json
[
  • {
    }
]

Retrieve a person

Returns the person resource specified in the request URL.

Request
Security:
path Parameters
id
required
string
Responses
200

Successful result of the operation

400

Invalid request.

403

You are not authorized to perform this action.

404

The resource could not be found.

500

Internal server error.

default

Unexpected error

get/v1/persons/{id}
Request samples
curl -i -X GET \
  'https://api.solaris-sandbox.de/v1/persons/{id}'
Response samples
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",
  • "nationality": "DE",
  • "employment_status": "FREELANCER",
  • "job_title": "Head of everything",
  • "tax_information": {
    },
  • "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",
  • "terms_conditions_signed_at": "2017-01-01T00:00:00.000Z",
  • "own_economic_interest_signed_at": "2017-01-01T00:00:00.000Z",
  • "flagged_by_compliance": false,
  • "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",
  • "screening_progress": "SCREENED_ACCEPTED",
  • "data_terms_signed_at": "2017-01-01T00:00:00.000Z",
  • "aml_follow_up_date": "2017-01-15",
  • "aml_confirmed_on": "2017-01-30",
  • "annual_income_range": "RANGE_1",
  • "branch": "DE",
  • "work_country": "DE",
  • "work_province": "",
  • "self_declared_as_pep": false,
  • "international_operativity_expectation": [
    ],
  • "risk_classification_status": "NORMAL_RISK",
  • "customer_vetting_status": "NO_MATCH",
  • "registration_number": "1234567890",
  • "legitimation_valid_until": "2025-12-31"
}

Update a person

Updates one or more properties on a person resource. Note that this will trigger the change request process (unless the property being updated has a value of null).

Request
Security:
path Parameters
id
required
string
Request Body schema: application/json

The content of the request.

salutation
string

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

Enum: "MR" "MS"
title
string

The person's title.

Enum: "DR" "MAGISTER" "PROF" "PROF_DR"
first_name
string

The person's first name.

last_name
string

The person's last name.

object

The person's address.

object

The person's contact address.

email
string

The person's email.

mobile_number
string

Person mobile number: spaces, dashes, underscores, forward slashes are removed.

birth_name
string

The person's birth name.

birth_date
string

The person's birth date.

birth_city
string

The city in which the person was born.

birth_country
string

The country in which the person was born.

Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AO" "AQ" "AR" "AS" "AT" "AU" "AW" "AX" "AZ" "BA" "BB" "BD" "BE" "BF" "BG" "BH" "BI" "BJ" "BL" "BM" "BN" "BO" "BQ" "BR" "BS" "BT" "BV" "BW" "BY" "BZ" "CA" "CC" "CD" "CF" "CG" "CH" "CI" "CK" "CL" "CM" "CN" "CO" "CR" "CU" "CV" "CW" "CX" "CY" "CZ" "DE" "DJ" "DK" "DM" "DO" "DZ" "EC" "EE" "EG" "EH" "ER" "ES" "ET" "FI" "FJ" "FK" "FM" "FO" "FR" "GA" "GB" "GD" "GE" "GF" "GG" "GH" "GI" "GL" "GM" "GN" "GP" "GQ" "GR" "GS" "GT" "GU" "GW" "GY" "HK" "HM" "HN" "HR" "HT" "HU" "ID" "IE" "IL" "IM" "IN" "IO" "IQ" "IR" "IS" "IT" "JE" "JM" "JO" "JP" "KE" "KG" "KH" "KI" "KM" "KN" "KP" "KR" "KW" "KY" "KZ" "LA" "LB" "LC" "LI" "LK" "LR" "LS" "LT" "LU" "LV" "LY" "MA" "MC" "MD" "ME" "MF" "MG" "MH" "MK" "ML" "MM" "MN" "MO" "MP" "MQ" "MR" "MS" "MT" "MU" "MV" "MW" "MX" "MY" "MZ" "NA" "NC" "NE" "NF" "NG" "NI" "NL" "NO" "NP" "NR" "NU" "NZ" "OM" "PA" "PE" "PF" "PG" "PH" "PK" "PL" "PM" "PN" "PR" "PS" "PT" "PW" "PY" "QA" "RE" "RO" "RS" "RU" "RW" "SA" "SB" "SC" "SD" "SE" "SG" "SH" "SI" "SJ" "SK" "SL" "SM" "SN" "SO" "SR" "SS" "ST" "SV" "SX" "SY" "SZ" "TC" "TD" "TF" "TG" "TH" "TJ" "TK" "TL" "TM" "TN" "TO" "TR" "TT" "TV" "TW" "TZ" "UA" "UG" "UM" "US" "UY" "UZ" "VA" "VC" "VE" "VG" "VI" "VN" "VU" "WF" "WS" "XK" "YE" "YT" "ZA" "ZM" "ZW"
birth_province
string

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

birth_post_code
string

The postal code in which the person was born.

nationality
string

The person's nationality.

Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AO" "AQ" "AR" "AS" "AT" "AU" "AW" "AX" "AZ" "BA" "BB" "BD" "BE" "BF" "BG" "BH" "BI" "BJ" "BL" "BM" "BN" "BO" "BQ" "BR" "BS" "BT" "BV" "BW" "BY" "BZ" "CA" "CC" "CD" "CF" "CG" "CH" "CI" "CK" "CL" "CM" "CN" "CO" "CR" "CU" "CV" "CW" "CX" "CY" "CZ" "DE" "DJ" "DK" "DM" "DO" "DZ" "EC" "EE" "EG" "EH" "ER" "ES" "ET" "FI" "FJ" "FK" "FM" "FO" "FR" "GA" "GB" "GD" "GE" "GF" "GG" "GH" "GI" "GL" "GM" "GN" "GP" "GQ" "GR" "GS" "GT" "GU" "GW" "GY" "HK" "HM" "HN" "HR" "HT" "HU" "ID" "IE" "IL" "IM" "IN" "IO" "IQ" "IR" "IS" "IT" "JE" "JM" "JO" "JP" "KE" "KG" "KH" "KI" "KM" "KN" "KP" "KR" "KW" "KY" "KZ" "LA" "LB" "LC" "LI" "LK" "LR" "LS" "LT" "LU" "LV" "LY" "MA" "MC" "MD" "ME" "MF" "MG" "MH" "MK" "ML" "MM" "MN" "MO" "MP" "MQ" "MR" "MS" "MT" "MU" "MV" "MW" "MX" "MY" "MZ" "NA" "NC" "NE" "NF" "NG" "NI" "NL" "NO" "NP" "NR" "NU" "NZ" "OM" "PA" "PE" "PF" "PG" "PH" "PK" "PL" "PM" "PN" "PR" "PS" "PT" "PW" "PY" "QA" "RE" "RO" "RS" "RU" "RW" "SA" "SB" "SC" "SD" "SE" "SG" "SH" "SI" "SJ" "SK" "SL" "SM" "SN" "SO" "SR" "SS" "ST" "SV" "SX" "SY" "SZ" "TC" "TD" "TF" "TG" "TH" "TJ" "TK" "TL" "TM" "TN" "TO" "TR" "TT" "TV" "TW" "TZ" "UA" "UG" "UM" "US" "UY" "UZ" "VA" "VC" "VE" "VG" "VI" "VN" "VU" "WF" "WS" "XK" "YE" "YT" "ZA" "ZM" "ZW"
employment_status
string

The person's employment status.

Enum: "EMPLOYED" "UNEMPLOYED" "PUBLIC_SECTOR_EMPLOYEE" "PROFESSIONAL_SOLDIER" "FREELANCER" "HOUSEWORK" "APPRENTICE" "MANAGEMENT" "RETIRED" "STUDENT" "SELF_EMPLOYED" "MILITARY_OR_COMMUNITY_SERVICE"
job_title
string

The person's job title.

object
fatca_relevant
boolean

Indicates whether or not the person is FATCA relevant.

fatca_crs_confirmed_at
string

UTC timestamp from when the person confirmed their FATCA relevance.

business_purpose
string

The purpose of the person's freelance business.

industry
string

The industry in which the person works as a freelancer. 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" "HOLDING_COMPANIES" "HOUSING_COMPANIES" "INFORMATION_AND_COMMUNICATION" "INSTALMENT_CREDITS" "LEASING_OF_MOVABLE_OBJECTS" "LEATHER_TEXTILE_CLOTHES_INDUSTRY" "MANUFACTURE_DATA_PROC_EQUIPMENT_ELECTRIC_OPTICS" "MANUFACTURE_PLASTICS_RUBBER_GOODS" "MECHANICAL_ENGINEERING_VEHICLE_MANUFACTURING" "METAL_PRODUCTION_PROCESSING" "NONE" "OTHER_ECONOMIC_SERVICES" "OTHER_PROPERTY_MANAGEMENT" "OTHER_SERVICES" "POWER_WATER_SUPPLY_DISPOSAL_MINING" "SCIENTIFIC_TECHNICAL_CONSULTING_SERVICES" "STONE_SOIL_CERAMICS_GLASS" "TRADE_MAINTENANCE_AND_REPAIR_OF_VEHICLES" "TRANSPORT_AND_STORAGE_AND_NEWS_TRANSMISSION" "WOOD_PAPER_PRINT_INDUSTRY_FURNITURE_ETC" "NON_PROFIT_ORGANIZATION" "NON_MARKET_PRODUCERS" "ORGANIZATION_WITHOUT_ACQUIRING_HOUSE_BUILDING" "OTHER_INDUSTRY"
industry_key
string

The industry in which the person works as a freelancer. 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" "CAPITAL_HOLDING_COMPANY" "CIVIL_ENGINEERING" "COMPUTER_PROGRAMMING_CONSULTANCY_AND_RELATED_ACTIVITIES" "CONSTRUCTION_OF_BUILDINGS" "CREATIVE_ARTS_AND_ENTERTAINMENT_ACTIVITIES" "CROP_AND_ANIMAL_PRODUCTION_HUNTING_AND_RELATED_SERVICE_ACTIVITIES" "ECONOMICALLY_DEPENDENT_INDIVIDUALS" "EDUCATION" "ELECTRICITY_GAS_STEAM_AND_AIR_CONDITIONING_SUPPLY" "EMPLOYMENT_ACTIVITIES" "IMPORT_EXPORT_OF_RAW_MATERIALS_SUCH_AS_OIL_GAS_MINING_AND_EXPLOITATION" "INSURANCE_REINSURANCE_EXCEPT_PENSION_FUNDING" "FINANCIAL_LEASING" "FISHING_AND_AQUACULTURE" "FOOD_AND_BEVERAGE_SERVICE_ACTIVITIES" "FORESTRY_AND_LOGGING" "GAMBLING_AND_BETTING_ACTIVITIES" "HOLDING_COMPANIES_WITHOUT_MANAGEMENT_FUNCTION" "HUMAN_HEALTH_ACTIVITIES" "INFORMATION_SERVICE_ACTIVITIES" "LAND_TRANSPORT_AND_TRANSPORT_VIA_PIPELINES" "LEGAL_AND_ACCOUNTING_ACTIVITIES" "LIBRARIES_ARCHIVES_MUSEUMS_AND_OTHER_CULTURAL_ACTIVITIES" "MANAGEMENT_CONSULTANCY_ACTIVITIES" "MANUFACTURE_OF_BASIC_METALS" "MANUFACTURE_OF_BASIC_PHARMACEUTICAL_PRODUCTS_AND_PHARMACEUTICAL_PREPARATIONS" "MANUFACTURE_OF_BEVERAGES" "MANUFACTURE_OF_CHEMICALS_AND_CHEMICAL_PRODUCTS" "MANUFACTURE_OF_COKE_AND_REFINED_PETROLEUM_PRODUCTS" "MANUFACTURE_OF_COMPUTER_ELECTRONIC_AND_OPTICAL_PRODUCTS" "MANUFACTURE_OF_ELECTRICAL_EQUIPMENT" "MANUFACTURE_OF_FABRICATED_METAL_PRODUCTS_EXCEPT_MACHINERY_AND_EQUIPMENT" "MANUFACTURE_OF_FOOD_PRODUCTS" "MANUFACTURE_OF_FURNITURE" "MANUFACTURE_OF_LEATHER_AND_RELATED_PRODUCTS" "MANUFACTURE_OF_MACHINERY_AND_EQUIPMENT_N_E_C" "MANUFACTURE_OF_MOTOR_VEHICLES_TRAILERS_AND_SEMI_TRAILERS" "MANUFACTURE_OF_PRECIOUS_METALS_OR_STONES" "MANUFACTURE_OF_OTHER_TRANSPORT_EQUIPMENT" "MANUFACTURE_OF_PAPER_AND_PAPER_PRODUCTS" "MANUFACTURE_OF_RUBBER_AND_PLASTIC_PRODUCTS" "MANUFACTURE_OF_TEXTILES" "MANUFACTURE_OR_TRADE_OF_ALCOHOL_OR_CIGARETTES" "MANUFACTURE_OF_WEARING_APPAREL" "MANUFACTURE_OF_WOOD_AND_OF_PRODUCTS_OF_WOOD_AND_CORK_EXCEPT_FURNITURE_MANUFACTURE_OF_ARTICLES_OF_STRAW_AND_PLAITING_MATERIALS" "MINING_OF_COAL_AND_LIGNITE" "MINING_OF_METAL_ORES" "MOTION_PICTURE_VIDEO_AND_TELEVISION_PROGRAMME_PRODUCTION_SOUND_RECORDING_AND_MUSIC_PUBLISHING_ACTIVITIES" "NONE" "OFFICE_ADMINISTRATIVE_OFFICE_SUPPORT_AND_OTHER_BUSINESS_SUPPORT_ACTIVITIES" "OTHER_MANUFACTURING" "WHOLESALE_RETAIL_OF_PRECIOUS_METALS_OR_STONES" "OTHER_CREDIT_GRANTING" "OTHER_PERSONAL_SERVICE_ACTIVITIES" "OTHER_PROFESSIONAL_SCIENTIFIC_AND_TECHNICAL_ACTIVITIES" "OWN_ASSET_MANAGEMENT" "PENSION_FUNDING_EXCEPT_COMPULSORY_SOCIAL_SECURITY" "POSTAL_AND_COURIER_ACTIVITIES" "PRINTING_AND_REPRODUCTION_OF_RECORDED_MEDIA" "PROGRAMMING_AND_BROADCASTING_ACTIVITIES" "PUBLISHING_ACTIVITIES" "REMEDIATION_ACTIVITIES_AND_OTHER_WASTE_MANAGEMENT_SERVICES" "RENTAL_AND_LEASING_ACTIVITIES" "REPAIR_AND_INSTALLATION_OF_MACHINERY_AND_EQUIPMENT" "REPAIR_OF_COMPUTERS_AND_PERSONAL_AND_HOUSEHOLD_GOODS" "RESIDENTIAL_CARE_ACTIVITIES" "RETAIL_TRADE_EXCEPT_OF_MOTOR_VEHICLES_AND_MOTORCYCLES" "SCIENTIFIC_RESEARCH_AND_DEVELOPMENT" "SECURITY_AND_INVESTIGATION_ACTIVITIES" "SERVICES_TO_BUILDINGS_AND_LANDSCAPE_ACTIVITIES" "SEWERAGE" "SOCIAL_WORK_ACTIVITIES_WITHOUT_ACCOMMODATION" "SPECIALISED_CONSTRUCTION_ACTIVITIES" "SPORTS_ACTIVITIES_AND_AMUSEMENT_AND_RECREATION_ACTIVITIES" "TELECOMMUNICATIONS" "TRAVEL_AGENCY_TOUR_OPERATOR_AND_OTHER_RESERVATION_SERVICE_AND_RELATED_ACTIVITIES" "TRUSTS_FUNDS_AND_SIMILAR_FINANCIAL_ENTITIES" "VETERINARY_ACTIVITIES" "WAREHOUSING_AND_SUPPORT_ACTIVITIES_FOR_TRANSPORTATION" "WASTE_COLLECTION_TREATMENT_AND_DISPOSAL_ACTIVITIES_MATERIALS_RECOVERY" "WATER_COLLECTION_TREATMENT_AND_SUPPLY" "WATER_TRANSPORT" "WHOLESALE_AND_RETAIL_TRADE_AND_REPAIR_OF_MOTOR_VEHICLES_AND_MOTORCYCLES" "WHOLESALE_TRADE_EXCEPT_OF_MOTOR_VEHICLES_AND_MOTORCYCLES" "PRIVATE_NON_PROFIT_ORGANIZATIONS" "ACTIVITIES_AUXILIARY_TO_FINANCIAL_SERVICES_AND_INSURANCE_ACTIVITIES" "ADMINISTRATION_OF_THE_STATE_AND_THE_ECONOMIC_AND_SOCIAL_POLICY_OF_THE_COMMUNITY" "COMPULSORY_SOCIAL_SECURITY_ACTIVITIES" "OTHER_INDUSTRY_KE"
terms_conditions_signed_at
string

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

own_economic_interest_signed_at
string

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

expected_monthly_revenue_cents
integer

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

vat_number
string

(For freelancers) The person's VAT number.

website_social_media
string

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

business_trading_name
string

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

nace_code
string

(For freelancers) The NACE code that describes the industry in which the freelancer works.

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" "J 58.13" "J 58.14" "J 58.19" "J 58.21" "J 58.29" "J 59.11" "J 59.12" "J 59.13" "J 59.14" "J 59.20" "J 60.10" "J 60.20" "J 61.10" "J 61.20" "J 61.30" "J 61.90" "J 62.01" "J 62.02" "J 62.03" "J 62.09" "J 63.11" "J 63.12" "J 63.91" "J 63.99" "K 64.11" "K 64.19" "L 68.10" "L 68.20" "L 68.31" "L 68.32" "M 69.10" "M 69.20" "M 70.10" "M 70.21" "M 70.22" "M 71.11" "M 71.12" "M 71.20" "M 72.11" "M 72.19" "M 72.20" "M 73.11" "M 73.12" "M 73.20" "M 74.10" "M 74.20" "M 74.30" "M 74.90" "M 75.00" "N 77.11" "N 77.12" "N 77.21" "N 77.22" "N 77.29" "N 77.31" "N 77.32" "N 77.33" "N 77.34" "N 77.35" "N 77.39" "N 77.40" "N 78.10" "N 78.20" "N 78.30" "N 80.10" "N 80.20" "N 80.30" "N 81.10" "N 81.21" "N 81.22" "N 81.29" "N 81.30" "N 82.11" "N 82.19" "N 82.20" "N 82.30" "N 82.91" "N 82.92" "N 82.99" "P 85.10" "P 85.20" "P 85.31" "P 85.32" "P 85.41" "P 85.42" "P 85.51" "P 85.52" "P 85.53" "P 85.59" "P 85.60" "Q 86.10" "Q 86.21" "Q 86.22" "Q 86.23" "Q 86.90" "Q 87.10" "Q 87.20" "Q 87.30" "Q 87.90" "Q 88.10" "Q 88.91" "Q 88.99" "R 90.01" "R 90.02" "R 90.03" "R 90.04" "R 91.01" "R 91.02" "R 91.03" "R 91.04" "R 92.00" "R 93.11" "R 93.12" "R 93.13" "R 93.19" "R 93.21" "R 93.29" "S 94.11" "S 94.12" "S 94.20" "S 94.91" "S 94.92" "S 94.99" "S 96.01" "S 96.02" "S 96.03" "S 96.04" "S 96.09"
business_address_line_1
string

(For freelancers) Business address line 1

business_address_line_2
string

(For freelancers) Business address line 2

business_postal_code
string

(For freelancers) Business postal code

business_city
string

(For freelancers) Business city

business_country
string

(For freelancers) The person's business country.

Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AO" "AQ" "AR" "AS" "AT" "AU" "AW" "AX" "AZ" "BA" "BB" "BD" "BE" "BF" "BG" "BH" "BI" "BJ" "BL" "BM" "BN" "BO" "BQ" "BR" "BS" "BT" "BV" "BW" "BY" "BZ" "CA" "CC" "CD" "CF" "CG" "CH" "CI" "CK" "CL" "CM" "CN" "CO" "CR" "CU" "CV" "CW" "CX" "CY" "CZ" "DE" "DJ" "DK" "DM" "DO" "DZ" "EC" "EE" "EG" "EH" "ER" "ES" "ET" "FI" "FJ" "FK" "FM" "FO" "FR" "GA" "GB" "GD" "GE" "GF" "GG" "GH" "GI" "GL" "GM" "GN" "GP" "GQ" "GR" "GS" "GT" "GU" "GW" "GY" "HK" "HM" "HN" "HR" "HT" "HU" "ID" "IE" "IL" "IM" "IN" "IO" "IQ" "IR" "IS" "IT" "JE" "JM" "JO" "JP" "KE" "KG" "KH" "KI" "KM" "KN" "KP" "KR" "KW" "KY" "KZ" "LA" "LB" "LC" "LI" "LK" "LR" "LS" "LT" "LU" "LV" "LY" "MA" "MC" "MD" "ME" "MF" "MG" "MH" "MK" "ML" "MM" "MN" "MO" "MP" "MQ" "MR" "MS" "MT" "MU" "MV" "MW" "MX" "MY" "MZ" "NA" "NC" "NE" "NF" "NG" "NI" "NL" "NO" "NP" "NR" "NU" "NZ" "OM" "PA" "PE" "PF" "PG" "PH" "PK" "PL" "PM" "PN" "PR" "PS" "PT" "PW" "PY" "QA" "RE" "RO" "RS" "RU" "RW" "SA" "SB" "SC" "SD" "SE" "SG" "SH" "SI" "SJ" "SK" "SL" "SM" "SN" "SO" "SR" "SS" "ST" "SV" "SX" "SY" "SZ" "TC" "TD" "TF" "TG" "TH" "TJ" "TK" "TL" "TM" "TN" "TO" "TR" "TT" "TV" "TW" "TZ" "UA" "UG" "UM" "US" "UY" "UZ" "VA" "VC" "VE" "VG" "VI" "VN" "VU" "WF" "WS" "XK" "YE" "YT" "ZA" "ZM" "ZW"
data_terms_signed_at
string

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

annual_income_range
string

The person's annual income range.

Enum: "RANGE_1" "RANGE_2" "RANGE_3" "RANGE_4" "RANGE_5" "RANGE_6" "RANGE_7"
branch
string

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

Enum: "DE" "ES" "FR" "IT"
main_income_source
string

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"
purpose_of_account_opening
string

The person's purpose for opening the account.

Enum: "SAVINGS" "DAILY_EXPENSES" "TRAVELLING_AND_RELOCATING" "FREELANCER_ACTIVITY" "ONLINE_SHOPPING" "SALARY_OR_PENSION_ACCREDITATION" "TRADING"
socioprofessional_category
string

The person's socio-professional category.

Enum: "FARMERS" "CRAFTSMEN" "MERCHANTS_AND_COMPANY_MANAGERS" "MANAGERS_AND_HIGHER_INTELLECTUAL_PROFESSIONS" "INTERMEDIATE_PROFESSIONS" "EMPLOYEES" "WORKERS"
work_country
string

The person's country of work.

Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AO" "AQ" "AR" "AS" "AT" "AU" "AW" "AX" "AZ" "BA" "BB" "BD" "BE" "BF" "BG" "BH" "BI" "BJ" "BL" "BM" "BN" "BO" "BQ" "BR" "BS" "BT" "BV" "BW" "BY" "BZ" "CA" "CC" "CD" "CF" "CG" "CH" "CI" "CK" "CL" "CM" "CN" "CO" "CR" "CU" "CV" "CW" "CX" "CY" "CZ" "DE" "DJ" "DK" "DM" "DO" "DZ" "EC" "EE" "EG" "EH" "ER" "ES" "ET" "FI" "FJ" "FK" "FM" "FO" "FR" "GA" "GB" "GD" "GE" "GF" "GG" "GH" "GI" "GL" "GM" "GN" "GP" "GQ" "GR" "GS" "GT" "GU" "GW" "GY" "HK" "HM" "HN" "HR" "HT" "HU" "ID" "IE" "IL" "IM" "IN" "IO" "IQ" "IR" "IS" "IT" "JE" "JM" "JO" "JP" "KE" "KG" "KH" "KI" "KM" "KN" "KP" "KR" "KW" "KY" "KZ" "LA" "LB" "LC" "LI" "LK" "LR" "LS" "LT" "LU" "LV" "LY" "MA" "MC" "MD" "ME" "MF" "MG" "MH" "MK" "ML" "MM" "MN" "MO" "MP" "MQ" "MR" "MS" "MT" "MU" "MV" "MW" "MX" "MY" "MZ" "NA" "NC" "NE" "NF" "NG" "NI" "NL" "NO" "NP" "NR" "NU" "NZ" "OM" "PA" "PE" "PF" "PG" "PH" "PK" "PL" "PM" "PN" "PR" "PS" "PT" "PW" "PY" "QA" "RE" "RO" "RS" "RU" "RW" "SA" "SB" "SC" "SD" "SE" "SG" "SH" "SI" "SJ" "SK" "SL" "SM" "SN" "SO" "SR" "SS" "ST" "SV" "SX" "SY" "SZ" "TC" "TD" "TF" "TG" "TH" "TJ" "TK" "TL" "TM" "TN" "TO" "TR" "TT" "TV" "TW" "TZ" "UA" "UG" "UM" "US" "UY" "UZ" "VA" "VC" "VE" "VG" "VI" "VN" "VU" "WF" "WS" "XK" "YE" "YT" "ZA" "ZM" "ZW"
work_province
string

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

self_declared_as_pep
boolean

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

international_operativity_expectation
Array 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_number
string

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

Responses
200

Successful result of the operation

202

The request was accepted, and now the customer must confirm the change request.

400

Invalid request.

403

You are not authorized to perform this action.

404

The resource could not be found.

500

Internal server error.

default

Unexpected error

patch/v1/persons/{id}
Request samples
application/json
{
  • "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-24T00:00:00.000Z",
  • "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": true,
  • "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": "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"
}
Response samples
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",
  • "nationality": "DE",
  • "employment_status": "FREELANCER",
  • "job_title": "Head of everything",
  • "tax_information": {
    },
  • "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",
  • "terms_conditions_signed_at": "2017-01-01T00:00:00.000Z",
  • "own_economic_interest_signed_at": "2017-01-01T00:00:00.000Z",
  • "flagged_by_compliance": false,
  • "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",
  • "screening_progress": "SCREENED_ACCEPTED",
  • "data_terms_signed_at": "2017-01-01T00:00:00.000Z",
  • "aml_follow_up_date": "2017-01-15",
  • "aml_confirmed_on": "2017-01-30",
  • "annual_income_range": "RANGE_1",
  • "branch": "DE",
  • "work_country": "DE",
  • "work_province": "",
  • "self_declared_as_pep": false,
  • "international_operativity_expectation": [
    ],
  • "risk_classification_status": "NORMAL_RISK",
  • "customer_vetting_status": "NO_MATCH",
  • "registration_number": "1234567890",
  • "legitimation_valid_until": "2025-12-31"
}

Person mobile numbers

Create a mobile number for a person

Registers a new mobile number for a person. Please note the following:

  • Each customer may only have one mobile number at a time.
  • The customer cannot use their mobile number until they verify it using the POST Request authorization and POST Confirm endpoints.
  • The API removes spaces, dashes, underscores, and forward slashes from the mobile number value.

Request
Security:
path Parameters
person_id
required
string
query Parameters
with_identification
string
Request Body schema: application/json

The content of the request.

number
required
string

The mobile number to register for the person.

Responses
201

Successful result of the operation

400

Invalid request.

403

You are not authorized to perform this action.

404

The resource could not be found.

500

Internal server error.

default

Unexpected error

post/v1/persons/{person_id}/mobile_number
Request samples
application/json
{
  • "number": "+49301234567"
}
Response samples
application/json
{
  • "id": "303fd0bd4ad5f0f0e999ed0d9539792fcmno",
  • "number": "+49301234567",
  • "verified": false
}

Retrieve a person's mobile number

Returns information about a person's registered mobile number. Returns a 404 error if no mobile number has been registered.

Request
Security:
path Parameters
person_id
required
string
Responses
200

Successful result of the operation

400

Invalid request.

403

You are not authorized to perform this action.

404

The resource could not be found.

500

Internal server error.

default

Unexpected error

get/v1/persons/{person_id}/mobile_number
Request samples
curl -i -X GET \
  'https://api.solaris-sandbox.de/v1/persons/{person_id}/mobile_number'
Response samples
application/json
{
  • "id": "303fd0bd4ad5f0f0e999ed0d9539792fcmno",
  • "number": "+49301234567",
  • "verified": false
}

Deletes a person's mobile number

Removes a customer's registered mobile number.
If the request is successful and the mobile number has already been confirmed, then the API will trigger the change request process. The person who owns the mobile number will receive an SMS informing them that the number was deleted.
If the request is successful but the mobile number has not been verified, then the mobile number will be deleted without a change request.

Request
Security:
path Parameters
person_id
required
string
Request Body schema: application/json

The content of the request.

number
string

The mobile number to delete.

Responses
200

The request was successful (if the mobile number was not verified).

202

The request is accepted, and the customer must confirm the change request.

400

Invalid request.

403

You are not authorized to perform this action.

404

The resource could not be found.

500

Internal server error.

default

Unexpected error

delete/v1/persons/{person_id}/mobile_number
Request samples
application/json
{
  • "number": "+4930123123123"
}
Response samples
application/json
{
  • "id": "303fd0bd4ad5f0f0e999ed0d9539792fcmno",
  • "number": "+49301234567",
  • "verified": false
}

Request authorization for a person's mobile number

Requests an SMS OTP challenge to authorize a person's mobile number for use with 2FA.
The API will return a 404 error if no mobile number was previously created for the customer or if the number in the request does not match the customer's existing mobile number.
If the number has already been confirmed, then the API will return the confirmed mobile number.

Request
Security:
path Parameters
person_id
required
string
Request Body schema: application/json

The content of the request.

number
string

The mobile number to be authorized. The API will remove all whitespaces and the + character.

Responses
200

Successful result of the operation

400

Invalid request.

403

You are not authorized to perform this action.

404

The resource could not be found.

500

Internal server error.

default

Unexpected error

post/v1/persons/{person_id}/mobile_number/authorize
Request samples
application/json
{
  • "number": "+49301234567"
}
Response samples
application/json
{
  • "id": "303fd0bd4ad5f0f0e999ed0d9539792fcmno",
  • "number": "+49301234567",
  • "verified": false
}

Confirm a customer's mobile number

Submits the SMS OTP that the customer received on their mobile number to confirm it and authorize it for use with 2FA. The API will respond with a 403 error if the token has expired or if an invalid token is provided.

Request
Security:
path Parameters
person_id
required
string
Request Body schema: application/json

The content of the request.

number
string

The person's mobile number to be confirmed.

token
string

The six-digit OTP that the customer received at their mobile number.

Responses
200

Successful result of the operation

400

Invalid request.

403

You are not authorized to perform this action.

404

The resource could not be found.

500

Internal server error.

default

Unexpected error

post/v1/persons/{person_id}/mobile_number/confirm
Request samples
application/json
{
  • "number": "+49301234567",
  • "token": "666042"
}
Response samples
application/json
{
  • "id": "303fd0bd4ad5f0f0e999ed0d9539792fcmno",
  • "number": "+49301234567",
  • "verified": false
}

Reauthorize mobile number

Request a new authorization challenge for a person's mobile number to use with 2FA.

Request
Security:
path Parameters
person_id
required
string
Request Body schema: application/json

The content of the request.

authorization_text_key
string

Key that corresponds with the text to include in the message to the customer. The text will be automatically translated to the customer's preferred language. In this case, use sms.mobile_number.verify_number.

authorization_text_variables
object

Customer-specific variables to use in the text of the authorization message. In this case, use tan.

Responses
200

Successful result of the operation

400

Invalid request.

403

You are not authorized to perform this action.

404

The resource could not be found.

500

Internal server error.

default

Unexpected error

post/v1/persons/{person_id}/mobile_number/reauthorize
Request samples
application/json
{
  • "authorization_text_key": "sms.mobile_number.verify_number",
  • "authorization_text_variables": {
    }
}
Response samples
application/json
{
  • "id": "303fd0bd4ad5f0f0e999ed0d9539792fcmno",
  • "number": "+49301234567",
  • "verified": false
}

Person tax identifications

Create a tax identification for a person

Submits a tax identification for a person.
The first tax identification to be submitted for a person must be their primary tax identification. If you add another tax identification with the value of primary set to true, then the previous primary tax identification will become a secondary tax identification (i.e., its primary value will change to false).
You may only create one tax identification per country per customer.
Important: When creating a tax identification for a person, always collect the country value from the person separately from their residence country in your frontend. Do not default to the customer's physical residence (i.e., the country value of their person resource).

Request
Security:
path Parameters
person_id
required
string
Request Body schema: application/json

The content of the request.

number
string

Tax Identification Number (TIN). Must be left empty if reason_no_tin is provided.
Note: The Solaris API automatically validates the format of the supplied TIN based on the requirements for the customer's country. If the TIN does not follow the proper format, the API will return a 400 error.

country
string

The country that issued the customer's TIN. Use an ISO 3661 two-character code.

primary
boolean

Indicates whether the provided TIN is the customer's primary TIN (i.e., their primary tax residence).

reason_no_tin
string

Specifies the reason why the customer has not yet provided their TIN.

Enum: "NOT_ASSIGNED_BY_COUNTRY" "NOT_ASSIGNED_YET" "OTHER"
reason_description
string

Additional clarification around why the customer has not yet provided their TIN.

Responses
201

Successful result of the operation

400

Invalid request.

403

You are not authorized to perform this action.

404

The resource could not be found.

500

Internal server error.

default

Unexpected error

post/v1/persons/{person_id}/tax_identifications
Request samples
application/json
{
  • "number": "31659837651",
  • "country": "DE",
  • "primary": true
}
Response samples
application/json
{
  • "id": "cba4289c773b7450482ee88a6e5126e9ctin",
  • "country": "AD",
  • "number": "12345678901",
  • "primary": true,
  • "reason_no_tin": "NOT_ASSIGNED_YET",
  • "reason_description": "string",
  • "valid_until": "2019-08-24",
  • "tax_id_type": "NIE"
}

Index tax identifications for a person

Returns an array containing all of the given person's tax identifications.

Request
Security:
path Parameters
person_id
required
string
Responses
200

Successful result of the operation

400

Invalid request.

403

You are not authorized to perform this action.

404

The resource could not be found.

500

Internal server error.

default

Unexpected error

get/v1/persons/{person_id}/tax_identifications
Request samples
curl -i -X GET \
  'https://api.solaris-sandbox.de/v1/persons/{person_id}/tax_identifications'
Response samples
application/json
[
  • {
    }
]

Retrieve a person's tax identification

Returns the person tax identification specified in the request URL.

Request
Security:
path Parameters
person_id
required
string
id
required
string
Responses
200

Successful result of the operation

400

Invalid request.

403

You are not authorized to perform this action.

404

The resource could not be found.

500

Internal server error.

default

Unexpected error

get/v1/persons/{person_id}/tax_identifications/{id}
Request samples
curl -i -X GET \
  'https://api.solaris-sandbox.de/v1/persons/{person_id}/tax_identifications/{id}'
Response samples
application/json
{
  • "id": "cba4289c773b7450482ee88a6e5126e9ctin",
  • "country": "AD",
  • "number": "12345678901",
  • "primary": true,
  • "reason_no_tin": "NOT_ASSIGNED_YET",
  • "reason_description": "string",
  • "valid_until": "2019-08-24",
  • "tax_id_type": "NIE"
}

Update a person's tax identification

Modifies one or more properties of a person's tax identification.

Request
Security:
path Parameters
person_id
required
string
id
required
string
Request Body schema: application/json

The content of the request.

number
string

The person's tax identification number (TIN).

country
string

The country that issued the customer's TIN. Use an ISO 3661 two-character code.

primary
boolean

Specifies whether this is the customer's primary TIN.

reason_no_tin
string

Specifies the reason why the customer has not yet provided their TIN.

Enum: "NOT_ASSIGNED_BY_COUNTRY" "NOT_ASSIGNED_YET" "OTHER"
reason_description
string

Additional clarification around why the customer has not yet provided their TIN.

Responses
200

Successful result of the operation

400

Invalid request.

403

You are not authorized to perform this action.

404

The resource could not be found.

500

Internal server error.

default

Unexpected error

patch/v1/persons/{person_id}/tax_identifications/{id}
Request samples
application/json
{
  • "number": "31659837651",
  • "country": "DE",
  • "primary": true
}
Response samples
application/json
{
  • "id": "cba4289c773b7450482ee88a6e5126e9ctin",
  • "country": "AD",
  • "number": "12345678901",
  • "primary": true,
  • "reason_no_tin": "NOT_ASSIGNED_YET",
  • "reason_description": "string",
  • "valid_until": "2019-08-24",
  • "tax_id_type": "NIE"
}

Person documents

Create a document for a person

Uploads a document and links it to the person specified in the request URL.
Unlike most other endpoints, this request uses the content-type of multipart/form-data. You must submit the parameters as form-data items instead of a raw JSON body.
By default, uploaded documents are not accessible to customers (i.e., the customer_accessible value is set to false).

Request
Security:
path Parameters
person_id
required
string
Request Body schema: multipart/form-data
file
required
string <binary>

The binary file to upload.

document_type
required
string (Solaris-Decorators-DocumentTypeEnum)

The type of document.

Enum: "ACCOUNT_SNAPSHOT.FINTECSYSTEMS" "ACCOUNT_STATEMENT" "AML_POLICY" "ANNUAL_FINANCIAL_STATEMENT" "B2B_MANDATE" "BALANCE_REPORT" "BANK_REFERENCE" "BUSINESS_ASSESSMENT" "BUSINESS_FINANCIALS_XBRL" "CREDIT_RECORD.SCHUFA" "CUSTOMER_COMMUNICATION" "FOUNDATION_DOCUMENT" "IDENTIFICATION_ARCHIVE.IDNOW-SMAVA" "ID_DOCUMENT" "INVOICE" "KYC_BENEFICIAL_OWNER" "KYC_CORPORATE_DOCUMENT" "KYC_FORM" "KYC_LEGAL_REPRESENTATIVE" "KYC_RELIABILITY_CHECK" "KYC_REPORT" "LOAN_MANDATE_CONTRACT" "OTHER" "PAYMENT_CONFIRMATION" "PICTURE" "REFERENCE_LETTER" "REGISTER_APPLICATION" "REGISTER_EXTRACT" "SALARY_INFORMATION" "SCORE_CARD.SMAVA" "SCORE_CARD.SOLARIS" "SHAREHOLDERS_LIST" "SHARE_HOLDERS_AGREEMENT" "SCHUFA_COMPACT_REPORT" "SCHUFA_GWG_REPORT" "SCHUFA_FULL_REPORT" "SCHUFA_SHORT_REPORT" "CREDIT_AGENCY_REPORT" "SIGNATURE" "SIGNED_CONTRACT" "SIGNED_LOAN_MANDATE_CONTRACT" "TRADING_LICENSE" "TRANSACTIONAL_DOCUMENT" "TRANSFER_CANCELLATION" "VAT_CERTIFICATE" "VIDEO"
Responses
201

Successful result of the operation

400

Invalid request.

403

You are not authorized to perform this action.

404

The resource could not be found.

500

Internal server error.

default

Unexpected error

post/v1/persons/{person_id}/documents
Request samples
curl -i -X POST \
  'https://api.solaris-sandbox.de/v1/persons/{person_id}/documents' \
  -H 'Content-Type: multipart/form-data' \
  -F file=string \
  -F document_type=ACCOUNT_SNAPSHOT.FINTECSYSTEMS
Response samples
application/json
{
  • "id": "6bb6aea0c0c9058412cd43b0b58c3e92cdoc",
  • "name": "sample_pdf.pdf",
  • "content_type": "application/pdf",
  • "document_type": "SIGNED_CONTRACT",
  • "size": 3028,
  • "customer_accessible": false,
  • "created_at": "2022-04-22T16:06:05Z",
  • "deleted_at": "2023-04-22T16:06:05Z"
}

Index a person's documents

Returns an array containing all documents linked to the person specified in the request URL.

Request
Security:
path Parameters
person_id
required
string
query Parameters
page[number]
string

The number of results pages to return.

page[size]
string

The size of each page in the response.

customer_accessible
boolean

Use this parameter to return only the documents that the customer may access.

include_deleted
boolean

Use this parameter to include deleted documents in the results.

sort
string

Sorts the results by the date the document was created.

Value: "created_at"
Responses
200

Successful result of the operation

400

Invalid request.

403

You are not authorized to perform this action.

404

The resource could not be found.

500

Internal server error.

default

Unexpected error

get/v1/persons/{person_id}/documents
Request samples
curl -i -X GET \
  'https://api.solaris-sandbox.de/v1/persons/{person_id}/documents?page%5Bnumber%5D=string&page%5Bsize%5D=string&customer_accessible=true&include_deleted=true&sort=created_at'
Response samples
application/json
{
  • "id": "6bb6aea0c0c9058412cd43b0b58c3e92cdoc",
  • "name": "sample_pdf.pdf",
  • "content_type": "application/pdf",
  • "document_type": "SIGNED_CONTRACT",
  • "size": 3028,
  • "customer_accessible": false,
  • "created_at": "2022-04-22T16:06:05Z",
  • "deleted_at": "2023-04-22T16:06:05Z"
}

Download a document

Returns the binary file related to the document specified in the request URL.

Request
Security:
path Parameters
person_id
required
string
id
required
string
Responses
200

Successful result of the operation

400

Invalid request.

403

You are not authorized to perform this action.

404

The resource could not be found.

500

Internal server error.

default

Unexpected error

get/v1/persons/{person_id}/documents/{id}/file
Request samples
curl -i -X GET \
  'https://api.solaris-sandbox.de/v1/persons/{person_id}/documents/{id}/file'
Response samples
application/json
{
  • "date": "Sun, 13 Aug 2017 20:35:45 GMT",
  • "x-content-type-options": "nosniff",
  • "content-disposition": "attachment; filename=sample_pdf.pdf",
  • "content-length": "3028",
  • "x-request-id": "fbc2deff-8066-11e7-9271-02420a000109",
  • "content-type": "application/pdf"
}

Retrieve metadata about a document

Returns metadata about a person's document, including the filename and type.

Request
Security:
path Parameters
person_id
required
string
id
required
string
Responses
200

Successful result of the operation

400

Invalid request.

403

You are not authorized to perform this action.

404

The resource could not be found.

500

Internal server error.

default

Unexpected error

get/v1/persons/{person_id}/documents/{id}
Request samples
curl -i -X GET \
  'https://api.solaris-sandbox.de/v1/persons/{person_id}/documents/{id}'
Response samples
application/json
{
  • "id": "6bb6aea0c0c9058412cd43b0b58c3e92cdoc",
  • "name": "sample_pdf.pdf",
  • "content_type": "application/pdf",
  • "document_type": "SIGNED_CONTRACT",
  • "size": 3028,
  • "customer_accessible": false,
  • "created_at": "2022-04-22T16:06:05Z",
  • "deleted_at": "2023-04-22T16:06:05Z"
}

Update document attributes

Updates the document_type and/or customer_accessible attributes on a document.

Request
Security:
path Parameters
person_id
required
string
id
required
string
Request Body schema: application/json

The content of the request.

document_type
string (Solaris-Decorators-DocumentTypeEnum)

The type of document.

Enum: "ACCOUNT_SNAPSHOT.FINTECSYSTEMS" "ACCOUNT_STATEMENT" "AML_POLICY" "ANNUAL_FINANCIAL_STATEMENT" "B2B_MANDATE" "BALANCE_REPORT" "BANK_REFERENCE" "BUSINESS_ASSESSMENT" "BUSINESS_FINANCIALS_XBRL" "CREDIT_RECORD.SCHUFA" "CUSTOMER_COMMUNICATION" "FOUNDATION_DOCUMENT" "IDENTIFICATION_ARCHIVE.IDNOW-SMAVA" "ID_DOCUMENT" "INVOICE" "KYC_BENEFICIAL_OWNER" "KYC_CORPORATE_DOCUMENT" "KYC_FORM" "KYC_LEGAL_REPRESENTATIVE" "KYC_RELIABILITY_CHECK" "KYC_REPORT" "LOAN_MANDATE_CONTRACT" "OTHER" "PAYMENT_CONFIRMATION" "PICTURE" "REFERENCE_LETTER" "REGISTER_APPLICATION" "REGISTER_EXTRACT" "SALARY_INFORMATION" "SCORE_CARD.SMAVA" "SCORE_CARD.SOLARIS" "SHAREHOLDERS_LIST" "SHARE_HOLDERS_AGREEMENT" "SCHUFA_COMPACT_REPORT" "SCHUFA_GWG_REPORT" "SCHUFA_FULL_REPORT" "SCHUFA_SHORT_REPORT" "CREDIT_AGENCY_REPORT" "SIGNATURE" "SIGNED_CONTRACT" "SIGNED_LOAN_MANDATE_CONTRACT" "TRADING_LICENSE" "TRANSACTIONAL_DOCUMENT" "TRANSFER_CANCELLATION" "VAT_CERTIFICATE" "VIDEO"
customer_accessible
boolean

Flag that determine whether or not the customer may access the document.

Responses
200

Successful result of the operation

400

Invalid request.

403

You are not authorized to perform this action.

404

The resource could not be found.

500

Internal server error.

default

Unexpected error

patch/v1/persons/{person_id}/documents/{id}
Request samples
application/json
{
  • "document_type": "ACCOUNT_SNAPSHOT.FINTECSYSTEMS",
  • "customer_accessible": true
}
Response samples
application/json
{
  • "id": "6bb6aea0c0c9058412cd43b0b58c3e92cdoc",
  • "name": "sample_pdf.pdf",
  • "content_type": "application/pdf",
  • "document_type": "SIGNED_CONTRACT",
  • "size": 3028,
  • "customer_accessible": false,
  • "created_at": "2022-04-22T16:06:05Z",
  • "deleted_at": "2023-04-22T16:06:05Z"
}

Delete a document

Marks a document as deleted.

Request
Security:
path Parameters
person_id
required
string
id
required
string
Responses
202

Successful result of the operation

400

Invalid request.

403

You are not authorized to perform this action.

404

The resource could not be found.

500

Internal server error.

default

Unexpected error

delete/v1/persons/{person_id}/documents/{id}
Request samples
curl -i -X DELETE \
  'https://api.solaris-sandbox.de/v1/persons/{person_id}/documents/{id}'
Response samples
application/json
{
  • "id": "6bb6aea0c0c9058412cd43b0b58c3e92cdoc",
  • "name": "sample_pdf.pdf",
  • "content_type": "application/pdf",
  • "document_type": "SIGNED_CONTRACT",
  • "size": 3028,
  • "customer_accessible": false,
  • "created_at": "2022-04-22T16:06:05Z",
  • "deleted_at": "2023-04-22T16:06:05Z"
}

Upload documents for a person identification

Uploads an identification document for the person identification specified in the request URL. Note that this request uses the content-type of multipart/form-data and that the request body must be submitted as individual form-data items.

Request
Security:
path Parameters
person_id
required
string
id
required
string
Request Body schema: multipart/form-data
file
required
string <binary>

The binary file to upload.

document_type
required
string (Solaris-Decorators-DocumentTypeEnum)

The type of document.

Enum: "ACCOUNT_SNAPSHOT.FINTECSYSTEMS" "ACCOUNT_STATEMENT" "AML_POLICY" "ANNUAL_FINANCIAL_STATEMENT" "B2B_MANDATE" "BALANCE_REPORT" "BANK_REFERENCE" "BUSINESS_ASSESSMENT" "BUSINESS_FINANCIALS_XBRL" "CREDIT_RECORD.SCHUFA" "CUSTOMER_COMMUNICATION" "FOUNDATION_DOCUMENT" "IDENTIFICATION_ARCHIVE.IDNOW-SMAVA" "ID_DOCUMENT" "INVOICE" "KYC_BENEFICIAL_OWNER" "KYC_CORPORATE_DOCUMENT" "KYC_FORM" "KYC_LEGAL_REPRESENTATIVE" "KYC_RELIABILITY_CHECK" "KYC_REPORT" "LOAN_MANDATE_CONTRACT" "OTHER" "PAYMENT_CONFIRMATION" "PICTURE" "REFERENCE_LETTER" "REGISTER_APPLICATION" "REGISTER_EXTRACT" "SALARY_INFORMATION" "SCORE_CARD.SMAVA" "SCORE_CARD.SOLARIS" "SHAREHOLDERS_LIST" "SHARE_HOLDERS_AGREEMENT" "SCHUFA_COMPACT_REPORT" "SCHUFA_GWG_REPORT" "SCHUFA_FULL_REPORT" "SCHUFA_SHORT_REPORT" "CREDIT_AGENCY_REPORT" "SIGNATURE" "SIGNED_CONTRACT" "SIGNED_LOAN_MANDATE_CONTRACT" "TRADING_LICENSE" "TRANSACTIONAL_DOCUMENT" "TRANSFER_CANCELLATION" "VAT_CERTIFICATE" "VIDEO"
Responses
201

Successful result of the operation

400

Invalid request.

403

You are not authorized to perform this action.

404

The resource could not be found.

500

Internal server error.

default

Unexpected error

post/v1/persons/{person_id}/identifications/{id}/document_upload
Request samples
curl -i -X POST \
  'https://api.solaris-sandbox.de/v1/persons/{person_id}/identifications/{id}/document_upload' \
  -H 'Content-Type: multipart/form-data' \
  -F file=string \
  -F document_type=ACCOUNT_SNAPSHOT.FINTECSYSTEMS
Response samples
application/json
{
  • "id": "6bb6aea0c0c9058412cd43b0b58c3e92cdoc",
  • "name": "sample_pdf.pdf",
  • "content_type": "application/pdf",
  • "document_type": "SIGNED_CONTRACT",
  • "size": 3028,
  • "customer_accessible": false,
  • "created_at": "2022-04-22T16:06:05Z",
  • "deleted_at": "2023-04-22T16:06:05Z"
}

Index documents for a person identification

Returns all documents uploaded to the person identification specified in the request URL.

Request
Security:
path Parameters
person_id
required
string
id
required
string
query Parameters
page[number]
string

The number of results pages to return.

page[size]
string

The size of each page in the response.

Responses
200

Successful result of the operation

400

Invalid request.

403

You are not authorized to perform this action.

404

The resource could not be found.

500

Internal server error.

default

Unexpected error

get/v1/persons/{person_id}/identifications/{id}/documents
Request samples
curl -i -X GET \
  'https://api.solaris-sandbox.de/v1/persons/{person_id}/identifications/{id}/documents?page%5Bnumber%5D=string&page%5Bsize%5D=string'
Response samples
application/json
[
  • {
    }
]

Person language settings

Create a language setting for a person

Specifies the preferred communication language for the person specified in the request URL. Note that each call to this endpoint will overwrite the previous value.

Request
Security:
path Parameters
person_id
required
string
Request Body schema: application/json

The content of the request.

language
string

Two-character language identifier, formatted according to ISO 639-1.

Enum: "EN" "DE" "FR" "IT" "ES"
Responses
201

The operation was successful.

400

An error occurred on the client side.

404

The requested resource could not be found.

500

Internal server error.

default

Unexpected error

post/v1/persons/{person_id}/settings
Request samples
application/json
{
  • "language": "DE"
}
Response samples
application/json
{
  • "language": "DE"
}