# Models ## The BusinessRelationSchemaField object ```json {"openapi":"3.0.3","info":{"title":"Apentis API","version":"1.1.0"},"components":{"schemas":{"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."}}}}}} ``` ## The TenantBusinessRelationSchemaResponse object ```json {"openapi":"3.0.3","info":{"title":"Apentis API","version":"1.1.0"},"components":{"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."}}}}}} ``` ## The DocumentTypeEnum object ```json {"openapi":"3.0.3","info":{"title":"Apentis API","version":"1.1.0"},"components":{"schemas":{"DocumentTypeEnum":{"type":"string","description":"Document types. See the \"Document types\" reference list in GitBook.","enum":["account_valuation","Acknowledgement of receipt","Advisory mandate contract","AML risk assessment","aml_letter","Annual accounts (audited)","Annual accounts (unaudited)","Annual report","articles_of_incorporation","Bank account details","Bank statement","business_continuity_plan","Certificate of accommodation","Certificate of good standing","certificate of incorporation","Certificate of incumbency","Certificate of insurance","Civil partnership certificate","Client acceptance doc","client_profile","Collateral agreement","Consumer loan agreement","Copy of transaction notices","Corporate structure","Criminal record","CRS self-certification","DAC 6","death_certificate","declaration_of_BO","deed","Discretionary mandate contract","Divorce judgment","Driving licence","Eligibility assessment","Employment certificate","Employment contract","End of relationship doc","Engagement letter","entering business relationship","Family record book","FATCA classification","Financial statement","Financing plan","general_conditions","Health insurance card","ID card scan","investment_profile","KYC Form","kyc_report","Life insurance contract","list_authorized_signatures","Management agreement","Marriage certificate","Memorandum of association","MIFID classification","MIFID form","Mortgage loan agreement","name_check","Others","Passport","Pay slip","Phone subscription","power_of_attorney","Proof of domicile","Proof of listing","Proof of origin of capital","Proof of regulation","Proof of supervision","PV board of directors","PV BoD","PV general assembly","RCS","Register of beneficial owners","Register of directors","Register of shareholders","Resident card","RTO mandate contract","Separation agreement","Status","Structure chart","Tax notice","Tax registration number","termination_letter","Trade / Economic license","Transaction record","Tripartite agreement","Unique Identification Number","utility_bill","VAT registration certificate","VISA page","visit_report","W-8BEN","W-9"]}}}} ``` ## The BusinessRelation object ```json {"openapi":"3.0.3","info":{"title":"Apentis API","version":"1.1.0"},"components":{"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."}}}}}} ``` ## The PersonBusinessRelation object ```json {"openapi":"3.0.3","info":{"title":"Apentis API","version":"1.1.0"},"components":{"schemas":{"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."}}}}}} ``` ## The CompanyBusinessRelation object ```json {"openapi":"3.0.3","info":{"title":"Apentis API","version":"1.1.0"},"components":{"schemas":{"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."}}}}}} ``` ## The InvestorCommitment object ```json {"openapi":"3.0.3","info":{"title":"Apentis API","version":"1.1.0"},"components":{"schemas":{"InvestorCommitment":{"type":"object","required":["fundId","commitmentAmount","commitmentCurrency","commitmentDate"],"properties":{"fundId":{"type":"string","maxLength":100,"description":"Unique identifier of the fund"},"commitmentAmount":{"type":"number","format":"double","description":"Amount committed to the fund"},"commitmentCurrency":{"type":"string","pattern":"^[A-Z]{3}$","description":"ISO 4217 currency code (e.g., EUR, USD)"},"commitmentDate":{"type":"string","format":"date","description":"Commitment date in YYYY-MM-DD format"}}}}}} ``` ## The DocumentMetadata object ```json {"openapi":"3.0.3","info":{"title":"Apentis API","version":"1.1.0"},"components":{"schemas":{"DocumentMetadata":{"type":"object","required":["documentName","documentType"],"properties":{"documentName":{"type":"string","maxLength":200},"documentType":{"$ref":"#/components/schemas/DocumentTypeEnum"},"hasPhysicalFile":{"type":"boolean","description":"Indicates whether a physical document file is stored alongside this metadata entry."},"issuanceDate":{"type":"string","format":"date","description":"Date of issuance of the document (YYYY-MM-DD). Optional."},"expirationDate":{"type":"string","format":"date","description":"Date of expiration of the document (YYYY-MM-DD). Optional."},"documentNumber":{"type":"string","maxLength":30,"description":"Document identification number (e.g., passport or ID card number)."},"isCertifiedTrueCopy":{"type":"boolean","description":"Indicates whether the uploaded document is a certified true copy."},"documentIssuer":{"type":"string","maxLength":2,"description":"ISO 2-letter country code of the country that has issued the document (e.g., 'US', 'FR')."}}},"DocumentTypeEnum":{"type":"string","description":"Document types. See the \"Document types\" reference list in GitBook.","enum":["account_valuation","Acknowledgement of receipt","Advisory mandate contract","AML risk assessment","aml_letter","Annual accounts (audited)","Annual accounts (unaudited)","Annual report","articles_of_incorporation","Bank account details","Bank statement","business_continuity_plan","Certificate of accommodation","Certificate of good standing","certificate of incorporation","Certificate of incumbency","Certificate of insurance","Civil partnership certificate","Client acceptance doc","client_profile","Collateral agreement","Consumer loan agreement","Copy of transaction notices","Corporate structure","Criminal record","CRS self-certification","DAC 6","death_certificate","declaration_of_BO","deed","Discretionary mandate contract","Divorce judgment","Driving licence","Eligibility assessment","Employment certificate","Employment contract","End of relationship doc","Engagement letter","entering business relationship","Family record book","FATCA classification","Financial statement","Financing plan","general_conditions","Health insurance card","ID card scan","investment_profile","KYC Form","kyc_report","Life insurance contract","list_authorized_signatures","Management agreement","Marriage certificate","Memorandum of association","MIFID classification","MIFID form","Mortgage loan agreement","name_check","Others","Passport","Pay slip","Phone subscription","power_of_attorney","Proof of domicile","Proof of listing","Proof of origin of capital","Proof of regulation","Proof of supervision","PV board of directors","PV BoD","PV general assembly","RCS","Register of beneficial owners","Register of directors","Register of shareholders","Resident card","RTO mandate contract","Separation agreement","Status","Structure chart","Tax notice","Tax registration number","termination_letter","Trade / Economic license","Transaction record","Tripartite agreement","Unique Identification Number","utility_bill","VAT registration certificate","VISA page","visit_report","W-8BEN","W-9"]}}}} ``` ## The DocumentFilePayload object ```json {"openapi":"3.0.3","info":{"title":"Apentis API","version":"1.1.0"},"components":{"schemas":{"DocumentFilePayload":{"type":"object","description":"Binary payload of a stored document returned by the download endpoint.","required":["fileName","contentType","contentBase64"],"properties":{"fileName":{"type":"string","description":"Original name of the uploaded document."},"contentType":{"type":"string","description":"MIME type of the stored file (e.g., application/pdf, image/jpeg)."},"fileSizeBytes":{"type":"integer","format":"int64","description":"Size of the document in bytes."},"contentBase64":{"type":"string","format":"byte","description":"Base64-encoded binary content of the document for direct retrieval via the API."}}}}}} ``` ## The AmlKycResult object ```json {"openapi":"3.0.3","info":{"title":"Apentis API","version":"1.1.0"},"components":{"schemas":{"AmlKycResult":{"type":"object","properties":{"amlRiskRating":{"type":"string","enum":["low","medium","high"],"description":"The overall risk level assigned to a business relation based on the combination of screening results (PEP, sanctions, adverse media), country risk, business activity, and other risk attributes. It determines whether the relationship is considered Low, Medium, or High risk from an Anti-Money Laundering and Counter-Terrorism Financing (AML/CTF) standpoint."},"dueDiligenceType":{"type":"string","enum":["simplified","standard","enhanced"],"description":"Specifies whether the business relation requires additional verification and monitoring measures beyond standard KYC checks, due to the AML risk level or specific red flags."},"relationAcceptanceStatus":{"type":"string","enum":["approved","conditional","revoked"],"description":"Indicates the internal decision regarding the acceptance of the business relation following the AML assessment."},"accountStatus":{"type":"string","enum":["active","soft blocked","hard blocked"],"description":"Shows the operational status of the client’s account based on AML findings and internal controls."},"blockingReason":{"type":"string","enum":["account_opening_pending_approval","aml_escalation_suspicious","aml_review_pending","expired_kyc","fiu_regulatory_request","fraud","legal","missing_documents","tax_non_compliance"],"description":"Optional reason for account blocking; applicable only when accountStatus is soft blocked or hard blocked."},"nbrHits":{"type":"integer","format":"int32","description":"Total number of AML screening hits identified for the business relation."},"nbrArticles":{"type":"integer","format":"int32","description":"Total number of adverse media (bad press) articles linked to the business relation."},"isPep":{"type":"boolean","description":"Whether the business relation is identified as a Politically Exposed Person (PEP)."},"isSanctioned":{"type":"boolean","description":"Whether the business relation appears on a sanctions list."},"amlReviewedBy":{"type":"string","description":"Name or identifier of the compliance officer who last reviewed the AML data."},"amlReviewDate":{"type":"string","format":"date","description":"Date (YYYY-MM-DD) when the AML review was performed."},"kycStatus":{"type":"string","enum":["to review","reviewed"],"description":"KYC review status of the business relation."},"lastKycReviewDate":{"type":"string","format":"date","description":"Date of the most recent KYC review (YYYY-MM-DD)."},"nextKycReviewDate":{"type":"string","format":"date","description":"Date of the next KYC review (YYYY-MM-DD)."},"missingDocuments":{"type":"array","items":{"$ref":"#/components/schemas/DocumentTypeEnum"},"description":"List of missing document types."},"expiredDocuments":{"type":"array","items":{"$ref":"#/components/schemas/DocumentTypeEnum"},"description":"List of expired document types."},"kycReviewedBy":{"type":"string","description":"Name or identifier of the compliance officer who last reviewed the KYC data."},"kycReviewDate":{"type":"string","format":"date","description":"Date (YYYY-MM-DD) when the KYC review was performed."}}},"DocumentTypeEnum":{"type":"string","description":"Document types. See the \"Document types\" reference list in GitBook.","enum":["account_valuation","Acknowledgement of receipt","Advisory mandate contract","AML risk assessment","aml_letter","Annual accounts (audited)","Annual accounts (unaudited)","Annual report","articles_of_incorporation","Bank account details","Bank statement","business_continuity_plan","Certificate of accommodation","Certificate of good standing","certificate of incorporation","Certificate of incumbency","Certificate of insurance","Civil partnership certificate","Client acceptance doc","client_profile","Collateral agreement","Consumer loan agreement","Copy of transaction notices","Corporate structure","Criminal record","CRS self-certification","DAC 6","death_certificate","declaration_of_BO","deed","Discretionary mandate contract","Divorce judgment","Driving licence","Eligibility assessment","Employment certificate","Employment contract","End of relationship doc","Engagement letter","entering business relationship","Family record book","FATCA classification","Financial statement","Financing plan","general_conditions","Health insurance card","ID card scan","investment_profile","KYC Form","kyc_report","Life insurance contract","list_authorized_signatures","Management agreement","Marriage certificate","Memorandum of association","MIFID classification","MIFID form","Mortgage loan agreement","name_check","Others","Passport","Pay slip","Phone subscription","power_of_attorney","Proof of domicile","Proof of listing","Proof of origin of capital","Proof of regulation","Proof of supervision","PV board of directors","PV BoD","PV general assembly","RCS","Register of beneficial owners","Register of directors","Register of shareholders","Resident card","RTO mandate contract","Separation agreement","Status","Structure chart","Tax notice","Tax registration number","termination_letter","Trade / Economic license","Transaction record","Tripartite agreement","Unique Identification Number","utility_bill","VAT registration certificate","VISA page","visit_report","W-8BEN","W-9"]}}}} ``` ## The BusinessRelationLink object ```json {"openapi":"3.0.3","info":{"title":"Apentis API","version":"1.1.0"},"components":{"schemas":{"BusinessRelationLink":{"type":"object","required":["linkedCrmCode","role"],"properties":{"linkedCrmCode":{"type":"string","maxLength":100,"description":"The crmCode of the business relation to link (e.g., a person)."},"role":{"type":"string","enum":["Director","Board member","Trustee","Protector","Settlor","Beneficiary of the trust","Key person","Corporate director","President","Treasurer","Secretary","General partner","Limited partner","Beneficial owner","Member","Shareholder"],"description":"The role of the linked business relation in relation to the main one. Please see the GitBook documentation to see authorized links between entities."}}}}}} ``` ## The BusinessRelationLinkDeleteRequest object ```json {"openapi":"3.0.3","info":{"title":"Apentis API","version":"1.1.0"},"components":{"schemas":{"BusinessRelationLinkDeleteRequest":{"type":"array","items":{"type":"object","required":["linkedCrmCode","role"],"properties":{"linkedCrmCode":{"type":"string","maxLength":100,"description":"The CRM code of the related business relation to unlink."},"role":{"type":"string","enum":["Director","Board member","Trustee","Protector","Settlor","Beneficiary of the trust","Key person","Corporate director","President","Treasurer","Secretary","General partner","Limited partner","Beneficial owner","Member","Shareholder"],"description":"Role to remove from the relationship."}}}}}}} ``` ## The CashTransaction object ```json {"openapi":"3.0.3","info":{"title":"Apentis API","version":"1.1.0"},"components":{"schemas":{"CashTransaction":{"type":"object","required":["crmCode","transactionDate","portfolioId","currency","amount","transactionType","externalTransactionId"],"properties":{"crmCode":{"type":"string","maxLength":100,"description":"Business relation executing the transaction"},"transactionDate":{"type":"string","format":"date","description":"Transaction date in YYYY-MM-DD format"},"valueDate":{"type":"string","format":"date","description":"Date of value or settlement in YYYY-MM-DD format (optional)"},"portfolioId":{"type":"string","maxLength":100,"description":"Identifier of the account or portfolio"},"currency":{"type":"string","pattern":"^[A-Z]{3}$","description":"ISO 4217 currency code (e.g., EUR, USD)"},"amount":{"type":"number","format":"double","description":"Net cash amount of the transaction"},"transactionType":{"type":"string","enum":["dividend","coupon","interest-payment","bond-reimbursement","forex","cash-transfer","fee","tax","time-deposit","loan","margin-call","capital-call","distribution","other"],"description":"Type of transaction"},"transactionDirection":{"type":"string","enum":["inflow","outflow"]},"description":{"type":"string","maxLength":200,"description":"Optional free-text description"},"externalTransactionId":{"type":"string","maxLength":100,"description":"Unique transaction ID from the external system"},"originCountry":{"type":"string","maxLength":2,"pattern":"^[A-Z]{2}$","description":"ISO 2-letter country code of the transaction's origin (e.g., FR)"},"originIban":{"type":"string","maxLength":34,"description":"IBAN of the originating bank account"},"originatorName":{"type":"string","maxLength":100,"description":"Name of the counterparty sending the funds"},"destinationCountry":{"type":"string","maxLength":2,"pattern":"^[A-Z]{2}$","description":"ISO 2-letter country code of the transaction's destination (e.g., DE)"},"destinationIban":{"type":"string","maxLength":34,"description":"IBAN of the beneficiary bank account"},"beneficiaryName":{"type":"string","maxLength":100,"description":"Name of the counterparty receiving the funds"},"complianceNote":{"type":"string","maxLength":200,"description":"Optional field from the back office with context or risk flag"},"isInternalTransfer":{"type":"boolean","description":"Indicates if the cash movement is internal (between client’s own portfolios)"},"isSuspicious":{"type":"boolean","description":"Optional pre-flag from source system if already suspected"}}}}}} ``` ## The CashFlowResult object ```json {"openapi":"3.0.3","info":{"title":"Apentis API","version":"1.1.0"},"components":{"schemas":{"CashFlowResult":{"type":"object","properties":{"externalTransactionId":{"type":"string"},"crmCode":{"type":"string"},"portfolioId":{"type":"string"},"transactionDate":{"type":"string","format":"date"},"analysisResult":{"type":"object","properties":{"status":{"type":"string","enum":["clear","flagged","pending-review"]},"riskScore":{"type":"integer","minimum":0,"maximum":100},"riskLevel":{"type":"string","enum":["low","medium","high"]},"automatedComment":{"type":"string"},"screeningHits":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"details":{"type":"string"}}}}}},"complianceReview":{"type":"object","properties":{"reviewedBy":{"type":"string"},"reviewDate":{"type":"string","format":"date"},"status":{"type":"string","enum":["approved","under_investigation","escalated","dismissed"]},"comment":{"type":"string"}}}}}}}} ``` ## The CustodianAvailability object ```json {"openapi":"3.0.3","info":{"title":"Apentis API","version":"1.1.0"},"components":{"schemas":{"CustodianAvailability":{"type":"object","required":["custodianId"],"properties":{"custodianId":{"type":"string","description":"Custodian code (custodian ID code provided by Apentis)"},"positionsStatus":{"type":"string","nullable":true,"description":"Aggregated status across all portfolios at this custodian","enum":["COMPLETE","PARTIAL","LOADING","FAILED"]},"positionsLoadedAt":{"type":"string","format":"date-time","nullable":true,"description":"Latest contributing portfolio timestamp (UTC)"},"positionsIngestionRuns":{"type":"array","items":{"type":"string"},"description":"Distinct ingestion run IDs that contributed to the status"},"transactionsStatus":{"type":"string","nullable":true,"enum":["COMPLETE","PARTIAL","LOADING","FAILED"]},"transactionsLoadedAt":{"type":"string","format":"date-time","nullable":true},"transactionsIngestionRuns":{"type":"array","items":{"type":"string"}},"notes":{"type":"string","nullable":true,"description":"Short diagnostic text (present only if includeNotes=true)"}}}}}} ``` ## The AvailabilitySingleDate object ```json {"openapi":"3.0.3","info":{"title":"Apentis API","version":"1.1.0"},"components":{"schemas":{"AvailabilitySingleDate":{"type":"object","required":["asOfDate","custodians"],"properties":{"asOfDate":{"type":"string","format":"date"},"custodians":{"type":"array","items":{"$ref":"#/components/schemas/CustodianAvailability"}}}},"CustodianAvailability":{"type":"object","required":["custodianId"],"properties":{"custodianId":{"type":"string","description":"Custodian code (custodian ID code provided by Apentis)"},"positionsStatus":{"type":"string","nullable":true,"description":"Aggregated status across all portfolios at this custodian","enum":["COMPLETE","PARTIAL","LOADING","FAILED"]},"positionsLoadedAt":{"type":"string","format":"date-time","nullable":true,"description":"Latest contributing portfolio timestamp (UTC)"},"positionsIngestionRuns":{"type":"array","items":{"type":"string"},"description":"Distinct ingestion run IDs that contributed to the status"},"transactionsStatus":{"type":"string","nullable":true,"enum":["COMPLETE","PARTIAL","LOADING","FAILED"]},"transactionsLoadedAt":{"type":"string","format":"date-time","nullable":true},"transactionsIngestionRuns":{"type":"array","items":{"type":"string"}},"notes":{"type":"string","nullable":true,"description":"Short diagnostic text (present only if includeNotes=true)"}}}}}} ``` ## The SecurityOtherCode object ```json {"openapi":"3.0.3","info":{"title":"Apentis API","version":"1.1.0"},"components":{"schemas":{"SecurityOtherCode":{"type":"object","required":["scheme","value"],"properties":{"scheme":{"type":"string","description":"Identifier scheme (e.g., ISIN, Bloomberg, CUSIP)"},"value":{"type":"string","description":"Code value in the given scheme"}}}}}} ``` ## The SecurityIndustryEnum object ```json {"openapi":"3.0.3","info":{"title":"Apentis API","version":"1.1.0"},"components":{"schemas":{"SecurityIndustryEnum":{"type":"string","description":"Security industry code (see GitBook reference)","enum":["-","AC","BK","CDA","CG","CPS","DF","EN","FBT","FSR","HCES","HPP","HRL","IN","MA","ME","PB","RE","RT","SS","SSE","THE","TR","TS","UT"]}}}} ``` ## The SecuritySectorEnum object ```json {"openapi":"3.0.3","info":{"title":"Apentis API","version":"1.1.0"},"components":{"schemas":{"SecuritySectorEnum":{"type":"string","description":"Security sector code (see GitBook reference)","enum":["-","CD","CS","EN","FN","HC","ID","IT","MA","Others","RE","TE","UT"]}}}} ``` ## The SecurityAssetClassEnum object ```json {"openapi":"3.0.3","info":{"title":"Apentis API","version":"1.1.0"},"components":{"schemas":{"SecurityAssetClassEnum":{"type":"string","description":"Asset class code (see GitBook reference)","enum":["AR","CA","CC","CF","CO","CV","DE","EQ","FI","FRN","FX","HF","MAC","MZ","NFA","OTHER","PD","PE","PP","RE","RLI","SE","SP","VOL","YI"]}}}} ``` ## The PositionRecord object ```json {"openapi":"3.0.3","info":{"title":"Apentis API","version":"1.1.0"},"components":{"schemas":{"PositionRecord":{"type":"object","required":["date","portfolioCustodianId","portfolioId","portfolioCurrencyId","crmCode","isCash","quantity","marketValueSecurityCcy","marketValuePortfolioCcy","custodianId","importationTime"],"properties":{"date":{"type":"string","format":"date","description":"Position date (YYYY-MM-DD)"},"portfolioCustodianId":{"type":"string","description":"Portfolio/account code at custodian"},"portfolioId":{"type":"string","description":"Apentis portfolio id"},"portfolioCurrencyId":{"type":"string","description":"ISO 4217 code, e.g. EUR"},"crmCode":{"type":"string","description":"Holder of the portfolio"},"portfolioManager":{"type":"string","description":"Manager of the portfolio"},"isCash":{"type":"boolean","description":"True if the row represents cash"},"securityOtherCode":{"type":"array","nullable":true,"description":"Alternative security identifiers","items":{"$ref":"#/components/schemas/SecurityOtherCode"}},"securityBankId":{"type":"string","nullable":true},"securityId":{"type":"string","nullable":true,"description":"Apentis security id; may be null for cash"},"securityName":{"type":"string","nullable":true},"securityCurrencyId":{"type":"string","nullable":true},"securityMultiplier":{"type":"number","format":"double","nullable":true},"securitySectorId":{"nullable":true,"$ref":"#/components/schemas/SecuritySectorEnum"},"securityCountryId":{"type":"string","nullable":true,"description":"ISO 3166 country code"},"securityAssetClassId":{"nullable":true,"$ref":"#/components/schemas/SecurityAssetClassEnum"},"securityIndustryId":{"nullable":true,"$ref":"#/components/schemas/SecurityIndustryEnum"},"quantity":{"type":"string","description":"Decimal as string"},"priceDate":{"type":"string","format":"date","nullable":true},"price":{"type":"string","nullable":true,"description":"Decimal as string; price in security currency"},"marketValueSecurityCcy":{"type":"string","description":"Decimal as string; MV in security currency"},"marketValuePortfolioCcy":{"type":"string","description":"Decimal as string; MV in portfolio currency"},"costPrice":{"type":"string","nullable":true},"accruedInterest":{"type":"string","nullable":true},"custodianId":{"type":"string","description":"Custodian code (custodian ID code provided by Apentis)"},"importationTime":{"type":"string","format":"date-time","description":"UTC timestamp when imported into Apentis"}}},"SecurityOtherCode":{"type":"object","required":["scheme","value"],"properties":{"scheme":{"type":"string","description":"Identifier scheme (e.g., ISIN, Bloomberg, CUSIP)"},"value":{"type":"string","description":"Code value in the given scheme"}}},"SecuritySectorEnum":{"type":"string","description":"Security sector code (see GitBook reference)","enum":["-","CD","CS","EN","FN","HC","ID","IT","MA","Others","RE","TE","UT"]},"SecurityAssetClassEnum":{"type":"string","description":"Asset class code (see GitBook reference)","enum":["AR","CA","CC","CF","CO","CV","DE","EQ","FI","FRN","FX","HF","MAC","MZ","NFA","OTHER","PD","PE","PP","RE","RLI","SE","SP","VOL","YI"]},"SecurityIndustryEnum":{"type":"string","description":"Security industry code (see GitBook reference)","enum":["-","AC","BK","CDA","CG","CPS","DF","EN","FBT","FSR","HCES","HPP","HRL","IN","MA","ME","PB","RE","RT","SS","SSE","THE","TR","TS","UT"]}}}} ``` ## The CustodianExclusion object ```json {"openapi":"3.0.3","info":{"title":"Apentis API","version":"1.1.0"},"components":{"schemas":{"CustodianExclusion":{"type":"object","properties":{"custodianId":{"type":"string"},"positionsStatus":{"type":"string","enum":["COMPLETE","PARTIAL","LOADING","FAILED"]}}}}}} ``` ## The PositionsCollectionResponse object ```json {"openapi":"3.0.3","info":{"title":"Apentis API","version":"1.1.0"},"components":{"schemas":{"PositionsCollectionResponse":{"type":"object","required":["startDate","positions"],"properties":{"startDate":{"type":"string","format":"date","description":"Snapshot start date"},"endDate":{"type":"string","format":"date","nullable":true,"description":"Snapshot end date; when null, positions are returned from startDate until now"},"includedCustodians":{"type":"array","items":{"type":"string"},"description":"Custodians included in this response (ready at the time of request)"},"excludedCustodians":{"type":"array","items":{"$ref":"#/components/schemas/CustodianExclusion"},"description":"Custodians that were not ready and therefore excluded"},"positions":{"type":"array","items":{"$ref":"#/components/schemas/PositionRecord"}},"nextCursor":{"type":"string","nullable":true,"description":"Opaque cursor for fetching the next page; null if last page"}}},"CustodianExclusion":{"type":"object","properties":{"custodianId":{"type":"string"},"positionsStatus":{"type":"string","enum":["COMPLETE","PARTIAL","LOADING","FAILED"]}}},"PositionRecord":{"type":"object","required":["date","portfolioCustodianId","portfolioId","portfolioCurrencyId","crmCode","isCash","quantity","marketValueSecurityCcy","marketValuePortfolioCcy","custodianId","importationTime"],"properties":{"date":{"type":"string","format":"date","description":"Position date (YYYY-MM-DD)"},"portfolioCustodianId":{"type":"string","description":"Portfolio/account code at custodian"},"portfolioId":{"type":"string","description":"Apentis portfolio id"},"portfolioCurrencyId":{"type":"string","description":"ISO 4217 code, e.g. EUR"},"crmCode":{"type":"string","description":"Holder of the portfolio"},"portfolioManager":{"type":"string","description":"Manager of the portfolio"},"isCash":{"type":"boolean","description":"True if the row represents cash"},"securityOtherCode":{"type":"array","nullable":true,"description":"Alternative security identifiers","items":{"$ref":"#/components/schemas/SecurityOtherCode"}},"securityBankId":{"type":"string","nullable":true},"securityId":{"type":"string","nullable":true,"description":"Apentis security id; may be null for cash"},"securityName":{"type":"string","nullable":true},"securityCurrencyId":{"type":"string","nullable":true},"securityMultiplier":{"type":"number","format":"double","nullable":true},"securitySectorId":{"nullable":true,"$ref":"#/components/schemas/SecuritySectorEnum"},"securityCountryId":{"type":"string","nullable":true,"description":"ISO 3166 country code"},"securityAssetClassId":{"nullable":true,"$ref":"#/components/schemas/SecurityAssetClassEnum"},"securityIndustryId":{"nullable":true,"$ref":"#/components/schemas/SecurityIndustryEnum"},"quantity":{"type":"string","description":"Decimal as string"},"priceDate":{"type":"string","format":"date","nullable":true},"price":{"type":"string","nullable":true,"description":"Decimal as string; price in security currency"},"marketValueSecurityCcy":{"type":"string","description":"Decimal as string; MV in security currency"},"marketValuePortfolioCcy":{"type":"string","description":"Decimal as string; MV in portfolio currency"},"costPrice":{"type":"string","nullable":true},"accruedInterest":{"type":"string","nullable":true},"custodianId":{"type":"string","description":"Custodian code (custodian ID code provided by Apentis)"},"importationTime":{"type":"string","format":"date-time","description":"UTC timestamp when imported into Apentis"}}},"SecurityOtherCode":{"type":"object","required":["scheme","value"],"properties":{"scheme":{"type":"string","description":"Identifier scheme (e.g., ISIN, Bloomberg, CUSIP)"},"value":{"type":"string","description":"Code value in the given scheme"}}},"SecuritySectorEnum":{"type":"string","description":"Security sector code (see GitBook reference)","enum":["-","CD","CS","EN","FN","HC","ID","IT","MA","Others","RE","TE","UT"]},"SecurityAssetClassEnum":{"type":"string","description":"Asset class code (see GitBook reference)","enum":["AR","CA","CC","CF","CO","CV","DE","EQ","FI","FRN","FX","HF","MAC","MZ","NFA","OTHER","PD","PE","PP","RE","RLI","SE","SP","VOL","YI"]},"SecurityIndustryEnum":{"type":"string","description":"Security industry code (see GitBook reference)","enum":["-","AC","BK","CDA","CG","CPS","DF","EN","FBT","FSR","HCES","HPP","HRL","IN","MA","ME","PB","RE","RT","SS","SSE","THE","TR","TS","UT"]}}}} ``` ## The ErrorResponse object ```json {"openapi":"3.0.3","info":{"title":"Apentis API","version":"1.1.0"},"components":{"schemas":{"ErrorResponse":{"type":"object","properties":{"error":{"type":"string","description":"Short description of the error"},"code":{"type":"integer","description":"Application-specific or HTTP error code"}}}}}} ``` --- # 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/models.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.