# Business relations
Endpoints for creating, retrieving, updating, and managing business relations (individuals and entities).
## Retrieve client-specific business relation schema
> Returns only the fields in the BusinessRelation object for which the list of allowed values is customized per client.\
> \
> These fields typically represent drop-downs or tags that are configurable during onboarding (e.g. industry sectors, branches, etc.).\
> \
> Standard fields with fixed values — such as gender, maritalStatus, or countryOfBirth — are not included in this response, \
> as their allowed values are predefined by Apentis and documented in the global OpenAPI schema.\
> \
> This endpoint allows API consumers to dynamically retrieve the client-specific value lists for fields that support custom configuration.
```json
{"openapi":"3.0.3","info":{"title":"Apentis API","version":"1.1.0"},"tags":[{"name":"Business relations","description":"Endpoints for creating, retrieving, updating, and managing business relations (individuals and entities)."}],"servers":[{"url":"https://www.riskquadrant.com/api","description":"API for Production environment - Luxembourg"},{"url":"https://www.riskquadrant.ch/api","description":"API for Production environment - Switzerland"},{"url":"https://www.rq-test.com/api","description":"API for Test environment (for sandbox integration)"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"TenantBusinessRelationSchemaResponse":{"type":"object","description":"Response containing client-specific business relation fields.","properties":{"fields":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/BusinessRelationSchemaField"}}}},"BusinessRelationSchemaField":{"type":"object","description":"Metadata describing a client-specific selectable field for business relations.","properties":{"type":{"type":"string","description":"Data type of the field."},"values":{"type":"array","description":"Allowed values configured for the client.","items":{"type":"string"}},"isRequired":{"type":"boolean","description":"Indicates if the field is mandatory for the client."},"multiSelect":{"type":"boolean","description":"Indicates if multiple values can be selected."}}}}},"paths":{"/v1.1/business-relations/schema-config":{"get":{"summary":"Retrieve client-specific business relation schema","description":"Returns only the fields in the BusinessRelation object for which the list of allowed values is customized per client.\n\nThese fields typically represent drop-downs or tags that are configurable during onboarding (e.g. industry sectors, branches, etc.).\n\nStandard fields with fixed values — such as gender, maritalStatus, or countryOfBirth — are not included in this response, \nas their allowed values are predefined by Apentis and documented in the global OpenAPI schema.\n\nThis endpoint allows API consumers to dynamically retrieve the client-specific value lists for fields that support custom configuration.\n","tags":["Business relations"],"responses":{"200":{"description":"Client-specific business relation schema retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TenantBusinessRelationSchemaResponse"}}}}}}}}}
```
## Retrieve business relations
> Returns business relations using cursor pagination. By default, terminated business relations are excluded unless \`includeTerminated\` is set to \`true\`.
```json
{"openapi":"3.0.3","info":{"title":"Apentis API","version":"1.1.0"},"tags":[{"name":"Business relations","description":"Endpoints for creating, retrieving, updating, and managing business relations (individuals and entities)."}],"servers":[{"url":"https://www.riskquadrant.com/api","description":"API for Production environment - Luxembourg"},{"url":"https://www.riskquadrant.ch/api","description":"API for Production environment - Switzerland"},{"url":"https://www.rq-test.com/api","description":"API for Test environment (for sandbox integration)"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"BusinessRelation":{"type":"object","discriminator":{"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/PersonBusinessRelation"},{"$ref":"#/components/schemas/CompanyBusinessRelation"}]},"PersonBusinessRelation":{"type":"object","required":["type","crmCode","firstName","lastName"],"properties":{"type":{"type":"string","enum":["Person"],"description":"Type of business relation."},"name":{"type":"string","description":"Full name of the person or organization."},"firstName":{"type":"string","description":"Required if the type is Person."},"lastName":{"type":"string","description":"Required if the type is Person."},"maidenName":{"type":"string","description":"Person's maiden name. Optional."},"nationality":{"type":"string","maxLength":2,"description":"ISO 2-letter nationality code. Applicable for persons."},"fiscalCountry":{"type":"string","maxLength":2,"description":"ISO 2-letter fiscal country code."},"address":{"type":"string","description":"Street address of the business relation."},"postalCode":{"type":"string","description":"Postal code of the business relation."},"city":{"type":"string","description":"City of the business relation."},"countryOfResidence":{"type":"string","maxLength":2,"description":"ISO 2-letter country of residence."},"language":{"type":"string","maxLength":2,"description":"Language code (ISO 639-1) of the business relation."},"birthDate":{"type":"string","format":"date","description":"Date of birth of the person (YYYY-MM-DD). Optional."},"placeOfBirth":{"type":"string","description":"Place of birth. Applicable for persons."},"phoneNumber":{"type":"string","description":"Phone number of the business relation. Optional."},"email":{"type":"string","format":"email","pattern":"^[\\w\\.-]+@[\\w\\.-]+\\.\\w{2,}$","description":"Email address. Optional. Must be a valid email format."},"relationshipStatus":{"type":"string","enum":["Client","Prospect","Contact","Investment"],"default":"Client","description":"Business relation type."},"relationStatus":{"type":"string","enum":["active","terminated"],"default":"active","description":"Status of the business relation."},"amlFrequency":{"type":"string","enum":["ongoing","one-time"],"default":"ongoing","description":"Frequency of AML checks (hits and adverse media) for the business relation. Defaults to `ongoing` when omitted."},"crmId":{"type":"string","format":"uuid","description":"Internal Apentis UUID that uniquely identifies the client."},"crmCode":{"type":"string","maxLength":100,"description":"Unique external identifier of the business relation from the calling system."},"service":{"type":"array","items":{"type":"string"},"description":"Services associated with the business relation. Default values provided by Apentis include: portfolio_management_discretionary, portfolio_management_advisory, portfolio_management_rto, portfolio_management_non_discretionary_advisory, fund_setup_and_administration, family_office, tax_planning_and_optimization, wealth_structuring, philanthropy_advisory, estate_planning. However, each client can configure its own list of acceptable values. Use the endpoint `/v1.1/business-relations/schema-config` to retrieve the list configured for your organisation.\n"},"branch":{"type":"array","description":"Branches associated with the business relation. Default values provided by Apentis include: organisation-specific branch identifiers. However, each client can configure its own list of acceptable values. Use the endpoint `/v1.1/business-relations/schema-config` to retrieve the list configured for your organisation.\n","items":{"type":"string"}},"maritalStatus":{"type":"string","enum":["Single","Married","Divorced","Separated","Widower","Other","Partnership"],"description":"Marital status of the person."},"taxIdentificationNumber":{"type":"string","description":"Tax identification number of the business relation."},"wealthSource":{"type":"array","description":"Sources of wealth of the business relation.","items":{"type":"string","enum":["entrepreneurial_activity","salaries_remuneration","inheritance","real_estate","financial_investments","donation_gifts_from_family","donation_gifts_from_others","divorce","loan_leverage","accumulated_profit","capital_from_shareholders","crypto_assets","company_sale_ma_exit","insurance_payout","pension_retirement_fund","litigation_compensation","lottery_gambling"]}},"bankAccountCountry":{"type":"string","maxLength":2,"description":"ISO 2-letter country code of the bank account."},"originOfBusinessRelation":{"type":"string","enum":["business_intermediary","spontaneous_approach","relation_with_existing_client","historical_client","distributor","tied_agent","family_relation_of_employee","family_relationship","electronic_platform","prospection","other"],"description":"Origin of the business relation."},"crsStatus":{"type":"string","enum":["crs_compliant","missing_documentation","conflicting_indicia","cbi_rbi_scheme","non_crs"],"description":"Common Reporting Standard status."},"dmsLinkUrl":{"type":"string","format":"uri","maxLength":500,"description":"Optional link to the client's document management system (DMS) folder."}}},"CompanyBusinessRelation":{"type":"object","required":["type","crmCode","name"],"properties":{"type":{"type":"string","enum":["Association","Company","Family","Foundation","Fund","Household","Insurance company","Insurance contract","Joint ownership","Partnership","Trust","Pension scheme"],"description":"Type of business relation."},"name":{"type":"string","description":"Full name of the person or organization."},"fiscalCountry":{"type":"string","maxLength":2,"description":"ISO 2-letter fiscal country code."},"countryOfOperation":{"type":"string","maxLength":2,"description":"ISO 2-letter country of operation. Applicable for companies."},"address":{"type":"string","description":"Street address of the business relation."},"postalCode":{"type":"string","description":"Postal code of the business relation."},"city":{"type":"string","description":"City of the business relation."},"countryOfResidence":{"type":"string","maxLength":2,"description":"ISO 2-letter country of residence."},"language":{"type":"string","maxLength":2,"description":"Language code (ISO 639-1) of the business relation."},"incorporationDate":{"type":"string","format":"date","description":"Date of incorporation for legal entities (YYYY-MM-DD)."},"phoneNumber":{"type":"string","description":"Phone number of the business relation. Optional."},"email":{"type":"string","format":"email","pattern":"^[\\w\\.-]+@[\\w\\.-]+\\.\\w{2,}$","description":"Email address. Optional. Must be a valid email format."},"relationshipStatus":{"type":"string","enum":["Client","Prospect","Contact","Investment"],"default":"Client","description":"Business relation type."},"relationStatus":{"type":"string","enum":["active","terminated"],"default":"active","description":"Status of the business relation."},"amlFrequency":{"type":"string","enum":["ongoing","one-time"],"default":"ongoing","description":"Frequency of AML checks (hits and adverse media) for the business relation. Defaults to `ongoing` when omitted."},"crmId":{"type":"string","format":"uuid","description":"Internal Apentis UUID that uniquely identifies the client."},"crmCode":{"type":"string","maxLength":100,"description":"Unique external identifier of the business relation from the calling system."},"service":{"type":"array","items":{"type":"string"},"description":"Services associated with the business relation. Default values provided by Apentis include: portfolio_management_discretionary, portfolio_management_advisory, portfolio_management_rto, portfolio_management_non_discretionary_advisory, fund_setup_and_administration, family_office, tax_planning_and_optimization, wealth_structuring, philanthropy_advisory, estate_planning. However, each client can configure its own list of acceptable values. Use the endpoint `/v1.1/business-relations/schema-config` to retrieve the list configured for your organisation.\n"},"taxIdentificationNumber":{"type":"string","description":"Tax identification number of the business relation."},"vatNumber":{"type":"string","description":"VAT number of the business relation."},"industrySector":{"type":"string","description":"Industry sector classification for the company. Default values provided by Apentis include: a_agriculture_forestry_and_fishing, b_mining_and_quarrying, c_manufacturing, d_electricity_gas_steam_and_air_conditioning_supply, e_water_supply_sewerage_waste_management_and_remediation, f_construction, g_wholesale_and_retail_trade_motor_vehicles, h_transporting_and_storage, i_accommodation_and_food_service_activities, j_information_and_communication, k_financial_and_insurance_activities, l_real_estate_activities, m_professional_scientific_and_technical_activities, n_administrative_and_support_service_activities, o_public_administration_and_defence, p_education, q_human_health_and_social_work_activities, r_arts_entertainment_and_recreation, s_other_services_activities, t_households_as_employers_and_own_use_activities, u_extraterritorial_organisations_and_bodies. However, each client can configure its own list of acceptable values. Use the endpoint `/v1.1/business-relations/schema-config` to retrieve the list configured for your organisation.\n"},"complexityOfBoStructure":{"type":"string","description":"Complexity level of the beneficial ownership structure. Default values provided by Apentis include: a_less_than_3_structure_level_in_eu_countries, b_less_than_3_structure_level_in_any_country, c_3_to_6_structure_level_in_eu_countries, d_3_to_6_structure_level_in_any_countries, e_more_than_6_structure_level. However, each client can configure its own list of acceptable values. Use the endpoint `/v1.1/business-relations/schema-config` to retrieve the list configured for your organisation.\n"},"branch":{"type":"array","description":"Branches associated with the business relation. Default values provided by Apentis include: organisation-specific branch identifiers. However, each client can configure its own list of acceptable values. Use the endpoint `/v1.1/business-relations/schema-config` to retrieve the list configured for your organisation.\n","items":{"type":"string"}},"legalForm":{"type":"string","enum":["testamentary","SA","Sarl","SCA","SCS","SCSp","SCoSA","FCP","SICAV","SICAF","SCSp SICAV SIF","SAS","FR","FI"],"description":"Legal form of the entity. Applicable for legal entities only."},"wealthSource":{"type":"array","description":"Sources of wealth of the business relation.","items":{"type":"string","enum":["entrepreneurial_activity","salaries_remuneration","inheritance","real_estate","financial_investments","donation_gifts_from_family","donation_gifts_from_others","divorce","loan_leverage","accumulated_profit","capital_from_shareholders","crypto_assets","company_sale_ma_exit","insurance_payout","pension_retirement_fund","litigation_compensation","lottery_gambling"]}},"bankAccountCountry":{"type":"string","maxLength":2,"description":"ISO 2-letter country code of the bank account."},"originOfBusinessRelation":{"type":"string","enum":["business_intermediary","spontaneous_approach","relation_with_existing_client","historical_client","distributor","tied_agent","family_relation_of_employee","family_relationship","electronic_platform","prospection","other"],"description":"Origin of the business relation."},"crsStatus":{"type":"string","enum":["crs_compliant","missing_documentation","conflicting_indicia","cbi_rbi_scheme","non_crs"],"description":"Common Reporting Standard status."},"listedCompany":{"type":"boolean","description":"Indicates whether the company is listed."},"regulatedEntity":{"type":"boolean","description":"Indicates whether the entity is regulated."},"stateOwnedEntity":{"type":"boolean","description":"Indicates whether the entity is state-owned."},"dmsLinkUrl":{"type":"string","format":"uri","maxLength":500,"description":"Optional link to the client's document management system (DMS) folder."}}},"ErrorResponse":{"type":"object","properties":{"error":{"type":"string","description":"Short description of the error"},"code":{"type":"integer","description":"Application-specific or HTTP error code"}}}}},"paths":{"/v1.1/business-relations":{"get":{"summary":"Retrieve business relations","description":"Returns business relations using cursor pagination. By default, terminated business relations are excluded unless `includeTerminated` is set to `true`.","tags":["Business relations"],"parameters":[{"in":"query","name":"includeTerminated","schema":{"type":"boolean","default":false},"description":"When set to `true`, the response will also contain business relations with a terminated status."},{"in":"query","name":"pageSize","required":false,"description":"Number of business relations to return per page (default 1000, max 5000)","schema":{"type":"integer","minimum":1,"maximum":5000,"default":1000}},{"in":"query","name":"cursor","required":false,"description":"Opaque pagination cursor returned by the previous page","schema":{"type":"string"}}],"responses":{"200":{"description":"Business relations retrieved successfully","content":{"application/json":{"schema":{"type":"object","required":["businessRelations"],"properties":{"businessRelations":{"type":"array","items":{"$ref":"#/components/schemas/BusinessRelation"}},"nextCursor":{"type":"string","nullable":true,"description":"Opaque cursor for fetching the next page; omitted or null when no more records are available"}}}}}},"400":{"description":"Bad request (invalid cursor)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized - Missing or invalid token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Unprocessable entity (invalid parameters)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}}
```
## POST /v1.1/business-relations
> Create a new business relation
```json
{"openapi":"3.0.3","info":{"title":"Apentis API","version":"1.1.0"},"tags":[{"name":"Business relations","description":"Endpoints for creating, retrieving, updating, and managing business relations (individuals and entities)."}],"servers":[{"url":"https://www.riskquadrant.com/api","description":"API for Production environment - Luxembourg"},{"url":"https://www.riskquadrant.ch/api","description":"API for Production environment - Switzerland"},{"url":"https://www.rq-test.com/api","description":"API for Test environment (for sandbox integration)"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"BusinessRelation":{"type":"object","discriminator":{"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/PersonBusinessRelation"},{"$ref":"#/components/schemas/CompanyBusinessRelation"}]},"PersonBusinessRelation":{"type":"object","required":["type","crmCode","firstName","lastName"],"properties":{"type":{"type":"string","enum":["Person"],"description":"Type of business relation."},"name":{"type":"string","description":"Full name of the person or organization."},"firstName":{"type":"string","description":"Required if the type is Person."},"lastName":{"type":"string","description":"Required if the type is Person."},"maidenName":{"type":"string","description":"Person's maiden name. Optional."},"nationality":{"type":"string","maxLength":2,"description":"ISO 2-letter nationality code. Applicable for persons."},"fiscalCountry":{"type":"string","maxLength":2,"description":"ISO 2-letter fiscal country code."},"address":{"type":"string","description":"Street address of the business relation."},"postalCode":{"type":"string","description":"Postal code of the business relation."},"city":{"type":"string","description":"City of the business relation."},"countryOfResidence":{"type":"string","maxLength":2,"description":"ISO 2-letter country of residence."},"language":{"type":"string","maxLength":2,"description":"Language code (ISO 639-1) of the business relation."},"birthDate":{"type":"string","format":"date","description":"Date of birth of the person (YYYY-MM-DD). Optional."},"placeOfBirth":{"type":"string","description":"Place of birth. Applicable for persons."},"phoneNumber":{"type":"string","description":"Phone number of the business relation. Optional."},"email":{"type":"string","format":"email","pattern":"^[\\w\\.-]+@[\\w\\.-]+\\.\\w{2,}$","description":"Email address. Optional. Must be a valid email format."},"relationshipStatus":{"type":"string","enum":["Client","Prospect","Contact","Investment"],"default":"Client","description":"Business relation type."},"relationStatus":{"type":"string","enum":["active","terminated"],"default":"active","description":"Status of the business relation."},"amlFrequency":{"type":"string","enum":["ongoing","one-time"],"default":"ongoing","description":"Frequency of AML checks (hits and adverse media) for the business relation. Defaults to `ongoing` when omitted."},"crmId":{"type":"string","format":"uuid","description":"Internal Apentis UUID that uniquely identifies the client."},"crmCode":{"type":"string","maxLength":100,"description":"Unique external identifier of the business relation from the calling system."},"service":{"type":"array","items":{"type":"string"},"description":"Services associated with the business relation. Default values provided by Apentis include: portfolio_management_discretionary, portfolio_management_advisory, portfolio_management_rto, portfolio_management_non_discretionary_advisory, fund_setup_and_administration, family_office, tax_planning_and_optimization, wealth_structuring, philanthropy_advisory, estate_planning. However, each client can configure its own list of acceptable values. Use the endpoint `/v1.1/business-relations/schema-config` to retrieve the list configured for your organisation.\n"},"branch":{"type":"array","description":"Branches associated with the business relation. Default values provided by Apentis include: organisation-specific branch identifiers. However, each client can configure its own list of acceptable values. Use the endpoint `/v1.1/business-relations/schema-config` to retrieve the list configured for your organisation.\n","items":{"type":"string"}},"maritalStatus":{"type":"string","enum":["Single","Married","Divorced","Separated","Widower","Other","Partnership"],"description":"Marital status of the person."},"taxIdentificationNumber":{"type":"string","description":"Tax identification number of the business relation."},"wealthSource":{"type":"array","description":"Sources of wealth of the business relation.","items":{"type":"string","enum":["entrepreneurial_activity","salaries_remuneration","inheritance","real_estate","financial_investments","donation_gifts_from_family","donation_gifts_from_others","divorce","loan_leverage","accumulated_profit","capital_from_shareholders","crypto_assets","company_sale_ma_exit","insurance_payout","pension_retirement_fund","litigation_compensation","lottery_gambling"]}},"bankAccountCountry":{"type":"string","maxLength":2,"description":"ISO 2-letter country code of the bank account."},"originOfBusinessRelation":{"type":"string","enum":["business_intermediary","spontaneous_approach","relation_with_existing_client","historical_client","distributor","tied_agent","family_relation_of_employee","family_relationship","electronic_platform","prospection","other"],"description":"Origin of the business relation."},"crsStatus":{"type":"string","enum":["crs_compliant","missing_documentation","conflicting_indicia","cbi_rbi_scheme","non_crs"],"description":"Common Reporting Standard status."},"dmsLinkUrl":{"type":"string","format":"uri","maxLength":500,"description":"Optional link to the client's document management system (DMS) folder."}}},"CompanyBusinessRelation":{"type":"object","required":["type","crmCode","name"],"properties":{"type":{"type":"string","enum":["Association","Company","Family","Foundation","Fund","Household","Insurance company","Insurance contract","Joint ownership","Partnership","Trust","Pension scheme"],"description":"Type of business relation."},"name":{"type":"string","description":"Full name of the person or organization."},"fiscalCountry":{"type":"string","maxLength":2,"description":"ISO 2-letter fiscal country code."},"countryOfOperation":{"type":"string","maxLength":2,"description":"ISO 2-letter country of operation. Applicable for companies."},"address":{"type":"string","description":"Street address of the business relation."},"postalCode":{"type":"string","description":"Postal code of the business relation."},"city":{"type":"string","description":"City of the business relation."},"countryOfResidence":{"type":"string","maxLength":2,"description":"ISO 2-letter country of residence."},"language":{"type":"string","maxLength":2,"description":"Language code (ISO 639-1) of the business relation."},"incorporationDate":{"type":"string","format":"date","description":"Date of incorporation for legal entities (YYYY-MM-DD)."},"phoneNumber":{"type":"string","description":"Phone number of the business relation. Optional."},"email":{"type":"string","format":"email","pattern":"^[\\w\\.-]+@[\\w\\.-]+\\.\\w{2,}$","description":"Email address. Optional. Must be a valid email format."},"relationshipStatus":{"type":"string","enum":["Client","Prospect","Contact","Investment"],"default":"Client","description":"Business relation type."},"relationStatus":{"type":"string","enum":["active","terminated"],"default":"active","description":"Status of the business relation."},"amlFrequency":{"type":"string","enum":["ongoing","one-time"],"default":"ongoing","description":"Frequency of AML checks (hits and adverse media) for the business relation. Defaults to `ongoing` when omitted."},"crmId":{"type":"string","format":"uuid","description":"Internal Apentis UUID that uniquely identifies the client."},"crmCode":{"type":"string","maxLength":100,"description":"Unique external identifier of the business relation from the calling system."},"service":{"type":"array","items":{"type":"string"},"description":"Services associated with the business relation. Default values provided by Apentis include: portfolio_management_discretionary, portfolio_management_advisory, portfolio_management_rto, portfolio_management_non_discretionary_advisory, fund_setup_and_administration, family_office, tax_planning_and_optimization, wealth_structuring, philanthropy_advisory, estate_planning. However, each client can configure its own list of acceptable values. Use the endpoint `/v1.1/business-relations/schema-config` to retrieve the list configured for your organisation.\n"},"taxIdentificationNumber":{"type":"string","description":"Tax identification number of the business relation."},"vatNumber":{"type":"string","description":"VAT number of the business relation."},"industrySector":{"type":"string","description":"Industry sector classification for the company. Default values provided by Apentis include: a_agriculture_forestry_and_fishing, b_mining_and_quarrying, c_manufacturing, d_electricity_gas_steam_and_air_conditioning_supply, e_water_supply_sewerage_waste_management_and_remediation, f_construction, g_wholesale_and_retail_trade_motor_vehicles, h_transporting_and_storage, i_accommodation_and_food_service_activities, j_information_and_communication, k_financial_and_insurance_activities, l_real_estate_activities, m_professional_scientific_and_technical_activities, n_administrative_and_support_service_activities, o_public_administration_and_defence, p_education, q_human_health_and_social_work_activities, r_arts_entertainment_and_recreation, s_other_services_activities, t_households_as_employers_and_own_use_activities, u_extraterritorial_organisations_and_bodies. However, each client can configure its own list of acceptable values. Use the endpoint `/v1.1/business-relations/schema-config` to retrieve the list configured for your organisation.\n"},"complexityOfBoStructure":{"type":"string","description":"Complexity level of the beneficial ownership structure. Default values provided by Apentis include: a_less_than_3_structure_level_in_eu_countries, b_less_than_3_structure_level_in_any_country, c_3_to_6_structure_level_in_eu_countries, d_3_to_6_structure_level_in_any_countries, e_more_than_6_structure_level. However, each client can configure its own list of acceptable values. Use the endpoint `/v1.1/business-relations/schema-config` to retrieve the list configured for your organisation.\n"},"branch":{"type":"array","description":"Branches associated with the business relation. Default values provided by Apentis include: organisation-specific branch identifiers. However, each client can configure its own list of acceptable values. Use the endpoint `/v1.1/business-relations/schema-config` to retrieve the list configured for your organisation.\n","items":{"type":"string"}},"legalForm":{"type":"string","enum":["testamentary","SA","Sarl","SCA","SCS","SCSp","SCoSA","FCP","SICAV","SICAF","SCSp SICAV SIF","SAS","FR","FI"],"description":"Legal form of the entity. Applicable for legal entities only."},"wealthSource":{"type":"array","description":"Sources of wealth of the business relation.","items":{"type":"string","enum":["entrepreneurial_activity","salaries_remuneration","inheritance","real_estate","financial_investments","donation_gifts_from_family","donation_gifts_from_others","divorce","loan_leverage","accumulated_profit","capital_from_shareholders","crypto_assets","company_sale_ma_exit","insurance_payout","pension_retirement_fund","litigation_compensation","lottery_gambling"]}},"bankAccountCountry":{"type":"string","maxLength":2,"description":"ISO 2-letter country code of the bank account."},"originOfBusinessRelation":{"type":"string","enum":["business_intermediary","spontaneous_approach","relation_with_existing_client","historical_client","distributor","tied_agent","family_relation_of_employee","family_relationship","electronic_platform","prospection","other"],"description":"Origin of the business relation."},"crsStatus":{"type":"string","enum":["crs_compliant","missing_documentation","conflicting_indicia","cbi_rbi_scheme","non_crs"],"description":"Common Reporting Standard status."},"listedCompany":{"type":"boolean","description":"Indicates whether the company is listed."},"regulatedEntity":{"type":"boolean","description":"Indicates whether the entity is regulated."},"stateOwnedEntity":{"type":"boolean","description":"Indicates whether the entity is state-owned."},"dmsLinkUrl":{"type":"string","format":"uri","maxLength":500,"description":"Optional link to the client's document management system (DMS) folder."}}},"ErrorResponse":{"type":"object","properties":{"error":{"type":"string","description":"Short description of the error"},"code":{"type":"integer","description":"Application-specific or HTTP error code"}}}}},"paths":{"/v1.1/business-relations":{"post":{"summary":"Create a new business relation","tags":["Business relations"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessRelation"}}}},"responses":{"201":{"description":"Business relation created successfully","content":{"application/json":{"schema":{"type":"object","properties":{"crmCode":{"type":"string"},"status":{"type":"string"}}}}}},"400":{"description":"Bad Request - Invalid input","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized - Missing or invalid token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"409":{"description":"Conflict - Already existing crmCode","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}}
```
## GET /v1.1/business-relations/{crmCode}
> Retrieve a business relation by crmCode
```json
{"openapi":"3.0.3","info":{"title":"Apentis API","version":"1.1.0"},"tags":[{"name":"Business relations","description":"Endpoints for creating, retrieving, updating, and managing business relations (individuals and entities)."}],"servers":[{"url":"https://www.riskquadrant.com/api","description":"API for Production environment - Luxembourg"},{"url":"https://www.riskquadrant.ch/api","description":"API for Production environment - Switzerland"},{"url":"https://www.rq-test.com/api","description":"API for Test environment (for sandbox integration)"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"BusinessRelation":{"type":"object","discriminator":{"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/PersonBusinessRelation"},{"$ref":"#/components/schemas/CompanyBusinessRelation"}]},"PersonBusinessRelation":{"type":"object","required":["type","crmCode","firstName","lastName"],"properties":{"type":{"type":"string","enum":["Person"],"description":"Type of business relation."},"name":{"type":"string","description":"Full name of the person or organization."},"firstName":{"type":"string","description":"Required if the type is Person."},"lastName":{"type":"string","description":"Required if the type is Person."},"maidenName":{"type":"string","description":"Person's maiden name. Optional."},"nationality":{"type":"string","maxLength":2,"description":"ISO 2-letter nationality code. Applicable for persons."},"fiscalCountry":{"type":"string","maxLength":2,"description":"ISO 2-letter fiscal country code."},"address":{"type":"string","description":"Street address of the business relation."},"postalCode":{"type":"string","description":"Postal code of the business relation."},"city":{"type":"string","description":"City of the business relation."},"countryOfResidence":{"type":"string","maxLength":2,"description":"ISO 2-letter country of residence."},"language":{"type":"string","maxLength":2,"description":"Language code (ISO 639-1) of the business relation."},"birthDate":{"type":"string","format":"date","description":"Date of birth of the person (YYYY-MM-DD). Optional."},"placeOfBirth":{"type":"string","description":"Place of birth. Applicable for persons."},"phoneNumber":{"type":"string","description":"Phone number of the business relation. Optional."},"email":{"type":"string","format":"email","pattern":"^[\\w\\.-]+@[\\w\\.-]+\\.\\w{2,}$","description":"Email address. Optional. Must be a valid email format."},"relationshipStatus":{"type":"string","enum":["Client","Prospect","Contact","Investment"],"default":"Client","description":"Business relation type."},"relationStatus":{"type":"string","enum":["active","terminated"],"default":"active","description":"Status of the business relation."},"amlFrequency":{"type":"string","enum":["ongoing","one-time"],"default":"ongoing","description":"Frequency of AML checks (hits and adverse media) for the business relation. Defaults to `ongoing` when omitted."},"crmId":{"type":"string","format":"uuid","description":"Internal Apentis UUID that uniquely identifies the client."},"crmCode":{"type":"string","maxLength":100,"description":"Unique external identifier of the business relation from the calling system."},"service":{"type":"array","items":{"type":"string"},"description":"Services associated with the business relation. Default values provided by Apentis include: portfolio_management_discretionary, portfolio_management_advisory, portfolio_management_rto, portfolio_management_non_discretionary_advisory, fund_setup_and_administration, family_office, tax_planning_and_optimization, wealth_structuring, philanthropy_advisory, estate_planning. However, each client can configure its own list of acceptable values. Use the endpoint `/v1.1/business-relations/schema-config` to retrieve the list configured for your organisation.\n"},"branch":{"type":"array","description":"Branches associated with the business relation. Default values provided by Apentis include: organisation-specific branch identifiers. However, each client can configure its own list of acceptable values. Use the endpoint `/v1.1/business-relations/schema-config` to retrieve the list configured for your organisation.\n","items":{"type":"string"}},"maritalStatus":{"type":"string","enum":["Single","Married","Divorced","Separated","Widower","Other","Partnership"],"description":"Marital status of the person."},"taxIdentificationNumber":{"type":"string","description":"Tax identification number of the business relation."},"wealthSource":{"type":"array","description":"Sources of wealth of the business relation.","items":{"type":"string","enum":["entrepreneurial_activity","salaries_remuneration","inheritance","real_estate","financial_investments","donation_gifts_from_family","donation_gifts_from_others","divorce","loan_leverage","accumulated_profit","capital_from_shareholders","crypto_assets","company_sale_ma_exit","insurance_payout","pension_retirement_fund","litigation_compensation","lottery_gambling"]}},"bankAccountCountry":{"type":"string","maxLength":2,"description":"ISO 2-letter country code of the bank account."},"originOfBusinessRelation":{"type":"string","enum":["business_intermediary","spontaneous_approach","relation_with_existing_client","historical_client","distributor","tied_agent","family_relation_of_employee","family_relationship","electronic_platform","prospection","other"],"description":"Origin of the business relation."},"crsStatus":{"type":"string","enum":["crs_compliant","missing_documentation","conflicting_indicia","cbi_rbi_scheme","non_crs"],"description":"Common Reporting Standard status."},"dmsLinkUrl":{"type":"string","format":"uri","maxLength":500,"description":"Optional link to the client's document management system (DMS) folder."}}},"CompanyBusinessRelation":{"type":"object","required":["type","crmCode","name"],"properties":{"type":{"type":"string","enum":["Association","Company","Family","Foundation","Fund","Household","Insurance company","Insurance contract","Joint ownership","Partnership","Trust","Pension scheme"],"description":"Type of business relation."},"name":{"type":"string","description":"Full name of the person or organization."},"fiscalCountry":{"type":"string","maxLength":2,"description":"ISO 2-letter fiscal country code."},"countryOfOperation":{"type":"string","maxLength":2,"description":"ISO 2-letter country of operation. Applicable for companies."},"address":{"type":"string","description":"Street address of the business relation."},"postalCode":{"type":"string","description":"Postal code of the business relation."},"city":{"type":"string","description":"City of the business relation."},"countryOfResidence":{"type":"string","maxLength":2,"description":"ISO 2-letter country of residence."},"language":{"type":"string","maxLength":2,"description":"Language code (ISO 639-1) of the business relation."},"incorporationDate":{"type":"string","format":"date","description":"Date of incorporation for legal entities (YYYY-MM-DD)."},"phoneNumber":{"type":"string","description":"Phone number of the business relation. Optional."},"email":{"type":"string","format":"email","pattern":"^[\\w\\.-]+@[\\w\\.-]+\\.\\w{2,}$","description":"Email address. Optional. Must be a valid email format."},"relationshipStatus":{"type":"string","enum":["Client","Prospect","Contact","Investment"],"default":"Client","description":"Business relation type."},"relationStatus":{"type":"string","enum":["active","terminated"],"default":"active","description":"Status of the business relation."},"amlFrequency":{"type":"string","enum":["ongoing","one-time"],"default":"ongoing","description":"Frequency of AML checks (hits and adverse media) for the business relation. Defaults to `ongoing` when omitted."},"crmId":{"type":"string","format":"uuid","description":"Internal Apentis UUID that uniquely identifies the client."},"crmCode":{"type":"string","maxLength":100,"description":"Unique external identifier of the business relation from the calling system."},"service":{"type":"array","items":{"type":"string"},"description":"Services associated with the business relation. Default values provided by Apentis include: portfolio_management_discretionary, portfolio_management_advisory, portfolio_management_rto, portfolio_management_non_discretionary_advisory, fund_setup_and_administration, family_office, tax_planning_and_optimization, wealth_structuring, philanthropy_advisory, estate_planning. However, each client can configure its own list of acceptable values. Use the endpoint `/v1.1/business-relations/schema-config` to retrieve the list configured for your organisation.\n"},"taxIdentificationNumber":{"type":"string","description":"Tax identification number of the business relation."},"vatNumber":{"type":"string","description":"VAT number of the business relation."},"industrySector":{"type":"string","description":"Industry sector classification for the company. Default values provided by Apentis include: a_agriculture_forestry_and_fishing, b_mining_and_quarrying, c_manufacturing, d_electricity_gas_steam_and_air_conditioning_supply, e_water_supply_sewerage_waste_management_and_remediation, f_construction, g_wholesale_and_retail_trade_motor_vehicles, h_transporting_and_storage, i_accommodation_and_food_service_activities, j_information_and_communication, k_financial_and_insurance_activities, l_real_estate_activities, m_professional_scientific_and_technical_activities, n_administrative_and_support_service_activities, o_public_administration_and_defence, p_education, q_human_health_and_social_work_activities, r_arts_entertainment_and_recreation, s_other_services_activities, t_households_as_employers_and_own_use_activities, u_extraterritorial_organisations_and_bodies. However, each client can configure its own list of acceptable values. Use the endpoint `/v1.1/business-relations/schema-config` to retrieve the list configured for your organisation.\n"},"complexityOfBoStructure":{"type":"string","description":"Complexity level of the beneficial ownership structure. Default values provided by Apentis include: a_less_than_3_structure_level_in_eu_countries, b_less_than_3_structure_level_in_any_country, c_3_to_6_structure_level_in_eu_countries, d_3_to_6_structure_level_in_any_countries, e_more_than_6_structure_level. However, each client can configure its own list of acceptable values. Use the endpoint `/v1.1/business-relations/schema-config` to retrieve the list configured for your organisation.\n"},"branch":{"type":"array","description":"Branches associated with the business relation. Default values provided by Apentis include: organisation-specific branch identifiers. However, each client can configure its own list of acceptable values. Use the endpoint `/v1.1/business-relations/schema-config` to retrieve the list configured for your organisation.\n","items":{"type":"string"}},"legalForm":{"type":"string","enum":["testamentary","SA","Sarl","SCA","SCS","SCSp","SCoSA","FCP","SICAV","SICAF","SCSp SICAV SIF","SAS","FR","FI"],"description":"Legal form of the entity. Applicable for legal entities only."},"wealthSource":{"type":"array","description":"Sources of wealth of the business relation.","items":{"type":"string","enum":["entrepreneurial_activity","salaries_remuneration","inheritance","real_estate","financial_investments","donation_gifts_from_family","donation_gifts_from_others","divorce","loan_leverage","accumulated_profit","capital_from_shareholders","crypto_assets","company_sale_ma_exit","insurance_payout","pension_retirement_fund","litigation_compensation","lottery_gambling"]}},"bankAccountCountry":{"type":"string","maxLength":2,"description":"ISO 2-letter country code of the bank account."},"originOfBusinessRelation":{"type":"string","enum":["business_intermediary","spontaneous_approach","relation_with_existing_client","historical_client","distributor","tied_agent","family_relation_of_employee","family_relationship","electronic_platform","prospection","other"],"description":"Origin of the business relation."},"crsStatus":{"type":"string","enum":["crs_compliant","missing_documentation","conflicting_indicia","cbi_rbi_scheme","non_crs"],"description":"Common Reporting Standard status."},"listedCompany":{"type":"boolean","description":"Indicates whether the company is listed."},"regulatedEntity":{"type":"boolean","description":"Indicates whether the entity is regulated."},"stateOwnedEntity":{"type":"boolean","description":"Indicates whether the entity is state-owned."},"dmsLinkUrl":{"type":"string","format":"uri","maxLength":500,"description":"Optional link to the client's document management system (DMS) folder."}}},"ErrorResponse":{"type":"object","properties":{"error":{"type":"string","description":"Short description of the error"},"code":{"type":"integer","description":"Application-specific or HTTP error code"}}}}},"paths":{"/v1.1/business-relations/{crmCode}":{"get":{"summary":"Retrieve a business relation by crmCode","tags":["Business relations"],"parameters":[{"in":"path","name":"crmCode","required":true,"schema":{"type":"string"},"description":"Unique external identifier of the business relation."}],"responses":{"200":{"description":"Business relation retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessRelation"}}}},"401":{"description":"Unauthorized - Missing or invalid token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found - Business relation not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}}
```
## PUT /v1.1/business-relations/{crmCode}
> Update an existing business relation
```json
{"openapi":"3.0.3","info":{"title":"Apentis API","version":"1.1.0"},"tags":[{"name":"Business relations","description":"Endpoints for creating, retrieving, updating, and managing business relations (individuals and entities)."}],"servers":[{"url":"https://www.riskquadrant.com/api","description":"API for Production environment - Luxembourg"},{"url":"https://www.riskquadrant.ch/api","description":"API for Production environment - Switzerland"},{"url":"https://www.rq-test.com/api","description":"API for Test environment (for sandbox integration)"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"BusinessRelation":{"type":"object","discriminator":{"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/PersonBusinessRelation"},{"$ref":"#/components/schemas/CompanyBusinessRelation"}]},"PersonBusinessRelation":{"type":"object","required":["type","crmCode","firstName","lastName"],"properties":{"type":{"type":"string","enum":["Person"],"description":"Type of business relation."},"name":{"type":"string","description":"Full name of the person or organization."},"firstName":{"type":"string","description":"Required if the type is Person."},"lastName":{"type":"string","description":"Required if the type is Person."},"maidenName":{"type":"string","description":"Person's maiden name. Optional."},"nationality":{"type":"string","maxLength":2,"description":"ISO 2-letter nationality code. Applicable for persons."},"fiscalCountry":{"type":"string","maxLength":2,"description":"ISO 2-letter fiscal country code."},"address":{"type":"string","description":"Street address of the business relation."},"postalCode":{"type":"string","description":"Postal code of the business relation."},"city":{"type":"string","description":"City of the business relation."},"countryOfResidence":{"type":"string","maxLength":2,"description":"ISO 2-letter country of residence."},"language":{"type":"string","maxLength":2,"description":"Language code (ISO 639-1) of the business relation."},"birthDate":{"type":"string","format":"date","description":"Date of birth of the person (YYYY-MM-DD). Optional."},"placeOfBirth":{"type":"string","description":"Place of birth. Applicable for persons."},"phoneNumber":{"type":"string","description":"Phone number of the business relation. Optional."},"email":{"type":"string","format":"email","pattern":"^[\\w\\.-]+@[\\w\\.-]+\\.\\w{2,}$","description":"Email address. Optional. Must be a valid email format."},"relationshipStatus":{"type":"string","enum":["Client","Prospect","Contact","Investment"],"default":"Client","description":"Business relation type."},"relationStatus":{"type":"string","enum":["active","terminated"],"default":"active","description":"Status of the business relation."},"amlFrequency":{"type":"string","enum":["ongoing","one-time"],"default":"ongoing","description":"Frequency of AML checks (hits and adverse media) for the business relation. Defaults to `ongoing` when omitted."},"crmId":{"type":"string","format":"uuid","description":"Internal Apentis UUID that uniquely identifies the client."},"crmCode":{"type":"string","maxLength":100,"description":"Unique external identifier of the business relation from the calling system."},"service":{"type":"array","items":{"type":"string"},"description":"Services associated with the business relation. Default values provided by Apentis include: portfolio_management_discretionary, portfolio_management_advisory, portfolio_management_rto, portfolio_management_non_discretionary_advisory, fund_setup_and_administration, family_office, tax_planning_and_optimization, wealth_structuring, philanthropy_advisory, estate_planning. However, each client can configure its own list of acceptable values. Use the endpoint `/v1.1/business-relations/schema-config` to retrieve the list configured for your organisation.\n"},"branch":{"type":"array","description":"Branches associated with the business relation. Default values provided by Apentis include: organisation-specific branch identifiers. However, each client can configure its own list of acceptable values. Use the endpoint `/v1.1/business-relations/schema-config` to retrieve the list configured for your organisation.\n","items":{"type":"string"}},"maritalStatus":{"type":"string","enum":["Single","Married","Divorced","Separated","Widower","Other","Partnership"],"description":"Marital status of the person."},"taxIdentificationNumber":{"type":"string","description":"Tax identification number of the business relation."},"wealthSource":{"type":"array","description":"Sources of wealth of the business relation.","items":{"type":"string","enum":["entrepreneurial_activity","salaries_remuneration","inheritance","real_estate","financial_investments","donation_gifts_from_family","donation_gifts_from_others","divorce","loan_leverage","accumulated_profit","capital_from_shareholders","crypto_assets","company_sale_ma_exit","insurance_payout","pension_retirement_fund","litigation_compensation","lottery_gambling"]}},"bankAccountCountry":{"type":"string","maxLength":2,"description":"ISO 2-letter country code of the bank account."},"originOfBusinessRelation":{"type":"string","enum":["business_intermediary","spontaneous_approach","relation_with_existing_client","historical_client","distributor","tied_agent","family_relation_of_employee","family_relationship","electronic_platform","prospection","other"],"description":"Origin of the business relation."},"crsStatus":{"type":"string","enum":["crs_compliant","missing_documentation","conflicting_indicia","cbi_rbi_scheme","non_crs"],"description":"Common Reporting Standard status."},"dmsLinkUrl":{"type":"string","format":"uri","maxLength":500,"description":"Optional link to the client's document management system (DMS) folder."}}},"CompanyBusinessRelation":{"type":"object","required":["type","crmCode","name"],"properties":{"type":{"type":"string","enum":["Association","Company","Family","Foundation","Fund","Household","Insurance company","Insurance contract","Joint ownership","Partnership","Trust","Pension scheme"],"description":"Type of business relation."},"name":{"type":"string","description":"Full name of the person or organization."},"fiscalCountry":{"type":"string","maxLength":2,"description":"ISO 2-letter fiscal country code."},"countryOfOperation":{"type":"string","maxLength":2,"description":"ISO 2-letter country of operation. Applicable for companies."},"address":{"type":"string","description":"Street address of the business relation."},"postalCode":{"type":"string","description":"Postal code of the business relation."},"city":{"type":"string","description":"City of the business relation."},"countryOfResidence":{"type":"string","maxLength":2,"description":"ISO 2-letter country of residence."},"language":{"type":"string","maxLength":2,"description":"Language code (ISO 639-1) of the business relation."},"incorporationDate":{"type":"string","format":"date","description":"Date of incorporation for legal entities (YYYY-MM-DD)."},"phoneNumber":{"type":"string","description":"Phone number of the business relation. Optional."},"email":{"type":"string","format":"email","pattern":"^[\\w\\.-]+@[\\w\\.-]+\\.\\w{2,}$","description":"Email address. Optional. Must be a valid email format."},"relationshipStatus":{"type":"string","enum":["Client","Prospect","Contact","Investment"],"default":"Client","description":"Business relation type."},"relationStatus":{"type":"string","enum":["active","terminated"],"default":"active","description":"Status of the business relation."},"amlFrequency":{"type":"string","enum":["ongoing","one-time"],"default":"ongoing","description":"Frequency of AML checks (hits and adverse media) for the business relation. Defaults to `ongoing` when omitted."},"crmId":{"type":"string","format":"uuid","description":"Internal Apentis UUID that uniquely identifies the client."},"crmCode":{"type":"string","maxLength":100,"description":"Unique external identifier of the business relation from the calling system."},"service":{"type":"array","items":{"type":"string"},"description":"Services associated with the business relation. Default values provided by Apentis include: portfolio_management_discretionary, portfolio_management_advisory, portfolio_management_rto, portfolio_management_non_discretionary_advisory, fund_setup_and_administration, family_office, tax_planning_and_optimization, wealth_structuring, philanthropy_advisory, estate_planning. However, each client can configure its own list of acceptable values. Use the endpoint `/v1.1/business-relations/schema-config` to retrieve the list configured for your organisation.\n"},"taxIdentificationNumber":{"type":"string","description":"Tax identification number of the business relation."},"vatNumber":{"type":"string","description":"VAT number of the business relation."},"industrySector":{"type":"string","description":"Industry sector classification for the company. Default values provided by Apentis include: a_agriculture_forestry_and_fishing, b_mining_and_quarrying, c_manufacturing, d_electricity_gas_steam_and_air_conditioning_supply, e_water_supply_sewerage_waste_management_and_remediation, f_construction, g_wholesale_and_retail_trade_motor_vehicles, h_transporting_and_storage, i_accommodation_and_food_service_activities, j_information_and_communication, k_financial_and_insurance_activities, l_real_estate_activities, m_professional_scientific_and_technical_activities, n_administrative_and_support_service_activities, o_public_administration_and_defence, p_education, q_human_health_and_social_work_activities, r_arts_entertainment_and_recreation, s_other_services_activities, t_households_as_employers_and_own_use_activities, u_extraterritorial_organisations_and_bodies. However, each client can configure its own list of acceptable values. Use the endpoint `/v1.1/business-relations/schema-config` to retrieve the list configured for your organisation.\n"},"complexityOfBoStructure":{"type":"string","description":"Complexity level of the beneficial ownership structure. Default values provided by Apentis include: a_less_than_3_structure_level_in_eu_countries, b_less_than_3_structure_level_in_any_country, c_3_to_6_structure_level_in_eu_countries, d_3_to_6_structure_level_in_any_countries, e_more_than_6_structure_level. However, each client can configure its own list of acceptable values. Use the endpoint `/v1.1/business-relations/schema-config` to retrieve the list configured for your organisation.\n"},"branch":{"type":"array","description":"Branches associated with the business relation. Default values provided by Apentis include: organisation-specific branch identifiers. However, each client can configure its own list of acceptable values. Use the endpoint `/v1.1/business-relations/schema-config` to retrieve the list configured for your organisation.\n","items":{"type":"string"}},"legalForm":{"type":"string","enum":["testamentary","SA","Sarl","SCA","SCS","SCSp","SCoSA","FCP","SICAV","SICAF","SCSp SICAV SIF","SAS","FR","FI"],"description":"Legal form of the entity. Applicable for legal entities only."},"wealthSource":{"type":"array","description":"Sources of wealth of the business relation.","items":{"type":"string","enum":["entrepreneurial_activity","salaries_remuneration","inheritance","real_estate","financial_investments","donation_gifts_from_family","donation_gifts_from_others","divorce","loan_leverage","accumulated_profit","capital_from_shareholders","crypto_assets","company_sale_ma_exit","insurance_payout","pension_retirement_fund","litigation_compensation","lottery_gambling"]}},"bankAccountCountry":{"type":"string","maxLength":2,"description":"ISO 2-letter country code of the bank account."},"originOfBusinessRelation":{"type":"string","enum":["business_intermediary","spontaneous_approach","relation_with_existing_client","historical_client","distributor","tied_agent","family_relation_of_employee","family_relationship","electronic_platform","prospection","other"],"description":"Origin of the business relation."},"crsStatus":{"type":"string","enum":["crs_compliant","missing_documentation","conflicting_indicia","cbi_rbi_scheme","non_crs"],"description":"Common Reporting Standard status."},"listedCompany":{"type":"boolean","description":"Indicates whether the company is listed."},"regulatedEntity":{"type":"boolean","description":"Indicates whether the entity is regulated."},"stateOwnedEntity":{"type":"boolean","description":"Indicates whether the entity is state-owned."},"dmsLinkUrl":{"type":"string","format":"uri","maxLength":500,"description":"Optional link to the client's document management system (DMS) folder."}}},"ErrorResponse":{"type":"object","properties":{"error":{"type":"string","description":"Short description of the error"},"code":{"type":"integer","description":"Application-specific or HTTP error code"}}}}},"paths":{"/v1.1/business-relations/{crmCode}":{"put":{"summary":"Update an existing business relation","tags":["Business relations"],"parameters":[{"in":"path","name":"crmCode","required":true,"schema":{"type":"string"},"description":"Unique external identifier of the business relation."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessRelation"}}}},"responses":{"200":{"description":"Business relation updated successfully","content":{"application/json":{"schema":{"type":"object","properties":{"crmCode":{"type":"string"},"status":{"type":"string"}}}}}},"400":{"description":"Bad Request - Invalid input","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized - Missing or invalid token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found - Business relation with specified crmCode not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}}
```
---
# Agent Instructions: Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter:
```
GET https://apentis.gitbook.io/apentis-api/api-reference/business-relations.md?ask=
```
The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.