# Versioning and changelog

## Versioning

The APENTIS API follows a versioning scheme using path prefixes (e.g. `/v1.1/`) and semantic versioning in the documentation metadata.

* **Major versions** (e.g. `/v1.0/`, `/v2.0/`) are used when introducing breaking changes. These may include removing fields, renaming paths, or changing behavior in a non-backward-compatible way.
* **Minor versions** (e.g. `/v1.1/`, `/v1.2/`) are used when adding non-breaking changes like new endpoints, fields, or optional enhancements.

Clients should always specify the API version in their requests and monitor changelogs before upgrading to a new major version.

## Changelog

<table><thead><tr><th width="182">Version (increment)</th><th width="163">Date</th><th>Description</th></tr></thead><tbody><tr><td>1.0 (0)</td><td>2025-02-11</td><td>Initial release with business relations, documents, and AML/KYC endpoints</td></tr><tr><td>1.0 (1)</td><td>2025-05-05</td><td>Added role-based links between business relations</td></tr><tr><td>1.0 (2)</td><td>2025-06-05</td><td>Added investor registry endpoint</td></tr><tr><td>1.1 (0)</td><td>2025-06-06</td><td>Added cash transaction endpoints for AML cashflow monitoring</td></tr><tr><td>1.1 (1)</td><td>2025-07-25</td><td><p>3 new document types added:</p><ul><li>Criminal Record: used to assess whether an individual has any criminal history relevant to AML risk classification.</li><li>Engagement Letter: a formal letter confirming the agreement between a client and your organization. Frequently required for onboarding validations.</li><li>Unique Identification Number (NIU): a national identifier used in the Democratic Republic of Congo (RDC) for individuals and legal entities.</li></ul></td></tr><tr><td>1.1 (1)</td><td>2025-07-25</td><td>To prevent duplicates, a validation check has been added to ensure that the <code>crmCode</code> used when creating a new business relation is unique.<br><br>If the code already exists, the API will return HTTP 409 Conflict with a clear error message.</td></tr><tr><td>1.1 (1)</td><td>2025-07-25</td><td><p>We’ve added address-related fields to the business relations endpoints for better data structure and completeness:</p><ul><li><code>address</code></li><li><code>postalCode</code></li><li><code>city</code></li></ul><p>These fields are now accepted in creation and update requests and returned in GET responses.</p></td></tr><tr><td>1.1 (2)</td><td>2025-09-01</td><td>Added data positions endpoints to expose aggregated portfolio positions from custodian banks</td></tr><tr><td>1.1 (3)</td><td>2025-11-18</td><td><p><strong>IP whitelisting capabilities added</strong>:</p><ul><li>API access is now restricted by IP allowlist per customer</li><li>Only registered IP addresses can call the API — any request from an unknown IP will be denied</li><li><p>This provides a second security layer in addition to the bearer token, helping:</p><ul><li>prevent unauthorized access even if a token is leaked</li><li>minimize attack surfaces</li><li>defend against DoS/DDoS attempts from unknown sources</li></ul></li></ul></td></tr><tr><td>1.1 (3)</td><td>2025-11-18</td><td><p><strong>Updated portfolio positions retrieval:</strong> </p><p>We’ve replaced the <code>asOfDate</code> filter with <code>startDate</code> and <code>endDate</code> parameters, enabling to fetch positions between two dates.</p></td></tr><tr><td>1.1. (3)</td><td>2025-11-18</td><td><p><strong>Enrichment of position responses</strong>: </p><p>The position data now includes the <code>crmCode</code> of the portfolio holder and <code>portfolioManager</code>. This provides richer context and mapping between portfolios and business relations.</p></td></tr><tr><td>1.1 (3)</td><td>2025-11-18</td><td><p><strong>New endpoint for AML name check report:</strong> <code>/business-relations/{crm_code}/aml-kyc-report</code></p><p>You can now retrieve the latest AML name check report for a given business relation via an API call.</p><p>This report is produced by AMLscorer and helps you stay up to date with the compliance status of your clients.</p></td></tr><tr><td>1.1 (3)</td><td>2025-11-18</td><td><p><strong>Added <code>crmId</code> to API responses</strong></p><p>The internal Apentis unique identifier for each business relation — <code>crmId</code> — is now included in all relevant responses, improving traceability and integration between systems.</p></td></tr><tr><td>1.1 (3)</td><td>2025-11-18</td><td><p><strong>Enriched business relation data model</strong></p><p>We’ve added new fields to capture richer information about your clients:</p><p>For <strong>persons</strong>:</p><ul><li><code>placeOfBirth</code></li><li><code>maritalStatus</code></li><li><code>taxIdentificationNumber</code></li><li>Contact details (e.g., <code>email</code>, <code>phone</code>, <code>address</code> fields)</li></ul><p>For <strong>companies and legal entities</strong>:</p><ul><li><code>incorporationDate</code></li><li><code>taxIdentificationNumber</code></li><li><code>vatNumber</code></li><li><code>legalForm</code></li><li><code>socialSecurityNumber</code></li><li>Contact details (e.g., <code>email</code>, <code>phone</code>, <code>address</code> fields)</li></ul></td></tr><tr><td>1.1 (3)</td><td>2025-11-18</td><td><p><strong>New bulk retrieval endpoint:</strong> </p><p><code>/business-relations</code></p><p>No more looping over one-by-one requests. You can now retrieve all business relations in a single call, making it much easier and faster to sync your systems.</p></td></tr><tr><td>1.1 (3)</td><td>2025-11-18</td><td><p><strong>New <code>dmsLinkUrl</code> field</strong></p><p>We’ve added a new field to store a URL pointing to the client’s folder in your DMS (Document Management System). This allows you to track where the documents are stored externally for each business relation.</p></td></tr></tbody></table>


---

# 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/versioning-and-changelog.md?ask=<question>
```

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.