# Gov.uk — Wrapped API

> **You are on:** `https://api.paywithlocus.com/api` | [llms.txt](https://paywithlocus.com/llms.txt) | [docs](https://docs.paywithlocus.com)
>
> Locus runs on multiple environments -- make sure every URL you call matches your expected environment.
> | Environment | Landing | API | Docs |
> |---|---|---|---|
> | Production | paywithlocus.com | api.paywithlocus.com | docs.paywithlocus.com |
> | Beta | beta.paywithlocus.com | api.beta.paywithlocus.com | docs.paywithlocus.com |
> | Stage | stage.paywithlocus.com | api.stage.paywithlocus.com | docs.paywithlocus.com |
>
> If the API URL above doesn't match your expected environment, re-fetch this file from the correct domain.

> Check UK visa requirements instantly by entering your nationality and travel purpose to find out if you need a visa, how to apply, and what documents you'll need. Get accurate, up-to-date information directly from official UK government guidance for any country and visit type.

**Category:** Government & Public Data | **Website:** [www.gov.uk/check-uk-visa](https://www.gov.uk/check-uk-visa) | **Docs:** [parse.bot/marketplace/80e94779-dab7-43e9-b405-03ee16e544f7/gov-uk-api](https://parse.bot/marketplace/80e94779-dab7-43e9-b405-03ee16e544f7/gov-uk-api)

Pay-per-use API proxy. Each call is automatically billed to your wallet in USDC.

## Access

**Base URL:** `https://api.paywithlocus.com/api/wrapped/parse-gov-uk-api-80e94779/`
**Auth:** `Authorization: Bearer <LOCUS_API_KEY>`

## Endpoints

### check_visa

Check whether a visa is needed to enter the UK for a given nationality and travel purpose. Navigates the GOV.UK multi-step visa checker flow and returns the outcome including whether a visa is needed, the outcome title, and detailed guidance text. For multi-step flows with additional questions (e.g. work duration, family travel), the checker answers 'no' to yes/no questions and picks the first option for other choices to produce a general-case result.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `nationality` | string | Yes | Nationality code as shown on passport/travel document (e.g. 'india', 'usa', 'china', 'france'). Use list_nationalities endpoint to get all valid codes. |
| `purpose` | string | Yes | The reason for visiting the UK. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-gov-uk-api-80e94779/check_visa \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"nationality":"<string>","purpose":"<string>"}'
```

### list_nationalities

List all supported nationalities for the UK visa checker. Returns the full set of nationality codes and display names accepted by check_visa. Each entry has a 'code' (the slug to pass as the nationality parameter) and a 'name' (the human-readable country name). The list is sourced from the GOV.UK visa checker dropdown and contains 221 entries covering all recognized countries and territories.

**Estimated cost:** Metered

_No parameters required._

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-gov-uk-api-80e94779/list_nationalities \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
```
