Skip to main content
POST
/
documents
/
accounts
/
{account_id}
/
upload
Upload a document for an account
curl --request POST \
  --url https://api.bluum.finance/v1/documents/accounts/{account_id}/upload \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: multipart/form-data' \
  --form file='@example-file' \
  --form document_type=id_verification
{
  "document_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "upload_status": "processing",
  "uploaded_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

HTTP Basic Authentication using the API Key as username and API Secret as password.

Path Parameters

​
account_id
string<uuid>
required
Example:

"3d0b0e65-35d3-4dcd-8df7-10286ebb4b4b"

Body

multipart/form-data
​
file
file
required

The binary content of the document file (e.g., PDF or JPG).

​
document_type
enum<string>
required

The type of document being uploaded.

Available options:
id_verification,
proof_of_address,
w9_form

Response

Document uploaded and processing has begun

​
document_id
string<uuid>
​
account_id
string<uuid>
​
upload_status
enum<string>
Available options:
processing,
approved,
rejected
​
uploaded_at
string<date-time>