> For the complete documentation index, see [llms.txt](https://manual.personr.co/api-documentation/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://manual.personr.co/api-documentation/getting-started/api-versioning-and-changes.md).

# API versioning and changes

How we change the API, what counts as a breaking change, and how much notice you get.

The Personr API has a single version, served from `https://enterprise.personr.co/api/1.1/wf/`. The `1.1` in the path is our platform's URL format, not an API version you choose.

## Changes we make without notice

These changes are additive. We list them in the [Changelog](https://manual.personr.co/api-documentation/getting-started/changelog.md), but they don't need any change on your side:

* New endpoints.
* New optional request parameters.
* New fields in responses or webhook payloads.
* New webhook event types. Opt-in events stay off until you turn them on.
* New values in fields that already hold a list of values, such as rejection labels or AML categories.
* Fixes that make a response match its documentation.

To stay compatible:

* Ignore response and webhook fields you don't recognise.
* Don't rely on the order of keys in a JSON object.
* Handle unknown values in label and category fields.

## Breaking changes

A breaking change is one that could stop a working integration. For example:

* Removing or renaming a field or endpoint.
* Changing a field's type.
* Making an optional parameter required.
* Changing what a status or answer means.

For breaking changes, we:

1. Email the administrators of the workspaces that use the affected endpoint before the change, with enough notice to update your integration.
2. Add an entry marked **Breaking** to the [Changelog](https://manual.personr.co/api-documentation/getting-started/changelog.md).
3. Where possible, keep the old behaviour available behind an opt-in parameter during the notice period, or keep it permanently (for example, `format=standard` on `api-retrieve-ownership`, and the legacy `ownershipInsight` key on `api-retrieve-ubo`).

If a breaking change is needed to fix a security issue or a legal or regulatory requirement, notice may be shorter. We'll still email you and add a Changelog entry.

## Webhooks

* New fields can be added to webhook payloads at any time.
* Build your receiver to be idempotent: the same event can arrive more than once.
* Use the timestamps in the payload, not the order of arrival, to decide which event is newest.

## Staying informed

* Check the [Changelog](https://manual.personr.co/api-documentation/getting-started/changelog.md) before upgrading.
* Make sure your workspace's administrator email is monitored.
* Questions about an upcoming change: <help@personr.co>.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://manual.personr.co/api-documentation/getting-started/api-versioning-and-changes.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.
