POST
Get somewhere to upload a document for a payment

Authorizations

Authorization
string
header
required

The user's token from a completed sign-in. The program and environment come from the token.

Path Parameters

customerId
string
required

The customer

Minimum string length: 1

Query Parameters

programId
string

The program to act on. Ignored for customer tokens.

sandbox
enum<string>

Only when the token carries no sandbox claim: which environment to act in.

Available options:
true,
false

Body

application/json
contentType
enum<string>
required

The file's type. The domain refuses anything else too.

Available options:
application/pdf,
image/jpeg,
image/png,
image/heic,
image/webp
contentLength
integer
required

Exact size of the file in bytes, at most 10 MB

Required range: x <= 10485760
fileName
string

Shown to whoever reviews it; the extension comes from the type

Maximum string length: 255

Response

Where to put the file, and what to send with the payment afterwards

success
enum<boolean>
required
Available options:
true
message
string
required

What happened, for display

data
object
required