Skip to navigation
Partner Guides

OpenAPI Spec

Download the complete Partner API definition to generate a client or import it into your tools.

This is the OpenAPI 3.0 file the Partner API reference is built from. It lists every endpoint, request and response schema, error code, and response header.

Generate code from this file, not from /openapi.json. The docs site also serves an automatic export at https://docs.confirm.global/openapi/partner-api.json. That export drops every response header, including X-Request-Id. The file above is the complete definition.

What the file includes

  • Every /partner/v1 endpoint, with request bodies, parameters, and response schemas.
  • The error envelope and every stable error code.
  • The X-Request-Id response header, declared once under components.headers and referenced from every response.
  • The production server URL. For the sandbox, swap in https://api-staging.confirm.global/partner/v1.

Keeping up to date

The file updates whenever the API reference does. Download it again before you regenerate your client.