> 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/changelog.md).

# Changelog

Changes to the Personr API and webhooks, newest first. Check here before you upgrade an integration.

We add an entry whenever an endpoint, field or webhook changes. Entries marked **Breaking** need a change on your side. Everything else is additive: new optional parameters, new response fields or new endpoints. Your integration should ignore fields it doesn't recognise.

{% hint style="info" %}
See [API versioning and changes](https://manual.personr.co/api-documentation/getting-started/api-versioning-and-changes.md) for how we introduce changes and how much notice we give.
{% endhint %}

## November 2026

### 11 November

* **Document endpoints are scoped to your workspace.** `api-document-upload`, `api-document-download`, `api-document-download-information`, `api-entity-document-upload` and `api-entity-document-upload-encoded` only act on applicants and entities in the workspace your API key belongs to. An empty ID, or an ID from another workspace, returns HTTP `200` with `"error": "applicant_not_found"` (`entity_not_found` for the entity uploads). On the three upload endpoints, an ID that doesn't exist returns the same error and nothing is uploaded. On the two download endpoints, an ID that doesn't exist still returns `400`. Use the API key of the workspace the applicant or entity belongs to. See [Errors and rate limits](https://manual.personr.co/api-documentation/getting-started/errors-and-rate-limits.md).
* **Document downloads:** large ID photos no longer cause errors. Images may be resized so they're no wider than 2400 px, and PDFs are returned unchanged. An applicant with no images returns `200` with an empty image list. On `api-document-download`, `IdDocType` is now in the same order as `base64`. See [Downloading verified documents](https://manual.personr.co/api-documentation/applicant-results/downloading-verified-documents.md).
* **Docs:** `api-document-download-information` returns the images under `images`, not `base64` as the example previously showed. See [Downloading verified documents with information](https://manual.personr.co/api-documentation/applicant-results/downloading-verified-documents-with-information.md).

### 9 November

* **Starting an entity check:** `api-request-applicant-check` now returns `{"response": "success"}` when it starts a Registry & Ownership Insights entity check. It previously returned `"error"` even though the check had started. See [Requesting to start the verification process](https://manual.personr.co/api-documentation/entities/requesting-to-start-the-verification-process.md).
* **Ownership:** fixed percentages, registration numbers and addresses being overwritten with empty values when the same company or person appeared more than once in an ownership tree. Re-fetch `api-retrieve-ownership` for entities verified before 9 November if you rely on these fields.

### 8 November

* **Entity results:** clarified ownership depth, AML screening behaviour, the follow-up `api-request-applicant-check` call for entities, the `incorporatedOn` date format (`DD-MM-YYYY` for ASIC companies) and how trusts are handled.

### 4 November

* **New: Lookups API.** `api-lookup-create` and `api-lookup-retrieve` run a standalone document and/or AML check on a person, without creating an applicant. See [Lookups](https://manual.personr.co/api-documentation/lookups.md).
* **New: sandbox workspaces.** Sandbox workspaces return simulated results for every check, using test values, and are never billed. See [Sandbox and test data](https://manual.personr.co/api-documentation/getting-started/sandbox-and-test-data.md).
* **Ownership:** `api-retrieve-ownership` returns `ownershipBand` and `natureOfControl` for UK persons with significant control.

### 3 November

* **New webhook: `entity.ownership_ready`** (opt-in). Sent once an entity's ownership structure has finished building. See [Ownership ready webhook](https://manual.personr.co/api-documentation/entity-results/retrieving-entity-verification-results/setting-up-a-webhook/ownership-ready-webhook.md).
* **Company search:** responses now include `"status": "success"`.
* **Entity webhook:** the docs now show the real payload types. `rejectLabel` is a string, and `externalUserId` is a JSON-encoded string.

### 2 November

* **Workspace API keys:** each workspace can generate its own API token, and requests for a flow outside the token's workspace return `flow_not_found`.
* **Ownership:** `api-retrieve-ownership` accepts `format=standard` for a `{"status":"success","response":{...}}` wrapper.
* **Entity document uploads:** documented size limits. Encoded (base64) uploads over 1 MiB are rejected with an error instead of being saved partially. Use the file upload endpoint for larger documents.
* **Breaking: `api-retrieve-ubo`** now returns a valid JSON `ubos` array with every owner. The old `ownershipInsight` key is kept, but it only holds the last owner.

## October 2026

### 28 October

* **Verification links:** new optional `returnUrl`, which sends the applicant to your app or site when they finish.
* **Ownership:** `api-retrieve-ownership` returns real `null` for empty values, and `totalCapital` is a number or `null`. If you parsed `"null"` or `""` strings, update your parser.

### 27 October

* **Breaking: `api-aml-results`** returns `aml` as a list with one object per match. It was previously a single object repeated per match, which wasn't valid JSON. Read `aml[0]` or loop over `aml`.

### 26 October

* **New: onboarding status.** Endpoints to check an onboarding link's status and track verification progress. See [Checking onboarding link status](https://manual.personr.co/api-documentation/applicant-results/checking-onboarding-link-status.md).
* **New webhooks: `onboarding.opened`, `onboarding.incomplete` and `onboarding.completed`** (opt-in). See [Onboarding webhooks](https://manual.personr.co/api-documentation/applicant-results/retrieving-applicant-verification-results/setting-up-a-webhook/onboarding-webhooks.md).

### 22 October

* **Code samples:** fixed auth headers, parameter names, wrong endpoints and invalid JSON in examples across the docs.

### 12 October

* **Entities:** updated the supported KYB document types.


---

# 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/changelog.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.
