Skip to main content
POST
/
api
/
files
/
upload
Upload File
curl --request POST \
  --url http://127.0.0.1:8083/api/files/upload \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --header 'X-API-Secret: <api-key>' \
  --data '
{
  "file": "<string>"
}
'
{
  "file_id": "<string>"
}

Authorizations

​
X-API-Key
string
header
required

Includes an API key in the HTTP headers to authenticate the client.

​
X-API-Secret
string
header
required

Includes an API secret in the HTTP headers to authenticate the client.

Query Parameters

​
file_type
enum<string>
required

File Type Code. Valid values vary based on the specific business scenario:

1. Customer Corporate Documents

  • Business Registration: Official business license.
  • Article of Association: Corporate constitutional documents.

2. Customer Legal Representative ID

  • Main page: Front side of the ID card or Passport bio-data page.
  • Back page: Back side of the ID card.

3. Transfer Documents Or Recipient Documents

  • Invoice: Billing document for payment request.
  • Contract: Supporting service/goods contract.

Note: Ensure the uploaded file_type matches the specific business context (Customer,Recipient,Transfer).

Available options:
Invoice,
Contract,
Business Registration,
Article of Association,
Main page,
Back page
Pattern: ^(Invoice|Contract|Business Registration|Article of Association|Main page|Back page)$
Example:

"Business Registration"

Body

application/json
​
file
file

file

Response

Operation Successful

​
file_id
string

File ID