# OpenAPI specification

> Download the MobileValidate OpenAPI 3.1 specification to generate clients, import into Postman or Insomnia, or give AI coding agents the full API contract.

Canonical: https://mobilevalidate.com/docs/openapi · Last updated: 2026-09-25

The full contract of the MobileValidate API is published as an OpenAPI 3.1 document at [/openapi.yaml](/openapi.yaml). It describes every public v1 endpoint, request body, response shape and error code. Use it to generate a client in your language, import the API into an HTTP tool, or give a coding agent the exact contract.

## Where can I get it?

| URL | Notes |
|---|---|
| `https://mobilevalidate.com/openapi.yaml` | Published with this site |
| `https://api.mobilevalidate.com/v1/openapi.yaml` | Served by the API itself |

```bash tabs=off
curl -O https://mobilevalidate.com/openapi.yaml
```

Both files describe the same contract. To explore it interactively, open the [API reference](/docs/api-reference): every endpoint with examples, and test requests from your browser with the public sandbox key filled in.

## What can I do with it?

- **Generate a client:** any OpenAPI 3.1 generator works, for example `openapi-generator` or `openapi-typescript`. For TypeScript, the [SDK](/docs/sdk) is the ready-made option.
- **Import into a tool:** Postman, Insomnia, Bruno and similar tools import the file directly. Set the `Authorization: Bearer` header to your test key.
- **Give it to an agent:** coding agents can read the file to write correct integrations. For agents that should run checks, use the [MCP server](/docs/mcp).

## How is it versioned?

The API is versioned in the path (`/v1`). Within v1, changes are additive only: new endpoints, new optional fields and new enum values. Your client should ignore fields it doesn't recognise and tolerate new enum values, such as a new `status`, `reason` or service code. A breaking change would ship as `/v2`, with at least 12 months of overlap and `Deprecation` and `Sunset` headers on the old version. The full policy is on the [versioning](/docs/versioning) page, and notable changes are listed in the [changelog](/changelog).

## Frequently asked questions

### Which OpenAPI version is it?

OpenAPI 3.1, in YAML. It covers every public v1 endpoint, request and response schema, and error code.

### Will the specification change?

Only additively within /v1 — new fields, endpoints and enum values. Breaking changes would ship as /v2 with at least 12 months of overlap.