Skip to main content
The API has one public contract for every country. Select the country with the country field and send the same array shape to v1 or v2. The integration method, government credentials, retries, provider cost, and internal capacity are never chosen or exposed by the client.

​
Catalog

The current commercial catalog is mx, ar, and co. Spain, Australia, and Singapore are coming end of September 2026 (not live yet). The es, au, and sg codes remain in the technical API contract for forward-compatible schema documentation. The catalog is not an entitlement or availability promise: a country must be included in the organization’s Country Purchase and operationally available at admission. Colombia is currently sellable and operational; its Country Purchase becomes active as soon as the initial invoice is paid, without an approval or activation step. A paid prepaid country that is not manually activated returns 503 country_service_temporarily_unavailable; the API never exposes pending_activation, Registry Capacity, provider balances, or the reason for the operational block. Colombia requests still fail closed during a provider outage or an operator maintenance window, without exposing provider details.

​
Shared semantics

  • v1 returns one complete result synchronously for at most 10,000 inputs and 25 MiB of JSON body, whichever limit is reached first.
  • v2 accepts at most 500,000 inputs and 25 MiB of JSON body, whichever limit is reached first, and returns a durable job.
  • A country maintenance window returns country_service_maintenance; other temporary failures return country_service_temporarily_unavailable.
  • Country service failures never produce partial results and do not consume Customer Quota.
  • customer_quota_exceeded is a commercial quota error, distinct from a country service failure.
Country-specific operational dossiers are maintained internally for Colombia, Spain, Australia, and Singapore. Those documents describe implementation gates; they do not change this public API contract.