# API map This page provides a high-level overview of the Apentis API endpoints grouped by functional area. Use this as a quick reference to find the endpoints relevant to your use case. {% hint style="info" %} Each link below redirects to the full documentation of the endpoint in the API Reference section. {% endhint %} ## Authentication | Endpoint | Description | | ------------------ | ------------------------------------------------------------------------------------------------------ | | `POST /auth/token` | Generate a bearer token using client credentials - Not implemented yet | *** ## CRM ### Business relations Endpoints for creating, retrieving, updating, and managing business relations (individuals and entities). | Endpoint | Description | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------- | | [`GET /business-relations/schema-config`](https://apentis.gitbook.io/apentis-api/pages/4024af2cfb822beed3f7d9709ecfed32959bf592#get-v1.1-business-relations-schema-config) | Retrieve client-specific business relation schema | | [`POST /business-relations`](https://apentis.gitbook.io/apentis-api/pages/4024af2cfb822beed3f7d9709ecfed32959bf592#post-v1.1-business-relations) | Create a new business relation | | [`GET /business-relations/{crmCode}`](https://apentis.gitbook.io/apentis-api/pages/4024af2cfb822beed3f7d9709ecfed32959bf592#get-v1.1-business-relations-crmcode) | Get details of a business relation | | [`GET /business-relations`](https://apentis.gitbook.io/apentis-api/pages/4024af2cfb822beed3f7d9709ecfed32959bf592#get-v1.1-business-relations-crmcode) | Retrieve all business relations | | [`PUT /business-relations/{crmCode}`](https://apentis.gitbook.io/apentis-api/pages/4024af2cfb822beed3f7d9709ecfed32959bf592#put-v1.1-business-relations-crmcode) | Update an existing business relation | ### Business relations links Endpoints for defining and managing relationships between two business relations. | Endpoint | Description | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------- | | [`GET /business-relations/{crmCode}/links`](https://apentis.gitbook.io/apentis-api/pages/e1b6419440960fa419decec732e2b66b1778e37c#get-v1.1-business-relations-crmcode-links) | Retreive business relation links | | [`POST /business-relations/{crmCode}/links`](https://apentis.gitbook.io/apentis-api/pages/e1b6419440960fa419decec732e2b66b1778e37c#post-v1.1-business-relations-crmcode-links) | Link business relations to a primary one | | [`DELETE /business-relations/{crmCode}/link`](https://apentis.gitbook.io/apentis-api/pages/e1b6419440960fa419decec732e2b66b1778e37c#delete-v1.1-business-relations-crmcode-links) | Delete business relation links | *** ## Compliance AML/KYC ### KYC Documents Endpoints for uploading, retrieving, and managing KYC documents and metadata associated with a business relation. | Endpoint | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | | [`POST /business-relations/{crmCode}/docume`](https://apentis.gitbook.io/apentis-api/pages/99af1edea10c93a56ac8b87069c716199b0e78e8#post-v1.1-business-relations-crmcode-documents) | Upload one or more documents and associated metadata for a business relation | | [`GET /business-relations/{crmCode}/documen`](https://apentis.gitbook.io/apentis-api/pages/99af1edea10c93a56ac8b87069c716199b0e78e8#get-v1.1-business-relations-crmcode-documents) | Retrieve documents and metadata associated with a business relation | | [`GET /business-relations/{crmCode}/documents/metadata-only`](https://apentis.gitbook.io/apentis-api/pages/99af1edea10c93a56ac8b87069c716199b0e78e8#get-v1.1-business-relations-crmcode-documents) | Retrieve documents metadata associated with a business relation without binary files | | [`DELETE /business-relations/{crmCode}/docu`](https://apentis.gitbook.io/apentis-api/pages/99af1edea10c93a56ac8b87069c716199b0e78e8#delete-v1.1-business-relations-crmcode-documents) | Delete documents associated with a business relation | | [`POST /business-relations/{crmCode}/documents/metadata-only`](https://apentis.gitbook.io/apentis-api/pages/99af1edea10c93a56ac8b87069c716199b0e78e8#post-v1.1-business-relations-crmcode-documents-metadata-only) | Submit document metadata without file | ### AML / KYC results Endpoints for retrieving AML/KYC assessments, including risk rating, acceptance status, PEP/sanction screening, and document completeness. | Endpoint | Description | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------- | | [`GET /business-relations/{crmCode}/aml-kyc`](https://apentis.gitbook.io/apentis-api/pages/4dab56dafb91aa73bab89f4ad2785e6e9fe108a5#get-v1.1-business-relations-crmcode-aml-kyc-result) | Retrieve AML/KYC results for a business relation | | [`GET /business-relations/{crmCode}/aml-kyc`](https://apentis.gitbook.io/apentis-api/pages/4dab56dafb91aa73bab89f4ad2785e6e9fe108a5#get-v1.1-business-relations-crmcode-aml-kyc-report) | Returns the most recently generated NameCheck report as a PDF document. | ### Cashflow monitoring Endpoints for submitting cash transactions and retrieving AML cashflow monitoring results. | Endpoint | Description | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------- | | [`POST /cash-transactions`](https://apentis.gitbook.io/apentis-api/pages/cf64e70b42d2019387f65c88a48a6d4e6209c420#post-v1.1-cash-transactions) | Submit a cash transaction for AML monitoring | | [`GET /cash-transactions/{externalTransactionId}/aml-result`](https://apentis.gitbook.io/apentis-api/pages/cf64e70b42d2019387f65c88a48a6d4e6209c420#get-v1.1-cash-transactions-externaltransactionid-aml-result) | Get AML cahsflow monitoring result for a cash transaction | | [`GET /cash-transactions/aml-results`](https://apentis.gitbook.io/apentis-api/pages/cf64e70b42d2019387f65c88a48a6d4e6209c420#get-v1.1-cash-transactions-aml-results) | List AML results for a business relation or portfolio | *** ## Portfolio data ### Investor commitments Endpoints for registering and managing fund commitments made by investors. | Endpoint | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------- | | [`POST /business-relations/{crmCode}/investor-commitments`](https://apentis.gitbook.io/apentis-api/pages/2f190851ecdfc3265f718bf7302b3657b5797fa8#post-v1.1-business-relations-crmcode-investor-commitments) | Register a new investor commitment | ### Positions and transactions Read-only endpoints to verify data availability and retrieve normalized custody positions and transactions (aggregated across custodians and portfolios). | Section | Description | | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | [`GET /data/availability`](https://apentis.gitbook.io/apentis-api/pages/3a2a355628ad9ed82751a32484eaf3232151bbb2#get-v1.1-data-availability) | Returns readiness (per custodian) for a given customer and date. | | [`GET /data/positions`](https://apentis.gitbook.io/apentis-api/pages/3a2a355628ad9ed82751a32484eaf3232151bbb2#get-v1.1-data-positions) | Returns positions (cash + securities) for portfolios as of a given date. Records are normalized across custodian banks. | | `GET /data/transactions` |

Returns transactions (cash + securities) for portfolios as of a given date. Records are normalized across custodian banks.

Not implemented yet

| --- # 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-map.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.