partner
POST /v1/partner/customers/{externalId}/holder-verifications/{caseId}/submit
Hand your customer's documents to our verification team.
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 POST https://api.zinndigital.com/v1/partner/customers/{externalId}/holder-verifications/{caseId}/submit \
-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
Refused with 422 until every required kind is uploaded. Requires partner.domains.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
externalId (path) | string | Yes | YOUR 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… |
caseId (path) | Uuid | Yes | — |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
id | Uuid | Yes | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
domain_id | Uuid | Yes | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
fqdn | string | Yes | — |
holder_kind | string<individual, organisation> | Yes | — |
status | HolderVerificationStatus | Yes | pending_confirmation is staff-only (a detected request not yet confirmed) and never returned to a customer or partner. |
issued_at | string | Yes | — |
deadline_at | string | Yes | — |
days_left | integer | Yes | Whole days to the deadline, rounded DOWN, never below 0. |
required_documents | HolderDocumentKind[] | Yes | — |
missing_documents | HolderDocumentKind[] | Yes | — |
customer_message | string | Yes | What our verification team asked you to change; empty when nothing. |
submitted_at | string | No | — |
registrar_submitted_at | string | No | — |
closed_at | string | No | — |
documents_purged_at | string | No | — |
documents | HolderVerificationDocument[] | Yes | — |
Errors this endpoint can return
401 · 403 · 404 · 409 · 422 · 429