Skip to content

Developers

Compliance Infrastructure

For onboarding, KYC, and form products that need the Document Rules API and POST /api/v1/photos/check without rebuilding embassy math. SDKs for JavaScript and Python.

Public requirements API (no key)

Read-only catalog of published photo rules for crawlers, tools, and answer engines. Not a government API and not immigration advice. CORS is open (Access-Control-Allow-Origin: *).

  • GET /api/public/requirements — index of every catalog document (id, path, size_mm, per-doc API URL)
  • GET /api/public/requirements/{country}/{document} — short answer, mm/px, head/eye bands, glasses, source URL (e.g. /api/public/requirements/us/visa)
  • Same entity paths as /requirements/{country}/{document} HTML pages
  • Cache-Control: public, max-age=3600

Platform API (API key + USD wallet)

  • Bearer API keys (pf_live_…) — cookies are rejected on /api/v1/*
  • GET /api/v1/rules — Document Rules API (authority, dimensions, editing policy, source)
  • POST /api/v1/photos/check — Ready / Review / Retake JSON (same math as Create)
  • POST /api/v1/photos/validate — Ready / Review / Retake JSON
  • POST /api/v1/photos/jobs — bulk validate (max 20)
  • POST /api/v1/photos/background — identity-safe backdrop replace
  • Metered to your USD wallet (HTTP 402 when empty)
EndpointPrice
GET /api/v1/accountFree
GET /api/v1/documentsFree
GET /api/v1/rulesFree
GET /api/v1/pricingFree
GET /api/v1/photos/jobsFree
POST /api/v1/photos/validate$0.05
POST /api/v1/photos/check$0.05
POST /api/v1/photos/jobs$0.05
POST /api/v1/photos/background$0.25
Compliance Infrastructure API