marketplace
POST /v1/marketplace/vendor/verification/documents
Reserve a document slot and get a short-lived upload URL.
認証
ベアラー トークンとして API キーを送信します。このエンドポイントでは仕様に特定の権限が記載されていないため、キーに必要な最小限の権限を付与し、推測するのではなくレスポンスを確認してください。
このエンドポイントは組織IDを受け付けません。お使いのキーによって所属する組織がすでに特定されており、レスポンスはその組織にスコープされます。
試してみる
アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。
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コンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブ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