Businesses (1.0)

Download OpenAPI specification:Download

Businesses

Create a business

Creates a new business resource. The mandatory data points you must provide when creating a business vary based on the country where you are opening the account. See the onboarding requirements guide guide for information about which data points are required for each country.

Request
Security:
Request Body schema: application/json

The content of the request.

name
string

The name of the business. Limited to 255 characters.

sector
string

The sector of the business. Please note that the business' tax_country determines the allowed values you may store in the sector property, and the value of sector determines the allowed values you may store in the legal_form and industry/nace_code properties.

Enum: "ECONOMICALLY_SELF_EMPLOYED" "ECONOMIC_DEPENDENT" "FOREIGN_COMPANIES" "FOREIGN_ECONOMIC_DEPENDENT" "FOREIGN_PRIVATE_INDIVIDUAL" "FOREIGN_SELF_EMPLOYED_PRIVATE_PERSON" "GERMAN_BANKS" "MUNICIPALITY_AND_MUNICIPALITY_ASSOCIATION" "OTHER_COMPANIES_WORKMAN" "OTHER_COMPANIES" "OTHER_PRIVATE_INDIVIDUAL"
industry
string (Solaris-Decorators-IndustryEnum)

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" "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 (Solaris-Decorators-IndustryKeyEnum)

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" "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"
legal_form
string (Solaris-Decorators-BusinessLegalFormEnum)

The business' legal form. Check the Onboarding requirements guide for the mapping between legal form and tax country.

Enum: "AT_SE" "AT_OHG" "AT_KG" "AT_AG" "AT_GESMBH" "AT_EG" "AT_GBR" "AT_EV" "AT_SOLE_PROPRIETORSHIP" "AT_SELF_EMPLOYED" "AT_AMT" "AT_KOR" "AT_STIFTUNGEN" "AT_GMBH" "AT_GMBH_CO_KG" "BE_SNC" "BE_SCS" "BE_SA" "BE_SPRL" "BE_SE" "BE_SCA" "BE_SC" "BE_SCRI" "BE_SEP" "BE_SF" "BE_SPRLU" "BE_SOLE_PROPRIETORSHIP" "BE_SELF_EMPLOYED" "BG_AD" "BG_OOD" "BG_KDA" "BG_KD" "BG_SD" "BG_SELF_EMPLOYED" "BG_SOLE_PROPRIETORSHIP" "HR_DD" "HR_DOO" "HR_JDOO" "HR_KD" "HR_JTD" "HR_SELF_EMPLOYED" "HR_SOLE_PROPRIETORSHIP" "HR_ORTA" "CZ_AS" "CZ_SRO" "CZ_KS" "CZ_VOS" "CZ_DRUZSTVO" "CZ_FYZICKA_OSOBA" "CZ_SOLE_PROPRIETORSHIP" "CZ_SELF_EMPLOYED" "FR_AE" "FR_EI" "FR_SNC" "FR_SCS" "FR_SA" "FR_SAS" "FR_SARL" "FR_SE" "FR_SCA" "FR_EURL" "FR_SC" "FR_SCOP" "FR_SELARL" "FR_SOLE_PROPRIETORSHIP" "FR_SELF_EMPLOYED" "AG" "EG" "EK" "EV" "NEV" "GBR" "GMBH" "GMBH_CO_KG" "GMBH_I_GR" "KG" "KGAA" "LTD" "MUNICIPALITY" "MUNICIPAL_COMPANY" "NONE" "OHG" "PARTG" "PRIVATE_PERSON" "SAVINGS_BANK" "SE" "SELF_EMPLOYED" "SOLE_PROPRIETORSHIP" "UG" "UG_I_GR" "FOREIGN_CORPORATION" "ADOR" "AMT" "KDOR" "STIFTUNGEN" "SECOKG" "AGCOKG" "HU_NYRT" "HU_KFT" "HU_BT" "HU_KKT" "HU_SOLE_PROPRIETORSHIP" "HU_SELF_EMPLOYED" "HU_ORTA" "IT_SE" "IT_SNC" "IT_SAS" "IT_SPA" "IT_SRL" "IT_SAPA" "IT_SCPA" "IT_SCARL" "IT_SCOP" "IT_SS" "IT_SOLE_PROPRIETORSHIP" "IT_SELF_EMPLOYED" "LU_SNC" "LU_SCS" "LU_SA" "LU_SARL" "LU_SE" "LU_SCA" "LU_SCSP" "LU_SARLS" "LU_SC" "LU_SCOP" "LU_SOLE_PROPRIETORSHIP" "LU_SELF_EMPLOYED" "LU_SECA" "LU_ASBL" "LU_FON" "LU_SP" "PL_SA" "PL_SPZOO" "PL_SE" "PL_SKA" "PL_SPK" "PL_SPJ" "PL_SELF_EMPLOYED" "PL_OTHER" "PT_SNC" "PT_SC" "PT_SA" "PT_LDA" "PT_SE" "PT_SUNI" "PT_EIRL" "PT_SCIV" "PT_COP" "PT_SOLE_PROPRIETORSHIP" "PT_SELF_EMPLOYED" "RO_SA" "RO_SRL" "RO_SCA" "RO_SCS" "RO_SNC" "RO_SELF_EMPLOYED" "RO_SOLE_PROPRIETORSHIP" "RS_AD" "RS_DOO" "RS_KD" "RS_OD" "RS_SELF_EMPLOYED" "RS_SOLE_PROPRIETORSHIP" "SI_DD" "SI_DOO" "SI_KDD" "SI_KD" "SI_DNO" "SI_SELF_EMPLOYED" "SI_SOLE_PROPRIETORSHIP" "ES_SRC" "ES_SC" "ES_SA" "ES_SAS" "ES_SRL" "ES_SE" "ES_SCA" "ES_SLNE" "ES_SAU" "ES_SLU" "ES_SPRO" "ES_SCOP" "ES_SOLE_PROPRIETORSHIP" "ES_SELF_EMPLOYED" "CH_DE_AG" "CH_FR_SA" "CH_IT_SA" "CH_DE_GMBH" "CH_FR_SARL" "CH_IT_SAGL" "CH_SE" "CH_DE_KOMAG" "CH_FR_SCA" "CH_IT_SACA" "CH_DE_KG" "CH_FR_SCM" "CH_IT_SAC" "CH_DE_KIG" "CH_FR_SNC" "CH_IT_SNC" "CH_DE_EG" "CH_FR_SS" "CH_IT_SS" "CH_SELF_EMPLOYED" "CH_SOLE_PROPRIETORSHIP" "CH_DE_KMG" "NL_VOF" "NL_CV" "NL_NV" "NL_BV" "NL_SE" "NL_CVOA" "NL_COPV" "NL_MTS" "NL_SOLE_PROPRIETORSHIP" "NL_SELF_EMPLOYED" "NL_VERENIGING" "NL_STICHT" "TR_ADI_SIR" "TR_AS" "TR_LS" "TR_KOM_STI" "TR_KOLL_STI" "TR_SELF_EMPLOYED" "TR_SOLE_PROPRIETORSHIP" "GB_SE" "GB_PARTNERSHIP" "GB_LP" "GB_PLC" "GB_LTD" "GB_COPS" "GB_UAS" "GB_PRCU" "GB_PUCU" "GB_SOLE_PROPRIETORSHIP" "GB_SELF_EMPLOYED"
foundation_date
string

The date when the business was founded.

object

The business' address.

object

The business' tax information.

fatca_relevant
boolean

Indicates whether or not the company is FATCA relevant.

fatca_crs_confirmed_at
string

UTC timestamp when the business confirmed whether or not they were FATCA relevant.

crs_company_type
string

The business' Common Reporting Standard (CRS) company type.

Enum: "FE_REPORTING" "FE_NON_REPORTING" "NFE_ACTIVE" "NFE_ACTIVE_OTHER" "NFE_PASSIVE" "NFE_PASSIVE_INVESTMENT"
balance_sheet_total
integer

The business' total assets, in Euro cents.

number_employees
integer

The number of employees at the business.

registration_type
string

The business' registration type.

Enum: "AT_FB_CD" "AT_GEM_CD" "AT_IDENT_CD" "AT_LAE_CD" "AT_ZVR_CD" "BE_OND_CD" "BG_BULSTAT_CD" "BG_OTHER_CD" "BG_UIC_CD" "BG_VAT_CD" "CY_DRCOR_CD" "CY_NOTAP_CD" "CY_TIC_CD" "CY_VAT_CD" "CZ_ICO_CD" "CZ_NID_CD" "DE_GNR_CD" "DE_HRA_CD" "DE_HRB_CD" "DE_NOTAP_CD" "DE_PR_CD" "DE_VR_CD" "DK_CVR_CD" "DK_FT_CD" "DK_NOTAP_CD" "EE_FON_CD" "EE_RG_CD" "ES_NIF_CD" "FI_ALV_CD" "FI_NOTAP_CD" "FI_SIRA_CD" "FI_Y_CD" "FR_CIB" "FR_SIREN_CD" "GEN_IPF_CD" "GEN_NBR_ENTTY_CD" "GEN_NCB_ENTTY_CD" "GEN_NSA_ENTTY_CD" "GEN_NSI_ENTTY_CD" "GEN_OTHER_CD" "GEN_PS_CD" "GEN_TAX_CD" "GEN_TRD_RGSTR_ENTTY_CD" "GEN_VAT_CD" "GR_AFM_CD" "GR_IMO_CD" "HR_MB_CD" "HR_MBS_CD" "HR_OIB_CD" "HU_CEG_CD" "HU_FB_CD" "HU_KOZ_CD" "HU_TOR_CD" "IE_CRO_CD" "IE_VAT_CD" "IT_CCIAA_CD" "IT_CF_CD" "IT_UCITS_CD" "LT_INV_CD" "LT_JAR_CD" "LU_RSC_CD" "LV_FON_CD" "LV_NBR_CD" "LV_VAT_CD" "MT_CNUM_CD" "MT_OLE_CD" "MT_VAT_CD" "NL_KVK_CD" "NL_RSIN_CD" "PL_KRS_CD" "PL_NIP_CD" "PL_REGON_CD" "PL_VAT_CD" "PT_FSA_CD" "PT_NIF_CD" "RO_CUI_CD" "RO_TAX_CD" "RO_TRN_CD" "SE_FIN_CD" "SE_MOM_CD" "SE_ORG_CD" "SI_DAV_CD" "SI_DDV_CD" "SI_MAT_CD" "SK_ICO_CD"
registration_district
string

(For German businesses only) The district where the business is registered.

Enum: "AACHEN" "ALTENBURG" "AMBERG" "ANSBACH" "APOLDA" "ARNSBERG" "ARNSTADT" "ARNSTADT_ZWEIGSTELLE_ILMENAU" "ASCHAFFENBURG" "AUGSBURG" "AURICH" "BAD_HERSFELD" "BAD_HOMBURG_VDH" "BAD_KREUZNACH" "BAD_OEYNHAUSEN" "BAD_SALZUNGEN" "BAMBERG" "BAYREUTH" "BERLIN_CHARLOTTENBURG" "BIELEFELD" "BOCHUM" "BONN" "BRAUNSCHWEIG" "BREMEN" "CHEMNITZ" "COBURG" "COESFELD" "COTTBUS" "DARMSTADT" "DEGGENDORF" "DORTMUND" "DRESDEN" "DUISBURG" "DUEREN" "DUESSELDORF" "EISENACH" "ERFURT" "ESCHWEGE" "ESSEN" "FLENSBURG" "FRANKFURT_AM_MAIN" "FRANKFURT_ODER" "FREIBURG" "FRIEDBERG" "FRITZLAR" "FULDA" "FUERTH" "GELSENKIRCHEN" "GERA" "GIESSEN" "GOTHA" "GOETTINGEN" "GREIFSWALD" "GREIZ" "GUESTROW" "GUETERSLOH" "HAGEN" "HAMBURG" "HAMM" "HANAU" "HANNOVER" "HEILBAD_HEILIGENSTADT" "HILDBURGHAUSEN" "HILDESHEIM" "HOF" "HOMBURG" "INGOLSTADT" "ISERLOHN" "JENA" "KAISERSLAUTERN" "KASSEL" "KEMPTEN_ALLGAUE" "KIEL" "KLEVE" "KOBLENZ" "KOELN" "KOENIGSTEIN" "KORBACH" "KREFELD" "LANDAU" "LANDSHUT" "LEBACH" "LEIPZIG" "LEMGO" "LIMBURG" "LUEBECK" "LUDWIGSHAFEN_A_RHEIN_LUDWIGSHAFEN" "LUDWIGSLUST" "LUENEBURG" "MAINZ" "MANNHEIM" "MARBURG" "MEININGEN" "MEMMINGEN" "MERZIG" "MOENCHENGLADBACH" "MONTABAUR" "MUEHLHAUSEN" "MUENCHEN" "MUENSTER" "NEUBRANDENBURG" "NEUNKIRCHEN" "NEURUPPIN" "NEUSS" "NORDHAUSEN" "NUERNBERG" "OFFENBACH_AM_MAIN" "OLDENBURG_OLDENBURG" "OSNABRUECK" "OTTWEILER" "PADERBORN" "PASEWALK" "PASSAU" "PINNEBERG" "POESSNECK" "POESSNECK_ZWEIGSTELLE_BAD_LOBENSTEIN" "POTSDAM" "RECKLINGHAUSEN" "REGENSBURG" "RIBNITZ_DAMGARTEN" "ROSTOCK" "RUDOLSTADT" "RUDOLSTADT_ZWEIGSTELLE_SAALFELD" "SAARBRUECKEN" "SAARLOUIS" "SCHWEINFURT" "SCHWERIN" "SIEGBURG" "SIEGEN" "SOEMMERDA" "SONDERSHAUSEN" "SONNEBERG" "ST_INGBERT_ST_INGBERT" "ST_WENDEL_ST_WENDEL" "STADTHAGEN" "STADTRODA" "STEINFURT" "STENDAL" "STRALSUND" "STRAUBING" "STUTTGART" "SUHL" "TOSTEDT" "TRAUNSTEIN" "ULM" "VOELKLINGEN" "WALSRODE" "WAREN_MUERITZ" "WEIDEN_ID_OPF" "WEIMAR" "WETZLAR" "WIESBADEN" "WISMAR" "WITTLICH" "WUPPERTAL" "WUERZBURG" "ZWEIBRUECKEN"
business_purpose
string

Short summary of the purpose of the business. May also include the business' web address.

terms_conditions_signed_at
string

UTC timestamp when the business signed the Solaris Terms and Conditions.

vat_number
string

The business' VAT number.

website_social_media
string

The business' website or social media accounts.

branch
string

(If creating a non-German branching account) The country where the branching account should be created.

Enum: "DE" "FR" "ES" "IT"
international_operativity_expectation
Array of strings

Regions where the business expects to operate.

Items Enum: "AFRICA" "ASIA" "MIDDLE_EAST" "NORTH_AMERICA" "SOUTH_AMERICA" "NATIONAL_ACTIVITY_ONLY"
purpose_of_account_opening
string

The business' purpose for opening the account.

Enum: "SAVINGS" "DAILY_EXPENSES" "TRAVELLING_AND_RELOCATING" "FREELANCER_ACTIVITY" "ONLINE_SHOPPING" "SALARY_OR_PENSION_ACCREDITATION" "TRADING" "FINANCING" "BUYING_AND_SELLING_GOODS" "MANAGEMENT_OF_INVOICES_AND_RECEIPTS" "TREASURY" "SUPPLIERS_MANAGEMENT" "SETTLEMENT_OF_TRANSACTIONS_TO_AND_FROM_ABROAD" "INVESTMENT_ACTIVITY" "EMPLOYEE_PAYROLL_MANAGEMENT"
source_of_funds
string

The business' source of funds.

Enum: "REAL_ESTATE_INCOME" "SALE_OF_GOODS_AND_SERVICES" "TRANSFER_FROM_DIFFERENT_ACCOUNTS" "INCOME_FROM_CUSTOMERS" "CORPORATE_MERGERS_AND_ACQUISITIONS" "FINANCING" "SECURITIES_OR_OTHER_FINANCIAL_INSTRUMENTS" "TREASURY" "DONATIONS"
expected_annual_revenue
string

The business' expected annual revenue.

Enum: "ENTITY_IN_CRISIS" "ENTITY_IN_SETUP" "UP_TO_ONE_MEUR" "ONE_M_TO_FIVE_MEUR" "FIVE_M_TO_TEN_MEUR" "MORE_THAN_TEN_MEUR"
expected_annual_incoming_funds
string

The business' expected annual incoming funds.

Enum: "UP_TO_TEN_KEUR" "TEN_K_TO_FIFTY_KEUR" "FIFTY_K_TO_TWO_HUNDRED_KEUR" "TWO_HUNDRED_K_TO_ONE_MEUR" "ONE_M_TO_FIVE_MEUR" "MORE_THAN_FIVE_MEUR"
company_status
string

The business' expected annual incoming funds.

Enum: "ACTIVE" "INACTIVE" "IN_LIQUIDATION" "COLLECTIVE_PROCEEDINGS" "IN_CONSTITUTION"
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/businesses
Request samples
application/json
{
  • "name": "Example GmbH",
  • "sector": "OTHER_COMPANIES",
  • "industry": "OTHER_SERVICES",
  • "industry_key": "EDUCATION",
  • "legal_form": "GMBH",
  • "foundation_date": "1990-06-01T00:00:00.000Z",
  • "address": {
    },
  • "tax_information": {
    },
  • "fatca_relevant": true,
  • "fatca_crs_confirmed_at": "2017-01-01T00:00:00.000Z",
  • "crs_company_type": "FE_REPORTING",
  • "balance_sheet_total": 1234567,
  • "number_employees": 3,
  • "registration_type": "DE_GNR_CD",
  • "registration_district": "BERLIN_CHARLOTTENBURG",
  • "business_purpose": "change the world for the better",
  • "terms_conditions_signed_at": "2017-01-01T00:00:00.000Z",
  • "branch": "ES",
  • "international_operativity_expectation": [
    ],
  • "vat_number": "4711",
  • "purpose_of_account_opening": "SAVINGS",
  • "source_of_funds": "REAL_ESTATE_INCOME",
  • "expected_annual_revenue": "UP_TO_ONE_MEUR",
  • "expected_annual_incoming_funds": "TWO_HUNDRED_K_TO_ONE_MEUR",
  • "company_status": "ACTIVE"
}
Response samples
application/json
{
  • "id": "e0277fae750a4c849660da873f94cbiz",
  • "name": "string",
  • "sector": "ECONOMICALLY_SELF_EMPLOYED",
  • "industry": "BUILDING_INDUSTRY",
  • "industry_key": "ACCOMMODATION",
  • "legal_form": "AT_SE",
  • "foundation_date": "string",
  • "address": {
    },
  • "tax_information": {
    },
  • "fatca_relevant": true,
  • "fatca_crs_confirmed_at": "string",
  • "crs_company_type": "FE_REPORTING",
  • "business_purpose": "string",
  • "terms_conditions_signed_at": "string",
  • "flagged_by_compliance": "string",
  • "balance_sheet_total": 0,
  • "number_employees": 0,
  • "registration_type": "AT_FB_CD",
  • "registration_district": "AACHEN",
  • "screening_progress": "NOT_SCREENED",
  • "international_operativity_expectation": [
    ],
  • "vat_number": "string",
  • "risk_classification_status": "NOT_SCORED",
  • "customer_vetting_status": "NOT_VETTED",
  • "purpose_of_account_opening": "SAVINGS",
  • "source_of_funds": "REAL_ESTATE_INCOME",
  • "expected_annual_revenue": "ENTITY_IN_CRISIS",
  • "expected_annual_incoming_funds": "UP_TO_TEN_KEUR",
  • "company_status": "ACTIVE"
}

Index businesses

Returns an array containing all of your business customers.

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

Sort the results by business name.

Value: "name"
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/businesses
Request samples
curl -i -X GET \
  'https://api.solaris-sandbox.de/v1/businesses?page%5Bnumber%5D=string&page%5Bsize%5D=string&sort=name'
Response samples
application/json
{
  • "id": "e0277fae750a4c849660da873f94cbiz",
  • "name": "string",
  • "sector": "ECONOMICALLY_SELF_EMPLOYED",
  • "industry": "BUILDING_INDUSTRY",
  • "industry_key": "ACCOMMODATION",
  • "legal_form": "AT_SE",
  • "foundation_date": "string",
  • "address": {
    },
  • "tax_information": {
    },
  • "fatca_relevant": true,
  • "fatca_crs_confirmed_at": "string",
  • "crs_company_type": "FE_REPORTING",
  • "business_purpose": "string",
  • "terms_conditions_signed_at": "string",
  • "flagged_by_compliance": "string",
  • "balance_sheet_total": 0,
  • "number_employees": 0,
  • "registration_type": "AT_FB_CD",
  • "registration_district": "AACHEN",
  • "screening_progress": "NOT_SCREENED",
  • "international_operativity_expectation": [
    ],
  • "vat_number": "string",
  • "risk_classification_status": "NOT_SCORED",
  • "customer_vetting_status": "NOT_VETTED",
  • "purpose_of_account_opening": "SAVINGS",
  • "source_of_funds": "REAL_ESTATE_INCOME",
  • "expected_annual_revenue": "ENTITY_IN_CRISIS",
  • "expected_annual_incoming_funds": "UP_TO_TEN_KEUR",
  • "company_status": "ACTIVE"
}

Retrieve a business

Returns information about the business 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/businesses/{id}
Request samples
curl -i -X GET \
  'https://api.solaris-sandbox.de/v1/businesses/{id}'
Response samples
application/json
{
  • "id": "e0277fae750a4c849660da873f94cbiz",
  • "name": "string",
  • "sector": "ECONOMICALLY_SELF_EMPLOYED",
  • "industry": "BUILDING_INDUSTRY",
  • "industry_key": "ACCOMMODATION",
  • "legal_form": "AT_SE",
  • "foundation_date": "string",
  • "address": {
    },
  • "tax_information": {
    },
  • "fatca_relevant": true,
  • "fatca_crs_confirmed_at": "string",
  • "crs_company_type": "FE_REPORTING",
  • "business_purpose": "string",
  • "terms_conditions_signed_at": "string",
  • "flagged_by_compliance": "string",
  • "balance_sheet_total": 0,
  • "number_employees": 0,
  • "registration_type": "AT_FB_CD",
  • "registration_district": "AACHEN",
  • "screening_progress": "NOT_SCREENED",
  • "international_operativity_expectation": [
    ],
  • "vat_number": "string",
  • "risk_classification_status": "NOT_SCORED",
  • "customer_vetting_status": "NOT_VETTED",
  • "purpose_of_account_opening": "SAVINGS",
  • "source_of_funds": "REAL_ESTATE_INCOME",
  • "expected_annual_revenue": "ENTITY_IN_CRISIS",
  • "expected_annual_incoming_funds": "UP_TO_TEN_KEUR",
  • "company_status": "ACTIVE"
}

Update a business

Modifies one or more properties of a business. Note that changing existing properties will trigger the change request process.

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

The content of the request.

name
string

company name

sector
string

The sector of the business. Please note that the business' tax_country determines the allowed values you may store in the sector property, and the value of sector determines the allowed values you may store in the legal_form and industry/nace_code properties.

Enum: "ECONOMICALLY_SELF_EMPLOYED" "ECONOMIC_DEPENDENT" "FOREIGN_COMPANIES" "FOREIGN_ECONOMIC_DEPENDENT" "FOREIGN_PRIVATE_INDIVIDUAL" "FOREIGN_SELF_EMPLOYED_PRIVATE_PERSON" "GERMAN_BANKS" "MUNICIPALITY_AND_MUNICIPALITY_ASSOCIATION" "OTHER_COMPANIES_WORKMAN" "OTHER_COMPANIES" "OTHER_PRIVATE_INDIVIDUAL"
industry
string (Solaris-Decorators-IndustryEnum)

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" "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 (Solaris-Decorators-IndustryKeyEnum)

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" "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"
legal_form
string (Solaris-Decorators-BusinessLegalFormEnum)

The business' legal form. Check the Onboarding requirements guide for the mapping between legal form and tax country.

Enum: "AT_SE" "AT_OHG" "AT_KG" "AT_AG" "AT_GESMBH" "AT_EG" "AT_GBR" "AT_EV" "AT_SOLE_PROPRIETORSHIP" "AT_SELF_EMPLOYED" "AT_AMT" "AT_KOR" "AT_STIFTUNGEN" "AT_GMBH" "AT_GMBH_CO_KG" "BE_SNC" "BE_SCS" "BE_SA" "BE_SPRL" "BE_SE" "BE_SCA" "BE_SC" "BE_SCRI" "BE_SEP" "BE_SF" "BE_SPRLU" "BE_SOLE_PROPRIETORSHIP" "BE_SELF_EMPLOYED" "BG_AD" "BG_OOD" "BG_KDA" "BG_KD" "BG_SD" "BG_SELF_EMPLOYED" "BG_SOLE_PROPRIETORSHIP" "HR_DD" "HR_DOO" "HR_JDOO" "HR_KD" "HR_JTD" "HR_SELF_EMPLOYED" "HR_SOLE_PROPRIETORSHIP" "HR_ORTA" "CZ_AS" "CZ_SRO" "CZ_KS" "CZ_VOS" "CZ_DRUZSTVO" "CZ_FYZICKA_OSOBA" "CZ_SOLE_PROPRIETORSHIP" "CZ_SELF_EMPLOYED" "FR_AE" "FR_EI" "FR_SNC" "FR_SCS" "FR_SA" "FR_SAS" "FR_SARL" "FR_SE" "FR_SCA" "FR_EURL" "FR_SC" "FR_SCOP" "FR_SELARL" "FR_SOLE_PROPRIETORSHIP" "FR_SELF_EMPLOYED" "AG" "EG" "EK" "EV" "NEV" "GBR" "GMBH" "GMBH_CO_KG" "GMBH_I_GR" "KG" "KGAA" "LTD" "MUNICIPALITY" "MUNICIPAL_COMPANY" "NONE" "OHG" "PARTG" "PRIVATE_PERSON" "SAVINGS_BANK" "SE" "SELF_EMPLOYED" "SOLE_PROPRIETORSHIP" "UG" "UG_I_GR" "FOREIGN_CORPORATION" "ADOR" "AMT" "KDOR" "STIFTUNGEN" "SECOKG" "AGCOKG" "HU_NYRT" "HU_KFT" "HU_BT" "HU_KKT" "HU_SOLE_PROPRIETORSHIP" "HU_SELF_EMPLOYED" "HU_ORTA" "IT_SE" "IT_SNC" "IT_SAS" "IT_SPA" "IT_SRL" "IT_SAPA" "IT_SCPA" "IT_SCARL" "IT_SCOP" "IT_SS" "IT_SOLE_PROPRIETORSHIP" "IT_SELF_EMPLOYED" "LU_SNC" "LU_SCS" "LU_SA" "LU_SARL" "LU_SE" "LU_SCA" "LU_SCSP" "LU_SARLS" "LU_SC" "LU_SCOP" "LU_SOLE_PROPRIETORSHIP" "LU_SELF_EMPLOYED" "LU_SECA" "LU_ASBL" "LU_FON" "LU_SP" "PL_SA" "PL_SPZOO" "PL_SE" "PL_SKA" "PL_SPK" "PL_SPJ" "PL_SELF_EMPLOYED" "PL_OTHER" "PT_SNC" "PT_SC" "PT_SA" "PT_LDA" "PT_SE" "PT_SUNI" "PT_EIRL" "PT_SCIV" "PT_COP" "PT_SOLE_PROPRIETORSHIP" "PT_SELF_EMPLOYED" "RO_SA" "RO_SRL" "RO_SCA" "RO_SCS" "RO_SNC" "RO_SELF_EMPLOYED" "RO_SOLE_PROPRIETORSHIP" "RS_AD" "RS_DOO" "RS_KD" "RS_OD" "RS_SELF_EMPLOYED" "RS_SOLE_PROPRIETORSHIP" "SI_DD" "SI_DOO" "SI_KDD" "SI_KD" "SI_DNO" "SI_SELF_EMPLOYED" "SI_SOLE_PROPRIETORSHIP" "ES_SRC" "ES_SC" "ES_SA" "ES_SAS" "ES_SRL" "ES_SE" "ES_SCA" "ES_SLNE" "ES_SAU" "ES_SLU" "ES_SPRO" "ES_SCOP" "ES_SOLE_PROPRIETORSHIP" "ES_SELF_EMPLOYED" "CH_DE_AG" "CH_FR_SA" "CH_IT_SA" "CH_DE_GMBH" "CH_FR_SARL" "CH_IT_SAGL" "CH_SE" "CH_DE_KOMAG" "CH_FR_SCA" "CH_IT_SACA" "CH_DE_KG" "CH_FR_SCM" "CH_IT_SAC" "CH_DE_KIG" "CH_FR_SNC" "CH_IT_SNC" "CH_DE_EG" "CH_FR_SS" "CH_IT_SS" "CH_SELF_EMPLOYED" "CH_SOLE_PROPRIETORSHIP" "CH_DE_KMG" "NL_VOF" "NL_CV" "NL_NV" "NL_BV" "NL_SE" "NL_CVOA" "NL_COPV" "NL_MTS" "NL_SOLE_PROPRIETORSHIP" "NL_SELF_EMPLOYED" "NL_VERENIGING" "NL_STICHT" "TR_ADI_SIR" "TR_AS" "TR_LS" "TR_KOM_STI" "TR_KOLL_STI" "TR_SELF_EMPLOYED" "TR_SOLE_PROPRIETORSHIP" "GB_SE" "GB_PARTNERSHIP" "GB_LP" "GB_PLC" "GB_LTD" "GB_COPS" "GB_UAS" "GB_PRCU" "GB_PUCU" "GB_SOLE_PROPRIETORSHIP" "GB_SELF_EMPLOYED"
foundation_date
string

The date when the business was founded.

object

The business' address.

object

The business' tax information.

fatca_relevant
boolean

Indicates whether or not the company is FATCA relevant.

fatca_crs_confirmed_at
string

UTC timestamp when the business confirmed whether or not they were FATCA relevant.

crs_company_type
string

The business' Common Reporting Standard (CRS) company type.

Enum: "FE_REPORTING" "FE_NON_REPORTING" "NFE_ACTIVE" "NFE_ACTIVE_OTHER" "NFE_PASSIVE" "NFE_PASSIVE_INVESTMENT"
balance_sheet_total
integer

The business' total assets, in Euro cents.

number_employees
integer

The number of employees at the business.

registration_type
string

The business' registration type.

Enum: "AT_FB_CD" "AT_GEM_CD" "AT_IDENT_CD" "AT_LAE_CD" "AT_ZVR_CD" "BE_OND_CD" "BG_BULSTAT_CD" "BG_OTHER_CD" "BG_UIC_CD" "BG_VAT_CD" "CY_DRCOR_CD" "CY_NOTAP_CD" "CY_TIC_CD" "CY_VAT_CD" "CZ_ICO_CD" "CZ_NID_CD" "DE_GNR_CD" "DE_HRA_CD" "DE_HRB_CD" "DE_NOTAP_CD" "DE_PR_CD" "DE_VR_CD" "DK_CVR_CD" "DK_FT_CD" "DK_NOTAP_CD" "EE_FON_CD" "EE_RG_CD" "ES_NIF_CD" "FI_ALV_CD" "FI_NOTAP_CD" "FI_SIRA_CD" "FI_Y_CD" "FR_CIB" "FR_SIREN_CD" "GEN_IPF_CD" "GEN_NBR_ENTTY_CD" "GEN_NCB_ENTTY_CD" "GEN_NSA_ENTTY_CD" "GEN_NSI_ENTTY_CD" "GEN_OTHER_CD" "GEN_PS_CD" "GEN_TAX_CD" "GEN_TRD_RGSTR_ENTTY_CD" "GEN_VAT_CD" "GR_AFM_CD" "GR_IMO_CD" "HR_MB_CD" "HR_MBS_CD" "HR_OIB_CD" "HU_CEG_CD" "HU_FB_CD" "HU_KOZ_CD" "HU_TOR_CD" "IE_CRO_CD" "IE_VAT_CD" "IT_CCIAA_CD" "IT_CF_CD" "IT_UCITS_CD" "LT_INV_CD" "LT_JAR_CD" "LU_RSC_CD" "LV_FON_CD" "LV_NBR_CD" "LV_VAT_CD" "MT_CNUM_CD" "MT_OLE_CD" "MT_VAT_CD" "NL_KVK_CD" "NL_RSIN_CD" "PL_KRS_CD" "PL_NIP_CD" "PL_REGON_CD" "PL_VAT_CD" "PT_FSA_CD" "PT_NIF_CD" "RO_CUI_CD" "RO_TAX_CD" "RO_TRN_CD" "SE_FIN_CD" "SE_MOM_CD" "SE_ORG_CD" "SI_DAV_CD" "SI_DDV_CD" "SI_MAT_CD" "SK_ICO_CD"
registration_district
string

(For German businesses only) The district where the business is registered.

Enum: "AACHEN" "ALTENBURG" "AMBERG" "ANSBACH" "APOLDA" "ARNSBERG" "ARNSTADT" "ARNSTADT_ZWEIGSTELLE_ILMENAU" "ASCHAFFENBURG" "AUGSBURG" "AURICH" "BAD_HERSFELD" "BAD_HOMBURG_VDH" "BAD_KREUZNACH" "BAD_OEYNHAUSEN" "BAD_SALZUNGEN" "BAMBERG" "BAYREUTH" "BERLIN_CHARLOTTENBURG" "BIELEFELD" "BOCHUM" "BONN" "BRAUNSCHWEIG" "BREMEN" "CHEMNITZ" "COBURG" "COESFELD" "COTTBUS" "DARMSTADT" "DEGGENDORF" "DORTMUND" "DRESDEN" "DUISBURG" "DUEREN" "DUESSELDORF" "EISENACH" "ERFURT" "ESCHWEGE" "ESSEN" "FLENSBURG" "FRANKFURT_AM_MAIN" "FRANKFURT_ODER" "FREIBURG" "FRIEDBERG" "FRITZLAR" "FULDA" "FUERTH" "GELSENKIRCHEN" "GERA" "GIESSEN" "GOTHA" "GOETTINGEN" "GREIFSWALD" "GREIZ" "GUESTROW" "GUETERSLOH" "HAGEN" "HAMBURG" "HAMM" "HANAU" "HANNOVER" "HEILBAD_HEILIGENSTADT" "HILDBURGHAUSEN" "HILDESHEIM" "HOF" "HOMBURG" "INGOLSTADT" "ISERLOHN" "JENA" "KAISERSLAUTERN" "KASSEL" "KEMPTEN_ALLGAUE" "KIEL" "KLEVE" "KOBLENZ" "KOELN" "KOENIGSTEIN" "KORBACH" "KREFELD" "LANDAU" "LANDSHUT" "LEBACH" "LEIPZIG" "LEMGO" "LIMBURG" "LUEBECK" "LUDWIGSHAFEN_A_RHEIN_LUDWIGSHAFEN" "LUDWIGSLUST" "LUENEBURG" "MAINZ" "MANNHEIM" "MARBURG" "MEININGEN" "MEMMINGEN" "MERZIG" "MOENCHENGLADBACH" "MONTABAUR" "MUEHLHAUSEN" "MUENCHEN" "MUENSTER" "NEUBRANDENBURG" "NEUNKIRCHEN" "NEURUPPIN" "NEUSS" "NORDHAUSEN" "NUERNBERG" "OFFENBACH_AM_MAIN" "OLDENBURG_OLDENBURG" "OSNABRUECK" "OTTWEILER" "PADERBORN" "PASEWALK" "PASSAU" "PINNEBERG" "POESSNECK" "POESSNECK_ZWEIGSTELLE_BAD_LOBENSTEIN" "POTSDAM" "RECKLINGHAUSEN" "REGENSBURG" "RIBNITZ_DAMGARTEN" "ROSTOCK" "RUDOLSTADT" "RUDOLSTADT_ZWEIGSTELLE_SAALFELD" "SAARBRUECKEN" "SAARLOUIS" "SCHWEINFURT" "SCHWERIN" "SIEGBURG" "SIEGEN" "SOEMMERDA" "SONDERSHAUSEN" "SONNEBERG" "ST_INGBERT_ST_INGBERT" "ST_WENDEL_ST_WENDEL" "STADTHAGEN" "STADTRODA" "STEINFURT" "STENDAL" "STRALSUND" "STRAUBING" "STUTTGART" "SUHL" "TOSTEDT" "TRAUNSTEIN" "ULM" "VOELKLINGEN" "WALSRODE" "WAREN_MUERITZ" "WEIDEN_ID_OPF" "WEIMAR" "WETZLAR" "WIESBADEN" "WISMAR" "WITTLICH" "WUPPERTAL" "WUERZBURG" "ZWEIBRUECKEN"
business_purpose
string

Short summary of the purpose of the business. May also include the business' web address.

terms_conditions_signed_at
string

UTC timestamp when the business signed the Solaris Terms and Conditions.

vat_number
string

The business' VAT number.

international_operativity_expectation
Array of strings

Regions where the business expects to operate.

Items Enum: "AFRICA" "ASIA" "MIDDLE_EAST" "NORTH_AMERICA" "SOUTH_AMERICA" "NATIONAL_ACTIVITY_ONLY"
purpose_of_account_opening
string

The business' purpose for opening the account.

Enum: "SAVINGS" "DAILY_EXPENSES" "TRAVELLING_AND_RELOCATING" "FREELANCER_ACTIVITY" "ONLINE_SHOPPING" "SALARY_OR_PENSION_ACCREDITATION" "TRADING" "FINANCING" "BUYING_AND_SELLING_GOODS" "MANAGEMENT_OF_INVOICES_AND_RECEIPTS" "TREASURY" "SUPPLIERS_MANAGEMENT" "SETTLEMENT_OF_TRANSACTIONS_TO_AND_FROM_ABROAD" "INVESTMENT_ACTIVITY" "EMPLOYEE_PAYROLL_MANAGEMENT"
source_of_funds
string

The business' source of funds.

Enum: "REAL_ESTATE_INCOME" "SALE_OF_GOODS_AND_SERVICES" "TRANSFER_FROM_DIFFERENT_ACCOUNTS" "INCOME_FROM_CUSTOMERS" "CORPORATE_MERGERS_AND_ACQUISITIONS" "FINANCING" "SECURITIES_OR_OTHER_FINANCIAL_INSTRUMENTS" "TREASURY" "DONATIONS"
expected_annual_revenue
string

The business' expected annual revenue.

Enum: "ENTITY_IN_CRISIS" "ENTITY_IN_SETUP" "UP_TO_ONE_MEUR" "ONE_M_TO_FIVE_MEUR" "FIVE_M_TO_TEN_MEUR" "MORE_THAN_TEN_MEUR"
expected_annual_incoming_funds
string

The business' expected annual incoming funds.

Enum: "UP_TO_TEN_KEUR" "TEN_K_TO_FIFTY_KEUR" "FIFTY_K_TO_TWO_HUNDRED_KEUR" "TWO_HUNDRED_K_TO_ONE_MEUR" "ONE_M_TO_FIVE_MEUR" "MORE_THAN_FIVE_MEUR"
company_status
string

The business' expected annual incoming funds.

Enum: "ACTIVE" "INACTIVE" "IN_LIQUIDATION" "COLLECTIVE_PROCEEDINGS" "IN_CONSTITUTION"
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/businesses/{id}
Request samples
application/json
{
  • "name": "Example GmbH",
  • "sector": "OTHER_COMPANIES",
  • "industry": "OTHER_SERVICES",
  • "industry_key": "EDUCATION",
  • "legal_form": "GMBH",
  • "foundation_date": "1990-06-01T00:00:00.000Z",
  • "address": {
    },
  • "tax_information": {
    },
  • "fatca_relevant": true,
  • "fatca_crs_confirmed_at": "2017-01-01T00:00:00.000Z",
  • "crs_company_type": "FE_REPORTING",
  • "balance_sheet_total": 1234567,
  • "number_employees": 3,
  • "registration_type": "DE_GNR_CD",
  • "registration_district": "BERLIN_CHARLOTTENBURG",
  • "business_purpose": "change the world for the better",
  • "terms_conditions_signed_at": "2017-01-01T00:00:00.000Z",
  • "international_operativity_expectation": [
    ],
  • "vat_number": "4711",
  • "purpose_of_account_opening": "SAVINGS",
  • "source_of_funds": "REAL_ESTATE_INCOME",
  • "expected_annual_revenue": "UP_TO_ONE_MEUR",
  • "expected_annual_incoming_funds": "TWO_HUNDRED_K_TO_ONE_MEUR",
  • "company_status": "ACTIVE"
}
Response samples
application/json
{
  • "id": "e0277fae750a4c849660da873f94cbiz",
  • "name": "string",
  • "sector": "ECONOMICALLY_SELF_EMPLOYED",
  • "industry": "BUILDING_INDUSTRY",
  • "industry_key": "ACCOMMODATION",
  • "legal_form": "AT_SE",
  • "foundation_date": "string",
  • "address": {
    },
  • "tax_information": {
    },
  • "fatca_relevant": true,
  • "fatca_crs_confirmed_at": "string",
  • "crs_company_type": "FE_REPORTING",
  • "business_purpose": "string",
  • "terms_conditions_signed_at": "string",
  • "flagged_by_compliance": "string",
  • "balance_sheet_total": 0,
  • "number_employees": 0,
  • "registration_type": "AT_FB_CD",
  • "registration_district": "AACHEN",
  • "screening_progress": "NOT_SCREENED",
  • "international_operativity_expectation": [
    ],
  • "vat_number": "string",
  • "risk_classification_status": "NOT_SCORED",
  • "customer_vetting_status": "NOT_VETTED",
  • "purpose_of_account_opening": "SAVINGS",
  • "source_of_funds": "REAL_ESTATE_INCOME",
  • "expected_annual_revenue": "ENTITY_IN_CRISIS",
  • "expected_annual_incoming_funds": "UP_TO_TEN_KEUR",
  • "company_status": "ACTIVE"
}

Business Registrations

Retrieve business registration number and issuer

Returns the business registration number and issuer for a business by searching for it in the commercial registry by name and country.

Request
Security:
query Parameters
name
string

The business's registered name.

country
string
Default: "DE"

The country code where the business is registered.

Responses
200

Operation was successful

403

Unauthorized Action

404

Model Not Found

get/v1/commercial_registrations/search_by_name
Request samples
curl -i -X GET \
  'https://api.solaris-sandbox.de/v1/commercial_registrations/search_by_name?name=string&country=DE'
Response samples
application/json
{
  • "registration_number": "HRB 198673",
  • "registration_issuer": "AMTSGERICHT München"
}

Search for business's commercial registration

Retrieves the business's information from the commercial registry. You must add the business's registration_number and registration_issuer in the request URL.

Request
Security:
query Parameters
registration_number
string

The business's commercial registration number without spaces.

registration_issuer
string

The entity that issued the business commercial registration number.

country
string
Default: "DE"

The country code where the business is registered.

Responses
200

Operation was successful

403

Unauthorized Action

404

Model Not Found

get/v1/commercial_registrations/find
Request samples
curl -i -X GET \
  'https://api.solaris-sandbox.de/v1/commercial_registrations/find?registration_number=string&registration_issuer=string&country=DE'
Response samples
application/json
{
  • "name": "FLOOR 13 GmbH",
  • "address": {
    },
  • "legal_form": "GMBH",
  • "tax_country": "DE",
  • "registration_number": "HRB198673",
  • "registration_issuer": "AMTSGERICHT München",
  • "registration_date": "2012-05-09",
  • "registry_updated_at": "2015-11-17",
  • "legal_representatives": {
    }
}

Business tax identifications

Create business tax identification

Creates a tax identification for the given business. Please note the following:

  • The first tax_identification to be submitted must be the primary tax identification. If you create another tax_identification for the business with the value of primary set to true, then it will overrule the previous tax identification (i.e., the primary property of the previous one will be set to false).
  • A business may only have one tax identification per country.

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

The content of the request.

number
string

The business' tax identification number (TIN).

country
string

The business' tax country.

primary
boolean

Indicates whether this is the business' primary TIN.

reason_no_tin
string

Provides a reason why the tax identification does not contain a TIN for the business.

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

Additional context around why there is no TIN for the business.

valid_until
string <date>

Date when the tax identification becomes invalid.

tax_id_type
string

The type of tax ID provided by the business.

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/businesses/{business_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 business tax identifications

Returns an array containing all tax identifications for a business.

Request
Security:
path Parameters
business_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/businesses/{business_id}/tax_identifications
Request samples
curl -i -X GET \
  'https://api.solaris-sandbox.de/v1/businesses/{business_id}/tax_identifications'
Response samples
application/json
[
  • {
    }
]

Get a business tax identification

Returns information about the business tax identification specified in the request URL.

Request
Security:
path Parameters
business_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/businesses/{business_id}/tax_identifications/{id}
Request samples
curl -i -X GET \
  'https://api.solaris-sandbox.de/v1/businesses/{business_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 business tax identification

Updates one or more properties on an existing business tax identification.

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

The content of the request.

number
string

The business' tax identification number (TIN).

country
string

The business' tax country.

primary
boolean

Indicates whether this is the business' primary TIN.

reason_no_tin
string

Provides a reason why the tax identification does not contain a TIN for the business.

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

Additional context around why there is no TIN for the business.

valid_until
string <date>

Date when the tax identification becomes invalid.

tax_id_type
string

The type of tax ID provided by the business.

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/businesses/{business_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"
}

Business documents

Index documents for a business

Returns an array containing all documents for the business specified in the request URL.

Request
Security:
path Parameters
business_id
required
string
query Parameters
include_deleted
boolean

Boolean flag to determine whether or not the API should return documents that were deleted.

customer_accessible
boolean

Boolean flag to determine whether the API should return documents that the customer has access to.

sort
string

Sort the results by document creation date (i.e., created_at).

Example: sort=created_at
page[number]
string

The number of results pages to return.

page[size]
string

The number of entries to return in each page.

filter[document_type]
string

Filters the result by document type.

Responses
200

Successful result of the operation

400

An error occurred on the client side.

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/businesses/{business_id}/documents
Request samples
curl -i -X GET \
  'https://api.solaris-sandbox.de/v1/businesses/{business_id}/documents?include_deleted=true&customer_accessible=true&sort=created_at&page%5Bnumber%5D=string&page%5Bsize%5D=string&filter%5Bdocument_type%5D=string'
Response samples
application/json
{
  • "id": "69ec2a9d8dbaf5ea1b13124098a34ea3cdoc",
  • "name": "Operation_authorization.png",
  • "content_type": "image/png",
  • "document_type": "PICTURE",
  • "size": 10187,
  • "customer_accessible": false,
  • "created_at": "2022-05-20T12:46:09Z",
  • "deleted_at": "null"
}

Create a document for a business

Uploads a document and links it to the business specified in the request URL.
Unlike most other endpoints, this request uses the multipart/form-data content type. 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
business_id
required
string
Request Body schema: multipart/form-data
file
required
string <binary>

File to upload

document_type
required
string (Solaris-Enums-DocumentType)

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_AGENCY_REPORT" "CREDIT_RECORD.SCHUFA" "CUSTOMER_COMMUNICATION" "FATCA_SELF_DECLARATION" "FOUNDATION_DOCUMENT" "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" "POWER_OF_ATTORNEY" "PROOF_OF_ADDRESS" "PROOF_OF_PHONE_CHANGE" "PROOF_OF_PROFESSION" "PROOF_OF_SALARY" "PROOF_OF_TAX_ID" "REFERENCE_LETTER" "REGISTER_APPLICATION" "REGISTER_EXTRACT" "SALARY_INFORMATION" "SCHUFA_COMPACT_REPORT" "SCHUFA_FULL_REPORT" "SCHUFA_GWG_REPORT" "SCHUFA_SHORT_REPORT" "SCORE_CARD.SOLARIS" "SCREENING_REPORT" "SHAREHOLDERS_LIST" "SHARE_HOLDERS_AGREEMENT" "SIGNATURE" "SIGNED_CONTRACT" "SIGNED_LOAN_MANDATE_CONTRACT" "TRADING_LICENSE" "TRANSACTIONAL_DOCUMENT" "TRANSFER_CANCELLATION" "VAT_CERTIFICATE" "VIDEO"
Responses
200

Successful result of the operation

default

Unexpected error

post/v1/businesses/{business_id}/documents
Request samples
curl -i -X POST \
  'https://api.solaris-sandbox.de/v1/businesses/{business_id}/documents' \
  -H 'Content-Type: multipart/form-data' \
  -F file=string \
  -F document_type=ACCOUNT_SNAPSHOT.FINTECSYSTEMS
Response samples
application/json
{
  • "id": "69ec2a9d8dbaf5ea1b13124098a34ea3cdoc",
  • "name": "Operation_authorization.png",
  • "content_type": "image/png",
  • "document_type": "PICTURE",
  • "size": 10187,
  • "customer_accessible": false,
  • "created_at": "2022-05-20T12:46:09Z",
  • "deleted_at": "null"
}

Download a business document

Downloads the file associated with the business document specified in the request URL.

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

Successful result of the operation.

400

An error occurred on the client side.

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/businesses/{business_id}/documents/{id}/file
Request samples
curl -i -X GET \
  'https://api.solaris-sandbox.de/v1/businesses/{business_id}/documents/{id}/file'
Response samples
application/json
{
  • "title": "Failed to build pagination headers.",
  • "status": "400",
  • "id": "a95f2aaf-4e0c-4d49-8021-8a16a884ed86",
  • "detail": "Cannot connect to database.",
  • "code": "build_pagination_headers_failure"
}

Retrieve a business document

Returns information about the business document specified in the request URL.

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

Successful result of the operation

400

An error occurred on the client side.

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/businesses/{business_id}/documents/{id}
Request samples
curl -i -X GET \
  'https://api.solaris-sandbox.de/v1/businesses/{business_id}/documents/{id}'
Response samples
application/json
{
  • "id": "69ec2a9d8dbaf5ea1b13124098a34ea3cdoc",
  • "name": "Operation_authorization.png",
  • "content_type": "image/png",
  • "document_type": "PICTURE",
  • "size": 10187,
  • "customer_accessible": false,
  • "created_at": "2022-05-20T12:46:09Z",
  • "deleted_at": "null"
}

Delete a business document

Deletes a document for a business

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

Successful result of the operation

default

Unexpected error

delete/v1/businesses/{business_id}/documents/{id}
Request samples
curl -i -X DELETE \
  'https://api.solaris-sandbox.de/v1/businesses/{business_id}/documents/{id}'
Response samples
application/json
{
  • "id": "69ec2a9d8dbaf5ea1b13124098a34ea3cdoc",
  • "name": "Operation_authorization.png",
  • "content_type": "image/png",
  • "document_type": "PICTURE",
  • "size": 10187,
  • "customer_accessible": false,
  • "created_at": "2022-05-20T12:46:09Z",
  • "deleted_at": "null"
}

Update business document attributes

Updates one or more properties of the business document specified in the request URL.

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

the content of the request

document_type
string (Solaris-Enums-DocumentType)

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_AGENCY_REPORT" "CREDIT_RECORD.SCHUFA" "CUSTOMER_COMMUNICATION" "FATCA_SELF_DECLARATION" "FOUNDATION_DOCUMENT" "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" "POWER_OF_ATTORNEY" "PROOF_OF_ADDRESS" "PROOF_OF_PHONE_CHANGE" "PROOF_OF_PROFESSION" "PROOF_OF_SALARY" "PROOF_OF_TAX_ID" "REFERENCE_LETTER" "REGISTER_APPLICATION" "REGISTER_EXTRACT" "SALARY_INFORMATION" "SCHUFA_COMPACT_REPORT" "SCHUFA_FULL_REPORT" "SCHUFA_GWG_REPORT" "SCHUFA_SHORT_REPORT" "SCORE_CARD.SOLARIS" "SCREENING_REPORT" "SHAREHOLDERS_LIST" "SHARE_HOLDERS_AGREEMENT" "SIGNATURE" "SIGNED_CONTRACT" "SIGNED_LOAN_MANDATE_CONTRACT" "TRADING_LICENSE" "TRANSACTIONAL_DOCUMENT" "TRANSFER_CANCELLATION" "VAT_CERTIFICATE" "VIDEO"
customer_accessible
boolean

Customer accessible : Boolean

Responses
200

Successful result of the operation

default

Unexpected error

patch/v1/businesses/{business_id}/documents/{id}
Request samples
application/json
{
  • "document_type": "ACCOUNT_SNAPSHOT.FINTECSYSTEMS",
  • "customer_accessible": true
}
Response samples
application/json
{
  • "id": "69ec2a9d8dbaf5ea1b13124098a34ea3cdoc",
  • "name": "Operation_authorization.png",
  • "content_type": "image/png",
  • "document_type": "PICTURE",
  • "size": 10187,
  • "customer_accessible": false,
  • "created_at": "2022-05-20T12:46:09Z",
  • "deleted_at": "null"
}

Beneficial Owners

Create a beneficial owner for a business

Links the person with the person_id specified in the request body to the business specified in the request URL as a beneficial owner.
Please note that the person must have valid values in each of the following attributes:

  • salutation
  • first_name
  • last_name
  • birth_date

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

The content of the request.

person_id
string

ID of the person to be associated with the business as a beneficial owner.

voting_share
string

The beneficial's voting share, expressed as a percentile value from 0 to 100 using the format xx.xx.

fictitious
boolean

Indicates whether or not the beneficial owner is fictitious.

relationship_to_business
string

Specifies the beneficial owner's relationship to the business.

Enum: "DIRECTLY_HOLDING_25_PERCENT_OR_MORE" "DOMINANT_INFLUENCE_OVER_SHARE_CAPITAL" "INDIRECTLY_HOLDING_25_PERCENT_OR_MORE"
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/businesses/{business_id}/beneficial_owners
Request samples
application/json
{
  • "person_id": "3b8cfd40fb4dce5a231251ea06a014cper",
  • "voting_share": "70.50",
  • "fictitious": false,
  • "relationship_to_business": "DOMINANT_INFLUENCE_OVER_SHARE_CAPITAL"
}
Response samples
application/json
{
  • "id": "a5f454e3f96447d6b3f7ecda46328040",
  • "beneficial_owner_id": "b9c5661fc7d240b8b51b9059b580cper",
  • "person_id": "b9c5661fc7d240b8b51b9059b580cper",
  • "valid_until": "2022-12-31",
  • "voting_share": 75,
  • "business_id": "e0277fae750a4c849660da873f94cbiz",
  • "fictitious": false,
  • "relationship_to_business": "DOMINANT_INFLUENCE_OVER_SHARE_CAPITAL"
}

List all beneficial owners for a business

Returns an array containing all beneficial owners associated with a business.

Request
Security:
path Parameters
business_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.

include_invalid
boolean

Flag that specifies whether or not to include beneficial owners who are no longer valid (i.e., their valid_until date has passed).

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/businesses/{business_id}/beneficial_owners
Request samples
curl -i -X GET \
  'https://api.solaris-sandbox.de/v1/businesses/{business_id}/beneficial_owners?page%5Bnumber%5D=string&page%5Bsize%5D=string&include_invalid=true'
Response samples
application/json
[
  • {
    }
]

Get a beneficial owner of a business

Returns a specific beneficial owner associated with a business as specified in the request URL.

Request
Security:
path Parameters
business_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/businesses/{business_id}/beneficial_owners/{id}
Request samples
curl -i -X GET \
  'https://api.solaris-sandbox.de/v1/businesses/{business_id}/beneficial_owners/{id}'
Response samples
application/json
{
  • "id": "a5f454e3f96447d6b3f7ecda46328040",
  • "beneficial_owner_id": "b9c5661fc7d240b8b51b9059b580cper",
  • "person_id": "b9c5661fc7d240b8b51b9059b580cper",
  • "valid_until": "2022-12-31",
  • "voting_share": 75,
  • "business_id": "e0277fae750a4c849660da873f94cbiz",
  • "fictitious": false,
  • "relationship_to_business": "DOMINANT_INFLUENCE_OVER_SHARE_CAPITAL"
}

Update a beneficial owner of a business

Updates one or more properties on the beneficial owner specified in the request URL.

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

The content of the request.

valid_until
string

The date when the person's beneficial owner role for the account expires.

voting_share
string

The beneficial's voting share, expressed as a percentile value from 0 to 100 using the format xx.xx.

fictitious
boolean

Indicates whether or not the beneficial owner is fictitious.

relationship_to_business
string

Specifies the beneficial owner's relationship to the business.

Enum: "DIRECTLY_HOLDING_25_PERCENT_OR_MORE" "DOMINANT_INFLUENCE_OVER_SHARE_CAPITAL" "INDIRECTLY_HOLDING_25_PERCENT_OR_MORE"
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/businesses/{business_id}/beneficial_owners/{id}
Request samples
application/json
{
  • "valid_until": "2012-12-12",
  • "voting_share": "70.50",
  • "fictitious": false,
  • "relationship_to_business": "DOMINANT_INFLUENCE_OVER_SHARE_CAPITAL"
}
Response samples
application/json
{
  • "id": "a5f454e3f96447d6b3f7ecda46328040",
  • "beneficial_owner_id": "b9c5661fc7d240b8b51b9059b580cper",
  • "person_id": "b9c5661fc7d240b8b51b9059b580cper",
  • "valid_until": "2022-12-31",
  • "voting_share": 75,
  • "business_id": "e0277fae750a4c849660da873f94cbiz",
  • "fictitious": false,
  • "relationship_to_business": "DOMINANT_INFLUENCE_OVER_SHARE_CAPITAL"
}

Authorized persons

Create an authorized person on a business account

Links a person to a business account as an authorized person.
This endpoint requires the change request process unless the authorized person is a legal representative. The change request must be completed by a legal representative with a type_of_representation value of ALONE or null. Note that the person resource must have values for the following properties:

  • address_line_1 (street)
  • birth_city
  • birth_date
  • country
  • first_name
  • last_name
  • nationality
  • salutation

Note: It's mandatory to collect the tax information from each authorized person on the business account and create a tax identification resource using POST Create a person tax identification.

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

The content of the request.

authorized_person_id
string

The ID of the person to add to the business account as an authorized person.

Responses
201

The change request was successfully confirmed, and the authorized person is now added to the account.

202

The request was accepted and now the legal representative 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

post/v1/businesses/{business_id}/accounts/{account_id}/authorized_persons
Request samples
application/json
{
  • "authorized_person_id": "3b8cfd40fb4dce5a231251ea06a014cper"
}
Response samples
application/json
{
  • "id": "c25ac6d8a4774e0dacb61a70427e0782",
  • "authorized_person_id": "0ba2211cab11af6094d60ead81f2bd9dcper",
  • "valid_from": "2021-04-01",
  • "valid_until": "2031-04-01"
}

Index business account authorized persons

Returns an array containing all authorized persons on the business account specified in the request URL.

Request
Security:
path Parameters
business_id
required
string
account_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/businesses/{business_id}/accounts/{account_id}/authorized_persons
Request samples
curl -i -X GET \
  'https://api.solaris-sandbox.de/v1/businesses/{business_id}/accounts/{account_id}/authorized_persons?page%5Bnumber%5D=string&page%5Bsize%5D=string'
Response samples
application/json
[
  • {
    }
]

Get business account authorized person

Returns a specific authorized person on a business account based on the ID in the request URL.

Request
Security:
path Parameters
business_id
required
string
account_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/businesses/{business_id}/accounts/{account_id}/authorized_persons/{id}
Request samples
curl -i -X GET \
  'https://api.solaris-sandbox.de/v1/businesses/{business_id}/accounts/{account_id}/authorized_persons/{id}'
Response samples
application/json
{
  • "id": "c25ac6d8a4774e0dacb61a70427e0782",
  • "authorized_person_id": "0ba2211cab11af6094d60ead81f2bd9dcper",
  • "valid_from": "2021-04-01",
  • "valid_until": "2031-04-01"
}

Remove authorized person from a business account

Removes the authorized person specified in the request URL from the given business.

Request
Security:
path Parameters
business_id
required
string
account_id
required
string
id
required
string
Responses
200

Successful result of the operation, the authorized person is deleted from the account.

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/businesses/{business_id}/accounts/{account_id}/authorized_persons/{id}
Request samples
curl -i -X DELETE \
  'https://api.solaris-sandbox.de/v1/businesses/{business_id}/accounts/{account_id}/authorized_persons/{id}'
Response samples
application/json
{
  • "id": "a95f2aaf-4e0c-4d49-8021-8a16a884ed86",
  • "status": "400",
  • "code": "build_pagination_headers_failure",
  • "title": "Failed to build pagination headers.",
  • "detail": "Cannot connect to database."
}

Business signees

Create a business signee

Assigns a person to the given business as a signee.

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

The content of the request.

person_id
string

ID of the person to add to the business as a signee.

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/businesses/{business_id}/signees
Request samples
application/json
{
  • "person_id": "0ba2211cab11af6094d60ead81f2bd9dcper"
}
Response samples
application/json
{
  • "id": "43f732deceba4e908835b62815bae4a6",
  • "person_id": "dc1a6812a14f6cc338cd084208535bcdcper",
  • "business_id": "880bbac68a34add190786b9c74f4c82fcbiz"
}

Index business signees

Returns an array containing all signees for the given business.

Request
Security:
path Parameters
business_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/businesses/{business_id}/signees
Request samples
curl -i -X GET \
  'https://api.solaris-sandbox.de/v1/businesses/{business_id}/signees'
Response samples
application/json
[
  • {
    }
]

Delete business signee

Deletes the business signee specified in the request URL.

Request
Security:
path Parameters