documents
Private document delivery and structured document intake.
Private document delivery and structured document intake.
| Method | Path | Operation | Scope | Test mode |
|---|---|---|---|---|
| GET | /d/{token} | documents_public_view: What is waiting behind this link (no file yet) | public | - |
| POST | /d/{token}/code | documents_public_request_code: Send me the one-time code | public | - |
| GET | /d/{token}/file | documents_public_download: Download the document (redirect to a 5-minute signed URL) | public | - |
| POST | /d/{token}/verify | documents_public_verify: Enter the one-time code | public | - |
| GET | /v1/documents/checklists | document_checklists_list: Saved document checklists | contacts:read | - |
| POST | /v1/documents/checklists | document_checklists_create: Save a reusable document checklist | contacts:write | - |
| DELETE | /v1/documents/checklists/{checklist_id} | document_checklists_delete: Delete a checklist | contacts:write | - |
| GET | /v1/documents/checklists/{checklist_id} | document_checklists_get: One saved checklist | contacts:read | - |
| PATCH | /v1/documents/checklists/{checklist_id} | document_checklists_update: Change, archive or restore a checklist | contacts:write | - |
| POST | /v1/documents/checklists/{checklist_id}/send | document_checklists_send: Ask one or many customers for the documents on a checklist | messages:send | - |
| GET | /v1/documents/deliveries | documents_list_deliveries: List document deliveries | messages:read | - |
| POST | /v1/documents/deliveries | documents_create_delivery: Send one document to one verified person | messages:send | - |
| GET | /v1/documents/deliveries/{delivery_id} | documents_get_delivery: Get one delivery | messages:read | - |
| GET | /v1/documents/deliveries/{delivery_id}/accesses | documents_delivery_accesses: Who tried to open this document, and when | messages:read | - |
| POST | /v1/documents/deliveries/{delivery_id}/resend | documents_resend_delivery: Send the link again | messages:send | - |
| POST | /v1/documents/deliveries/{delivery_id}/revoke | documents_revoke_delivery: Revoke a delivery | messages:send | - |
| GET | /v1/documents/requests | documents_list_requests: List document checklists | contacts:read | - |
| POST | /v1/documents/requests | documents_create_request: Create a document checklist for one customer | contacts:write | - |
| GET | /v1/documents/requests/{request_id} | documents_get_request: Get one checklist with its lines | contacts:read | - |
| POST | /v1/documents/requests/{request_id}/attach | documents_attach_request_file: Attach a received file to a checklist line | contacts:write | - |
| POST | /v1/documents/requests/{request_id}/cancel | documents_cancel_request: Cancel a checklist | contacts:write | - |
| POST | /v1/documents/requests/{request_id}/items/{item_id}/review | documents_review_request_item: Accept a line, or reject it with a reason | contacts:write | - |
| POST | /v1/documents/requests/{request_id}/remind | documents_remind_request: Chase the missing lines now | messages:send | - |
| POST | /v1/documents/requests/{request_id}/send | documents_send_request: Send the checklist to the customer | messages:send | - |
Request and response schemas: the interactive reference at https://api.wapitick.com/docs, or docs/api/openapi.json.