Search
K
Embedded Finance

ListDocumentUploadsParams

object
include_unconfirmedboolean

Include unconfirmed documents in the response

Default:false

Example

DocumentUploadResponse

object
idstring(uuid)required
file_namestringrequired
file_typestringrequired

Allowed values:application/pdfimage/pngimage/tiffimage/jpeg

confirmedbooleanrequired
lockedbooleanrequired
Example

DocumentErrorCode

string

Allowed values:not_foundlockeddeletion_failedobject_missing

DocumentErrorResponse

object
error_codestringrequired

Machine-readable error code

Allowed values:not_foundlockeddeletion_failedobject_missing

detailstringrequired

Human-readable error message

Example

InitiateFileUploadResponse

object
upload_idstring(uuid)required

A UUID for the upload. This can be used to identify this file in other endpoints to e.g., track the status of the upload or complete the upload.

upload_urlsobjectrequired

URLs to upload each part of the file to. There will be exactly one URL for each part of the file.

num_partsintegerrequired

The number of parts the file should be split into.

Example