Skip to content

API catalogue

What a certified partner can reach

Every route group is classified into one exposure tier. This catalogue lists the public and partner-gated tiers; internal and administrative routes are never listed and never issued.

Public Open reference routesPartner-gated Scoped sandbox keys for certified partners
Sign in as a partner to see the route paths of partner-gated groups.

ZB ID

Service pageReference docs (opens a separate site)

  • Health

    Public
    • GET/
    • GET/actuator/health
    • GET/actuator/info

  • Oidc discovery

    Public
    • GET/.well-known/jwks.json
    • GET/.well-known/openid-configuration

  • Docs redirect

    Public
    • GET/docs

  • Oauth token

    Partner-gated

    1 route, listed for signed-in partners.

Customer 360

Service pageReference docs (opens a separate site)

  • Health

    Public
    • GET/
    • GET/health
    • GET/v1/health
    • GET/v1/ready

  • Events ingest

    Partner-gated

    1 route, listed for signed-in partners.

  • Events read own

    Partner-gated

    4 routes, listed for signed-in partners.

Notification Hub

Service pageReference docs (opens a separate site)

  • Health

    Public
    • GET/health
    • GET/v1/health
    • GET/v1/ready

  • Delivery status

    Partner-gated

    4 routes, listed for signed-in partners.

  • Send

    Partner-gated

    5 routes, listed for signed-in partners.

  • Templates read

    Partner-gated

    3 routes, listed for signed-in partners.

  • Unsubscribe link mint

    Partner-gated

    1 route, listed for signed-in partners.

Banking partner API

Service pageReference docs (opens a separate site)

  • Partner api

    Partner-gated

    8 routes, listed for signed-in partners.

Catalogue environment: staging