marketplace

POST `/v1/marketplace/vendor/verification/documents`

Reserve a document slot and get a short-lived upload URL.

Autenticação

Envie uma chave de API como um token bearer. Este endpoint não especifica uma permissão específica na documentação, portanto, conceda à sua chave o mínimo necessário e verifique a resposta em vez de assumir.

Este endpoint não requer um ID de organização. Sua chave já identifica a organização à qual pertence, e a resposta é delimitada a ela.

Experimente

Substitua qualquer item entre colchetes por seus próprios valores e o espaço reservado para a chave por uma chave do seu painel.

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> }'

Conectado? O console da API no seu painel preenche o ID da sua organização real e a sua própria chave, e executa a requisição contra a API de produção para que você possa ver a resposta real. Abra este endpoint no console da API

Detalhes

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.

Corpo da requisição

Nome	Tipo	Obrigatório	O que é
`kind`	`MarketplaceDocumentKind`	Sim	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`	Não	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`	Sim	—
`content_type`	`string<image/jpeg, image/png, application/pdf>`	Sim	JPEG, PNG or PDF. An allow-list, not a deny-list.
`size_bytes`	`integer`	Sim	—

Resposta

Nome	Tipo	Obrigatório	O que é
`document`	`MarketplaceVerificationDocument`	Sim	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`	Sim	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.

Erros que este endpoint pode retornar

401 · 404 · 422

POST /v1/marketplace/vendor/verification/documents