domains

POST /v1/domains/holder-verifications/{caseId}/submit

Hand the documents to our verification team.

All domains endpoints

All developer docs →

Authentication

Send an API key as a bearer token. The key must carry the billing.payment.manage 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/domains/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 kind in required_documents is uploaded. The case moves to under_review; reminders stop. Requires billing.payment.manage.

Parameters

NameTypeRequiredWhat it is
caseId (path)UuidYes—

Response

NameTypeRequiredWhat it is
idUuidYesUUIDv7 identifier — sortable by creation time (docs/02 §8).
domain_idUuidYesUUIDv7 identifier — sortable by creation time (docs/02 §8).
fqdnstringYes—
holder_kindstring<individual, organisation>Yes—
statusHolderVerificationStatusYespending_confirmation is staff-only (a detected request not yet confirmed) and never returned to a customer or partner.
issued_atstringYes—
deadline_atstringYes—
days_leftintegerYesWhole days to the deadline, rounded DOWN, never below 0.
required_documentsHolderDocumentKind[]Yes—
missing_documentsHolderDocumentKind[]Yes—
customer_messagestringYesWhat our verification team asked you to change; empty when nothing.
submitted_atstringNo—
registrar_submitted_atstringNo—
closed_atstringNo—
documents_purged_atstringNo—
documentsHolderVerificationDocument[]Yes—

Errors this endpoint can return

401 · 403 · 404 · 409 · 422 · 429