POST
Upload a file

Authorizations

Authorization
string
header
default:sk_test_docs_246e232c64ccc7a001bf61ec0f2e6ab0
required

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.

KetaPay-Customer-Token
string
header
required

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

Idempotency-Key
string
required

Unique key for this operation. Retries with the same key return the first result.

Maximum string length: 255
Example:

"7f3e2a10-6c4d-4b8e-9a1f-2d5c8e7b6a40"

Body

multipart/form-data
file
file
required

The file, up to 25 MB

purpose
enum<string>
required
Available options:
agreement,
delivery,
dispute_evidence

Response

Uploaded

id
string<uuid>
required
object
string
required
Allowed value: "file"
purpose
enum<string>
required
Available options:
agreement,
delivery,
dispute_evidence
name
string
required
Example:

"Delivered designs.pdf"

mime_type
string
required
Example:

"application/pdf"

size_bytes
integer
required
Required range: x <= 26214400
url
string<uri>
required

Short-lived link to download the file, valid for 1 hour

created_at
string<date-time>
required