# Build with a coding agent

> Claude Code, Cursor, Copilot and ChatGPT can do the whole integration for you. Every page in these docs is also plain Markdown, so your agent reads exactly what you read.

Base URL: `https://checksharecode.co.uk` · Auth: `authorization: Bearer <key>` · Web version: https://checksharecode.co.uk/docs/agents

## 1. Give your agent this prompt

Signed in, it has your sandbox key in it. Signed out, it says where to find the key instead.

```text
Add UK right-to-work checks to this project using the Check Share Code API. Follow the quickstart: https://checksharecode.co.uk/docs/quickstart.md. Read my API key from the CHECKSHARECODE_API_KEY environment variable (sandbox keys are at https://checksharecode.co.uk/app/keys). Test it with share code AA1AA1AA1 and date of birth 1990-01-01.
```

## 2. Where agents read from

| URL | What it is |
| --- | --- |
| /llms.txt | Index of every docs page, one line each. Where an agent should start. |
| /llms-full.txt | The whole integration in one file, under 10 KB: auth, examples, errors, test codes. |
| /docs/<page>.md | Any docs page as plain Markdown. Add .md to the URL, or send Accept: text/markdown. |
| /openapi.json | OpenAPI 3.1 contract, for typed clients and code generation. |

## 3. What your agent sees

The Quickstart page as Markdown, and the index it's listed in. No navigation, no scripts, nothing to parse.

See [Quickstart](https://checksharecode.co.uk/docs/quickstart.md).

See [llms.txt](https://checksharecode.co.uk/llms.txt).

## How these docs are written

- **Same words, two formats.** Each page is written once. The HTML and the Markdown come from the same source, so they never drift.
- **Complete on its own.** Each page names the base URL, the auth header and a working example, so an agent that reads one page can still make a call.
- **Errors that say what to do.** Every error has a stable `code` and a `message` with the next step. A 402 includes the `upgrade_url`.
- **Real test data.** Sandbox test codes give an agent every outcome to write handling for, without using a check.

See also: [POST /api/check](https://checksharecode.co.uk/docs/api/check.md)
