Delete a Document
Removes an identity document from a customer's verification record. The slot is freed and its bytes return to the record's budget. To replace a document, you can also presign its slot again.
Takes a workspace-scoped API key or a dashboard session. An account-scoped key is refused with 401.
New in v3: v2 has no equivalent.
Authorization:
Every request is signed with your API key: a short-lived JWT, signed with your private key, sent in one header on /v3/* and /api/v2/* alike.
Headers:
Authorization: APIKey {SIGNED_JWT}
How to build and sign the JWT: Authentication.
Endpoint
/v3/customers/{customer_id}/kyc/documents/{document_id}
Path parameters
| Parameter | Type | Description |
|---|---|---|
customer_id | string (cst_…) | Required. The customer. Its record must be pending or needs_update. |
document_id | string (doc_…) | Required. The document. |
Response
204 No Content, with no body.
Errors
| Status | message | When |
|---|---|---|
400 | failed to parse request | customer_id or document_id is not a TypeID of its kind. |
401 | unauthorized | Missing or invalid signature, or the caller is an account-scoped key or a customer session. |
403 | forbidden | A dashboard member whose role does not allow this. A workspace-scoped key always may. |
404 | kyc_not_found | The customer has no record. |
404 | document_not_found | The record has no document with this id. |
409 | kyc_verification_in_flight | The record is in_review. |
409 | kyc_already_approved | The record is approved. |
409 | kyc_rejected | The record is rejected. |
Support and Resources
If you need assistance or have any questions, our support team is here to help. You can contact our support team at support@blockwyre.com.
Stay Updated
Stay up-to-date with the latest news, updates, and features from BlockWyre by following us on social media:
- Instagram: BlockWyre Instagram
- Twitter: BlockWyre Twitter
- Facebook: BlockWyre Facebook
- LinkedIn: BlockWyre LinkedIn
We are excited to have you on board and look forward to seeing how you leverage BlockWyre's powerful tools to enhance your financial operations. Happy integrating!