POST /v1/domain-vetting/reports

Authentication

Send an API key as a bearer token. This endpoint does not state a specific permission in the specification, so give your key the least it needs and check the response rather than assuming.

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/domain-vetting/reports \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "domain": <string> }'

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

Starts a pre-purchase report on domain for the search market location_code (default 2840, the United States). One report credit is taken when the report is created and the report is built in the background (poll GET /v1/domain-vetting/reports/{report_id}). A report where nothing could be read, or one the account's standing no longer allows by the time it runs, gives its credit back. Asking again about the same domain and market inside reuse_days returns the existing report with 200 and costs nothing. Refused with 403 when the organisation holds no credit or is not in good standing, 422 for something that is not a domain or a market we read, and 503 when reports cannot be started right now — in every refusal no credit is taken.

Request body

Response

Errors this endpoint can return

400 · 401 · 403 · 404 · 422 · 503