For agents
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.
1Give your agent this prompt
Signed in, it has your sandbox key in it. Signed out, it says where to find the key instead.
Prompt
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.2Where 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. |
3What your agent sees
The Quickstart page as Markdown, and the index it's listed in. No navigation, no scripts, nothing to parse.
GET /docs/quickstart.md
# Quickstart
> Your first check takes 10 seconds: copy the code in step 2 and run it. It uses your sandbox key, which returns test data and never uses one of your checks.
Base URL: `https://checksharecode.co.uk` · Auth: `authorization: Bearer <key>` · Web version: https://checksharecode.co.uk/docs/quickstart
> **Using a coding agent?** Paste this into Claude Code, Cursor or Copilot and it will do the steps below for you. [See Build with an agent](https://checksharecode.co.uk/docs/agents.md)
```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.
```
## 1. Get your sandbox key
Every account gets one when it signs up, on [API keys](https://checksharecode.co.uk/app/keys). Put it in an environment variable called `CHECKSHARECODE_API_KEY`.
Your sandbox key is on https://checksharecode.co.uk/app/keys (it starts `rtw_test_`). Read it from `CHECKSHARECODE_API_KEY`.
## 2. Make a call
Send the applicant's share code, their date of birth and your company name. With a sandbox key, use one of the test codes in step 4.
cURL:
```bash
curl https://checksharecode.co.uk/api/check \
-H "authorization: Bearer $CHECKSHARECODE_API_KEY" \
-H "content-type: application/json" \
-d '{
"share_code": "AA1AA1AA1",
"date_of_birth": "1990-01-01",
"company_name": "Acme Ltd"
}'
```GET /llms.txt
# Check Share Code > API that checks UK right-to-work share codes against gov.uk's online checking service and returns JSON: outcome, dates, conditions, the applicant's photo and the gov.uk PDF. One call: `POST https://checksharecode.co.uk/api/check` with `authorization: Bearer <key>` and a JSON body of `share_code`, `date_of_birth` (YYYY-MM-DD) and `company_name`. Keys starting `rtw_test_` return fixed sandbox answers and are free and unlimited; `rtw_live_` keys run a real gov.uk check. Stateless: no applicant data is stored. Sign up free at https://checksharecode.co.uk/signup (10 live checks a month, no card). ## Docs - [Overview](https://checksharecode.co.uk/docs.md): One API call checks a UK right-to-work share code against gov.uk and returns the result as JSON: outcome, dates, conditions, the applicant's photo and the gov.uk PDF. - [Quickstart](https://checksharecode.co.uk/docs/quickstart.md): Your first check takes 10 seconds: copy the code in step 2 and run it. - [POST /api/check](https://checksharecode.co.uk/docs/api/check.md): POST https://checksharecode.co.uk/api/check runs the employer check on gov.uk's View a job applicant's right to work details service and returns the result as JSON. - [Build with an agent](https://checksharecode.co.uk/docs/agents.md): Claude Code, Cursor, Copilot and ChatGPT can do the whole integration for you. ## Machine-readable - [OpenAPI 3.1 spec](https://checksharecode.co.uk/openapi.json): the full contract - [llms-full.txt](https://checksharecode.co.uk/llms-full.txt): the whole integration in one file ## Guides - [Handling errors](https://checksharecode.co.uk/tutorials/handling-errors): every error `code` and what to do - [Quota and billing](https://checksharecode.co.uk/tutorials/quota-and-billing): monthly quotas, rate limits and overage - [Right to Work Check API](https://checksharecode.co.uk/right-to-work-check-api): why gov.uk has no official API and how the options compare - [Right to Work Checks for Gig and Agency Workers](https://checksharecode.co.uk/right-to-work-checks-gig-agency-workers): the October 2026 extension - [Pricing](https://checksharecode.co.uk/pricing): Free (10 live checks/month), Pro (£14/month, 100 checks, £0.25 after), Scale (£49/month, 500 checks, £0.10 after), Enterprise (custom)
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
codeand amessagewith the next step. A 402 includes theupgrade_url. - Real test data. Sandbox test codes give an agent every outcome to write handling for, without using a check.