Breeze.cash

Breeze.cash Headless KYC API

The Headless KYC API from Breeze.cash — 6 operation(s) for headless kyc.

GitHub OpenAPI

Operations 7

GET /v1/headless_kyc Get a KYC request by customer reference ID #
POST /v1/headless_kyc Submit KYC for a customer (via image URL) #
POST /v1/headless_kyc/proof_of_address Submit a proof of address for a customer (via document URL) #
POST /v1/headless_kyc/proof_of_address/upload Submit a proof of address for a customer (via document upload) #
GET /v1/headless_kyc/{id} Get a KYC request by ID #
POST /v1/headless_kyc/{id}/initiate_tier_3_kyc Initiate Tier 3 verification for a KYC request #
POST /v1/headless_kyc? Submit KYC for a customer (via image upload) #

Documentation

📖
Documentation
https://www.breeze.com/developers
📖
Documentation
https://docs.breeze.com/

Specifications

⚙
OpenAPI
https://artifacts.apis.io/breezecash/openapi/breezecash-headless-kyc-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/breezecash/json-schema/breezecash-create-gateway-payment-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/breezecash/json-schema/breezecash-create-subscription-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/breezecash/json-schema/breezecash-create-payment-page-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/breezecash/json-schema/breezecash-expire-payment-page-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/breezecash/json-schema/breezecash-get-all-payment-attempts-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/breezecash/json-schema/breezecash-create-gateway-payment-response-schema.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/breezecash:breezecash-headless-kyc-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

breezecash-headless-kyc-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Breeze Headless KYC API
  version: 1.0.0
  description: Breeze payment processing API
  contact:
    email: support@breeze.cash
    url: https://docs.breeze.cash
servers:
- url: https://api.breeze.cash
  description: Breeze API
- url: https://secure.breeze.cash
  description: Breeze Direct Payment API (production)
- url: https://secure-sandbox.breeze.cash
  description: Breeze Direct Payment API (sandbox)
security:
- basicAuth: []
tags:


# --- truncated at 32 KB (45 KB total) ---
# Full source: https://artifacts.apis.io/breezecash/openapi/breezecash-headless-kyc-api-openapi.yml