partner

GET /v1/partner/customers/{externalId}/holder-verifications

Your customer's nic.at holder verifications.

All partner endpoints

All developer docs →

Authentication

Send an API key as a bearer token. The key must carry the partner.domains permission; a key without it is refused with 403, not 404.

This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.

Try it

Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.

curl -X GET https://api.zinndigital.com/v1/partner/customers/{externalId}/holder-verifications \
  -H "Authorization: Bearer zdk_live_…"

Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console

Details

The same cases the customer sees in their dashboard (see listHolderVerifications). You also receive every step as domain.holder_verification.* events on your webhook and /v1/partner/events. Requires partner.domains.

Parameters

NameTypeRequiredWhat it is
externalId (path)stringYesYOUR id for that customer — whatever your own system calls them. It is what makes linking idempotent, and it is scoped to your partner programme: another partner's id is a 404…
state (query)string<open, all>No—

Response

NameTypeRequiredWhat it is
itemsHolderVerification[]Yes—
countintegerYes—

Errors this endpoint can return

401 · 403 · 404 · 429