marketplace
POST /v1/marketplace/vendor/verification/documents
Reserve a document slot and get a short-lived upload URL.
Аутентификация
Передайте API-ключ в качестве маркера носителя (bearer token). Эта конечная точка не указывает конкретное разрешение в спецификации, поэтому предоставьте своему ключу минимум необходимых прав и проверьте ответ, вместо того чтобы делать предположения.
Этот эндпоинт не принимает идентификатор организации. Ваш ключ уже определяет организацию, к которой он принадлежит, и ответ ограничивается ее рамками.
Попробовать
Замените всё в угловых скобках на собственные значения, а плейсхолдер ключа — на ключ из вашей панели управления.
curl -X POST https://api.zinndigital.com/v1/marketplace/vendor/verification/documents \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "kind": <MarketplaceDocumentKind>, "filename": <string>, "content_type": <string<image/jpeg, image/png, application/pdf>>, "size_bytes": <integer> }'Вошли в систему? Консоль API в вашей панели управления автоматически подставляет реальный идентификатор вашей организации и ваш собственный ключ, а также выполняет запрос к работающему API, чтобы вы могли увидеть актуальный ответ. Откройте эту конечную точку в API-консоли
Подробнее
docs/82 §7a. **The bytes never pass through the engine.** The response carries a presigned `PUT` the browser uploads straight to object storage with; a 10 MB scan routed through an API worker is 10 MB of a request thread and a request that outlives its timeout on a poor connection. ⛔ The stored object key is deliberately absent from the response — the seller needs the signed URL, never the address of an object in a bucket of identity documents. ⛔ **We ask for "a government-issued photo ID"** — passport, national identity card, driving licence or residence permit — and there is no country list. A student, workplace or library card is not government-issued and is not accepted.
Тело запроса
| Имя | Тип | Обязательно | Что это |
|---|---|---|---|
kind | MarketplaceDocumentKind | Да | What a stored object is evidence of. `photo_id` covers passport, national identity card, driving licence and residence permit — there is no country list, and a student, workplac… |
subject_id | string | Нет | Required for `photo_id` and `proof_of_address` — a personal document with no person satisfies nobody's requirement while looking uploaded on every screen. |
filename | string | Да | — |
content_type | string<image/jpeg, image/png, application/pdf> | Да | JPEG, PNG or PDF. An allow-list, not a deny-list. |
size_bytes | integer | Да | — |
Ответ
| Имя | Тип | Обязательно | Что это |
|---|---|---|---|
document | MarketplaceVerificationDocument | Да | A pointer to one uploaded document. The bytes live in object storage and are reached only through a short-lived signed URL; the object key is never published. |
upload | MarketplaceDocumentUploadGrant | Да | A presigned upload. The `headers` are part of the grant, not decoration — a signature computed over `content-type` fails with a 403 if the uploader omits it. |
Ошибки, которые может возвращать этот эндпоинт
401 · 404 · 422