Upload a file
purpose decides who may upload and where the file can be used:
| Purpose | Proof needed | Used in |
|---|---|---|
agreement | Your key | Checkout session attachments |
delivery | Key plus the seller’s customer token | Milestone delivery attachments |
dispute_evidence | Key plus the buyer’s or seller’s customer token | Dispute evidence files |
A file can only be used by the customer who uploaded it, and only for its purpose. Unused files are deleted after 24 hours.
Authorizations
Authorization: Bearer <secret key>. Secret keys belong to your organisation, are shown
once when created in the dashboard, and are scoped (see x-required-scope on each
operation). Keep them on your server. Live keys are issued after your business is
verified. Publishable keys (pk_) are only for @ketapay/checkout and don't work here.
Proof that your customer approved this call, from POST /customer_sessions/{id}/verify.
Sent together with your secret key. Valid for 15 minutes, for that customer's escrows
only.
Headers
Unique key for this operation. Retries with the same key return the first result.
255"7f3e2a10-6c4d-4b8e-9a1f-2d5c8e7b6a40"
Body
Response
Uploaded
"file"agreement, delivery, dispute_evidence "Delivered designs.pdf"
"application/pdf"
x <= 26214400Short-lived link to download the file, valid for 1 hour