Catalog - UIP Documentation

GET https://api.uip.digital/v1/catalog · Auth: Bearer API key · Free (no charge)

The discovery catalog: the countries, wallets, and primitives the platform supports right now, in one call — so your backend can resolve support deterministically instead of hard-coding it. Authenticated with your API key, but free — it never charges wallet units.

This is the server-side counterpart to the public GET /v1/wallets that UIP’s hosted page uses. Same wallet-capability data, plus countries and a top-level primitives list, behind your API key.

Response

countries

object[]

Jurisdictions UIP covers today. Discovery metadata only — UIP routes by wallet, not country.

Show country

code

string

ISO 3166-1 alpha-2 code, e.g. US.

name

string

Display name, e.g. United States.

wallets

string[]

Ids of the wallets available in this country.

wallets

object[]

Show wallet

string

Stable wallet id, e.g. apple-wallet.

label

string

Display name, e.g. Apple Wallet.

available

boolean

Whether an active adapter can verify this wallet today.

primitives

object

Per-primitive support booleans (identify, age_verify, sign, light_sign).

primitives

object[]

Show primitive

string

Primitive slug, e.g. identify.

available

boolean

Whether any active adapter can fulfill this primitive today.

{
  "countries": [
    { "code": "US", "name": "United States", "wallets": ["apple-wallet", "google-wallet"] }
  ],
  "wallets": [
    {
      "id": "apple-wallet",
      "label": "Apple Wallet",
      "available": true,
      "primitives": { "identify": true, "age_verify": true, "sign": true, "light_sign": true }
    },
    {
      "id": "google-wallet",
      "label": "Google Wallet",
      "available": true,
      "primitives": { "identify": true, "age_verify": true, "sign": true, "light_sign": true }
    }
  ],
  "primitives": [
    { "id": "identify", "available": true },
    { "id": "age_verify", "available": true },
    { "id": "sign", "available": true },
    { "id": "light_sign", "available": true }
  ]
}

The booleans are derived from the live backend adapters, so the response is always the source of truth — never hard-code support. See Wallets & coverage for context.

​Response

Response