> 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/sandbox-and-test-data.md).

# Sandbox and test data

Test your integration end to end with fake results and no billing.

A sandbox workspace runs your integration end to end without contacting real data providers. Checks return fake results that you choose with test values, and **nothing is billed**.

{% hint style="info" %}
To get a sandbox workspace, ask Personr support to switch one of your workspaces to sandbox. Your existing API credentials and endpoints work the same way. Only the results change.
{% endhint %}

## What changes in a sandbox

* **No provider calls.** Identity database checks, AML screening and company registry checks return mock results in the provider's normal format.
* **No billing.** Checks aren't counted towards usage or invoices.
* **Same pipeline.** Results, reject labels, verification results and webhooks are produced by the same steps as a live workspace, so you can build against them.
* **Example records.** When a workspace is switched to sandbox, it's seeded with the example individuals and companies listed below.

{% hint style="warning" %}
Document and selfie checks inside a hosted verification link still run through the real document provider. Use the API, Lookups or database checks to test without document capture.
{% endhint %}

## Choosing a result with test values

Results are picked by the **last name** of an individual, or by the **ACN** or **name** of a company. Matching ignores case, and the value only has to *contain* the keyword: `Fail`, `Smith-fail` and `FAIL` all choose the fail path.

### Individuals

| Check                        | Last name contains | Result                                                                                                                                                                                                         |
| ---------------------------- | ------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Database check / waterfall   | anything else      | Every source matches, **Approved**                                                                                                                                                                             |
| Database check / waterfall   | `fail`             | No source matches, **Rejected** (`Final`, `INSUFFICIENT_MATCHES`)                                                                                                                                              |
| AML screening                | anything else      | No hits                                                                                                                                                                                                        |
| AML screening                | `pep`              | One PEP hit (`role.pep`)                                                                                                                                                                                       |
| AML screening                | `sanction`         | One sanctions hit (`sanction`)                                                                                                                                                                                 |
| AML screening                | `adverse`          | One adverse media hit (`crime`)                                                                                                                                                                                |
| AML screening                | `review`           | One **possible** PEP match: a slightly different name, a different birth year, score `0.62` and `match: false`. It's flagged like a real borderline match, so a reviewer must mark it a true or false positive |
| Database check and Re-verify | `retry`            | **Rejected (Retry)** with `PROB_APPLICANT_DATA`: the applicant can try again                                                                                                                                   |
| Database check and Re-verify | `minor`            | **Rejected (Final)** with `AGE_REQ_MISMATCH`: the applicant is under 16                                                                                                                                        |
| Database check and Re-verify | `slow`             | The result and its webhook arrive **2 to 5 minutes later**, not instantly, so you can test waiting for the webhook                                                                                             |

The AML mock also works on the full name, so `Jane Pep` returns a PEP hit whichever field is set. You can combine `slow` with other values: `Slow Retry` arrives late **and** is Rejected (Retry).

### Companies (KYB)

| Test value                                                                   | Result                                                                                                                                                                                                         |
| ---------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| ACN `000 000 019`                                                            | Company found and registered. Two directors and 50% owners, **SARAH PASS** and **TOM PASS**, are returned as UBOs. Result **Approved**                                                                         |
| ACN `000 000 027`                                                            | Company not found, **Rejected** (`Final`, `INCORRECT_DATA`)                                                                                                                                                    |
| ABN `000 000 035`                                                            | A trust: **Discretionary Trading Trust**, Active on the Australian Business Register. Result **Approved**, and the company moves to adding owners manually, because the register doesn't list a trust's owners |
| Any other ACN                                                                | Company not found, the same as `000 000 027`                                                                                                                                                                   |
| Any company registered **outside Australia**                                 | Found and active, as a **Private Company**. Result **Approved**, and the company moves to adding owners manually                                                                                               |
| Company outside Australia, or the trust above, with a name containing `fail` | Found but de-registered: **Rejected** (`Final`, `DE-REGISTERED`)                                                                                                                                               |
| Company name contains `pep`, `sanction` or `adverse`                         | One entity AML hit of that type                                                                                                                                                                                |

Spaces in an ACN don't matter: `000000019` and `000 000 019` behave the same.

## Seeded example records

A new sandbox workspace starts with these records, so you can explore results and webhooks before you send any requests. They're marked `SANDBOX example record (not a real check)`.

| Record                                 | Type       | Result                                                |
| -------------------------------------- | ---------- | ----------------------------------------------------- |
| Sarah Pass                             | Individual | Approved                                              |
| Tom Fail                               | Individual | Rejected, `INSUFFICIENT_MATCHES`                      |
| Jane Pep                               | Individual | Rejected, PEP AML hit (`SANDBOX-PEP-1`)               |
| Sam Sanction                           | Individual | Rejected, sanctions AML hit (`SANDBOX-SANCTION-1`)    |
| Al Adverse                             | Individual | Rejected, adverse media AML hit (`SANDBOX-ADVERSE-1`) |
| Sandbox Success Pty Ltd (000 000 019)  | Company    | Approved, 2 UBOs                                      |
| Sandbox Missing Pty Ltd (000 000 027)  | Company    | Rejected, `INCORRECT_DATA`                            |
| Sandbox Family Trust (ABN 000 000 035) | Trust      | Approved, waiting for owners to be added              |

The workspace also gets two flows, so you can create applicants and entities straight away. Pass the flow name as `flowName` when you create a record. The example individuals use **Sandbox KYC** and the example companies use **Sandbox KYB**. Flows are only added if the workspace doesn't have any yet.

| Flow        | Type        | Steps                                                                            |
| ----------- | ----------- | -------------------------------------------------------------------------------- |
| Sandbox KYC | Individuals | ID document (passport or driver's licence), selfie and face match, AML screening |
| Sandbox KYB | Companies   | Registry check, ownership and UBO discovery, AML screening                       |

{% hint style="warning" %}
The **Sandbox KYC** flow includes document and selfie capture. If you send it to someone as a hosted verification link, those steps run through the real document provider, as described above.
{% endhint %}

## Recognising sandbox data

* AML hits have ids starting with `SANDBOX-` and the summary "SANDBOX: fake result for testing. Not a real screening hit."
* KYB registry report ids start with `sandbox-`, followed by the ACN.
* Database check results carry the comment "SANDBOX: fake database check result".

## Suggested test run

1. Create an applicant with last name `Pass` ([Creating an applicant](https://manual.personr.co/api-documentation/applicants/creating-an-applicant.md)) and run a database check ([Verifying applicant identity data](https://manual.personr.co/api-documentation/database-verification/applicants/verifying-applicant-identity-data.md)). Expect an **Approved** result and a webhook ([Setting up a webhook](https://manual.personr.co/api-documentation/applicant-results/retrieving-applicant-verification-results/setting-up-a-webhook.md)).
2. Repeat with last name `Fail`. Expect **Rejected** with `INSUFFICIENT_MATCHES`.
3. Repeat with last name `Pep` and fetch AML results ([Retrieving AML results](https://manual.personr.co/api-documentation/anti-money-laundering/retrieving-aml-results.md)). Expect one PEP hit.
4. Create an entity with ACN `000 000 019` ([Creating an entity](https://manual.personr.co/api-documentation/entities/creating-an-entity.md)). Expect **Approved** and two UBOs ([Retrieving entity ownership structures](https://manual.personr.co/api-documentation/entity-results/retrieving-entity-ownership-structures.md)).
5. Create an entity with ACN `000 000 027`. Expect **Rejected** with `INCORRECT_DATA`.
6. Create an entity with ABN `000 000 035`. Expect a **Discretionary Trading Trust**, **Approved**, waiting for its owners to be added.
7. Create a New Zealand entity named `Kiwi Fail Ltd`. Expect **Rejected** with `DE-REGISTERED`.
8. Run a database check with last name `Retry`. Expect **Rejected (Retry)** with `PROB_APPLICANT_DATA`, and check your app lets the person try again.
9. Run a database check with last name `Slow`. Expect no result straight away, then a webhook 2 to 5 minutes later.

## Limits

* Provider error and timeout responses aren't simulated.
* `slow`, `retry` and `minor` apply to the database check and Re-verify. They don't change the database waterfall or KYB results.
* Hosted document and selfie capture isn't mocked (see the warning above).
* Results are fixed: the same test value always returns the same result.


---

# 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/sandbox-and-test-data.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.
