Create file upload session
Request
Add parameter in header X-API-Key
Example:X-API-Key: ********************
or
Add the parameter Authorization
to Headers Example:Authorization: ********************
or
Body Params application/jsonRequired
{
"fileName": "invoice.jpg",
"fileType": "PAYMENT_SUPPORTING_DOCUMENT",
"purpose": "PAYMENT"
}
Request Code Samples
curl --location 'http://prod-cn.your-api-server.com/api/v1/files' \
--header 'X-API-Key: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
"fileName": "invoice.jpg",
"fileType": "PAYMENT_SUPPORTING_DOCUMENT",
"purpose": "PAYMENT"
}'
Responses
{
"fileId": "string",
"uploadStatus": "PENDING",
"fileName": "string",
"fileType": "string",
"purpose": "string",
"uploadMethod": "PRESIGNED_URL",
"uploadUrl": "http://example.com",
"expiresAt": "2019-08-24T14:15:22.123Z"
}
Modified at 2026-06-05 07:31:32