Skip to navigation

Upload provider document

Upload one file as a provider document. Send multipart/form-data with the file in the file field (max 20 MB). Allowed extensions: csv, doc, docx, eml, gif, jpeg, jpg, msg, pdf, png, txt, webp, xls, xlsx.

Authentication

AuthorizationBearer
API key issued for your account. Send as Bearer token in the Authorization header.
X-Plan-Manager-Idstring
Plan manager UUID. Required on all public API requests to scope data access.

Path parameters

provider_idstringRequiredformat: "uuid"
Provider UUID

Request

This endpoint expects a multipart form containing a file.
filefileRequired
File to upload
document_namestringOptional

Display name (defaults to the file name)

document_typestringOptional

Document type (defaults to Other)

Response

Document uploaded
idstring

Document id (bigint as string)

created_atdatetimeOptional
providerstringOptionalformat: "uuid"
document_namestringOptional
document_typestringOptional

Errors

400
Bad Request Error
403
Forbidden Error
404
Not Found Error
413
Content Too Large Error
500
Internal Server Error