Upload a file
POST
/v1/files
When a file is uploaded, an id will be returned, which shall be used as a reference to a file in other user related endpoints, e.g. when creating or updating user or sending additional verification files.
A validation, based on the file purpose and the MIME type is performed.
The filename must be minimum 3 characters long and maximum 255 characters long. The filename cannot start with "." (dot). The file should have a minimum of 15 bytes, and a maximum of 200 megabytes.
proof_of_address should be use to upload files used as evidence of the permanent residential address of a natural person, such as:application/pdf, application/json)image/bmp, image/x-ms-bmp, image/x-bmp, image/jpeg, image/png, image/heic, image/heif, application/pdf)image/bmp, image/x-ms-bmp, image/x-bmp, image/jpeg, image/png, image/heic, image/heif, application/pdf)image/bmp, image/x-ms-bmp, image/x-bmp, image/jpeg, image/png, image/heic, image/heif, application/pdf)image/bmp, image/x-ms-bmp, image/x-bmp, image/jpeg, image/png, image/heic, image/heif, application/pdf)image/bmp, image/x-ms-bmp, image/x-bmp, image/jpeg, image/png, image/heic, image/heif, application/pdf)image/bmp, image/x-ms-bmp, image/x-bmp, image/jpeg, image/png, image/heic, image/heif, application/pdf)image/bmp, image/x-ms-bmp, image/x-bmp, image/jpeg, image/png, image/heic, image/heif, application/pdf)video/*)image/bmp, image/x-ms-bmp, image/x-bmp, image/jpeg, image/png, image/heic, image/heif, application/pdf)application/pdf , image/bmp, image/x-ms-bmp, image/x-bmp, image/jpeg, image/png, image/heic, image/heif* , video/*)Request
Body Params multipart/form-dataRequired
Responses
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://test.whitelabel.bitpanda.com/v1/files' \
--header 'Authorization: Bearer <token>' \
--form 'purpose="passport"' \
--form 'file=@"@/path/to/file.pdf"'Response Response Example
201 - Example 1
{
"data": [
{
"id": "f31f3c22-e7ea-11ec-8fea-0242ac120002",
"name": "user_verification.pdf",
"type": "application/pdf",
"size": 25,
"purpose": "verification_report",
"url": "/v1/files/f31f3c22-e7ea-11ec-8fea-0242ac120002/contents",
"created_at": "2022-07-20T08:14:20+00:00"
}
]
}