marketplace

GET /v1/marketplace/vendor/verification/documents/{document_id}/url

A short-lived URL that downloads one identity document.

All marketplace endpoints

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 GET https://api.zinndigital.com/v1/marketplace/vendor/verification/documents/{document_id}/url \
  -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

⛔⛔ **Every view is audit-logged**, including the seller's own view of their own passport. docs/82 §7a asks *"who looked at this document"*, and the honest answer includes the account holder — a support agent investigating an account takeover needs to know the documents were pulled, and from which session. The URL carries its own signature and is therefore a credential for its lifetime. Never log it, never store it.

Parameters

NameTypeRequiredWhat it is
document_id (path)stringYes

Response

NameTypeRequiredWhat it is
urlstringYesCarries its own signature and is therefore a credential until it expires. Never log it, never store it.
methodstringYes
expires_atstringYes

Errors this endpoint can return

401 · 404 · 422