Skip to main content

Upload a document to a stipulation

Accepts PDF, PNG, JPEG, HEIC, TIFF and DOCX, detected from file contents. Maximum decoded size is 25 MiB. Only a clean virus scan permits storage in S3 and dispatch of the income or funding document command. Does not submit the document to the creditor. Stipulations without an income request or funding requirement do not accept uploads.

Path Parameters
applicationId string REQUIRED
creditorId string REQUIRED
Request Body REQUIRED
stipulationId string REQUIRED
file byte REQUIRED

Base64 encoded file contents, without a data URI prefix

Responses
201

Clean document stored and attachment command completed

Schema OPTIONAL
stipulationId string
documentId string
fileName string
400

Invalid base64, unsupported document type or stipulation, rejected scan, or domain validation failure

403

Access denied

404

Application, creditor application or stipulation not found

413

Decoded file exceeds 25 MiB

500

Scanner, storage or command processing failed