Sign in
latestOpenAPI 3.0.12026-08-102923187.3 KB

3c9bae130f0a

Persons

Index persons

Returns an array containing all the persons you have created.

get/v1/persons

Query parameters

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.

Response

Successful result of the operation

idstring

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

salutation'MR' | 'MS'

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

title'DR' | 'MAGISTER' | 'PROF' | 'PROF_DR' | 'BOTSCH' | 'DIPL_PAD' | 'DIPL_BETRIEBSW' | 'DIPL_ING' | 'DIPL_KFFR' | 'DIPL_KFM' | 'DIPL_VOLKSW' | 'DR_DR' | 'DR_E_H' | 'DR_H_C' | 'DR_ING' | 'DR_ING_HAB' | 'MAG' | 'NOT' | 'PROF_DR_DR' | 'PROF_DR_H_C' | 'PROF_DR_ING' | 'PROF_ING' | 'RA_U_NOT' | 'RAE' | 'RA' | 'RA_DR'

The person's title.

first_namestring

The person's first name.

last_namestring

The person's last name.

emailstring

The person's email.

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.

birth_namestring

The person's birth name.

birth_datestring

The person's date of birth.

birth_citystring

The city in which the person was born.

birth_country'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'
nationalitystring

The customer's nationality.

employment_status'EMPLOYED' | 'UNEMPLOYED' | 'PUBLIC_SECTOR_EMPLOYEE' | 'PROFESSIONAL_SOLDIER' | 'FREELANCER' | 'HOUSEWORK' | 'APPRENTICE' | 'MANAGEMENT' | 'RETIRED' | 'STUDENT' | 'SELF_EMPLOYED' | 'MILITARY_OR_COMMUNITY_SERVICE'

The customer's employment status.

job_titlestring

The person's job title.

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.

business_purposestring

The purpose of the person's freelance business.

industry'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'

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

industry_key'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'

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

terms_conditions_signed_atstring

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

own_economic_interest_signed_atstring date-time

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

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.

vat_numberstring

(For freelancers) The person's VAT number.

website_social_mediastring

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

business_trading_namestring

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

nace_code'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' | 'K 66.22' | 'L 68.2' | '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_1string

(For freelancers) Business address line 1

business_address_line_2string

(For freelancers) Business address line 2

business_postal_codestring

(For freelancers) Business postal code

business_citystring

(For freelancers) Business city

business_country'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'
screening_progress'NOT_SCREENED' | 'POTENTIAL_MATCH' | 'SCREENED_ACCEPTED' | 'SCREENED_DECLINED'

The status of the person screening process.

annual_income_range'RANGE_1' | 'RANGE_2' | 'RANGE_3' | 'RANGE_4' | 'RANGE_5' | 'RANGE_6' | 'RANGE_7'

The person's annual income range.

data_terms_signed_atstring date-time

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

aml_follow_up_datestring date

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

aml_confirmed_onstring date

The confirmation date of the anti-money laundering department.

self_declared_as_pepboolean

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

international_operativity_expectationstring[]

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

registration_numberstring

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

risk_classification_status'NOT_SCORED' | 'POTENTIAL_RISK' | 'NORMAL_RISK' | 'INFORMATION_REQUESTED' | 'INFORMATION_RECEIVED' | 'RISK_ACCEPTED' | 'RISK_REJECTED' | 'CUSTOMER_UNRESPONSIVE' | 'SCORING_NOT_REQUIRED'

The status of the person's risk classification.

customer_vetting_status'NOT_VETTED' | 'NO_MATCH' | 'POTENTIAL_MATCH' | 'INFORMATION_REQUESTED' | 'INFORMATION_RECEIVED' | 'RISK_ACCEPTED' | 'RISK_REJECTED' | 'CUSTOMER_UNRESPONSIVE' | 'VETTING_NOT_REQUIRED'

The status of the person's vetting process.

legitimation_valid_untilstring date

Date when the legitimation data becomes invalid.

Example response

[
  {
    "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"
  }
]