OpenAPI specification

The full contract of the MobileValidate API is published as an OpenAPI 3.1 document at /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?

curl -O https://mobilevalidate.com/openapi.yaml

Both files describe the same contract. To explore it interactively, open the 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 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.

#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 page, and notable changes are listed in the changelog.