Skip to main content
POST

Authorizations

BIZ-API-KEY
string
header
required

The API key. For more details, refer to API key.

In the API playground, enter your API secret, and your API key will be accordingly calculated.

Body

application/json

The request body to upload a file.

file_name
string
required

The original file name, including the file extension.

Example:

"business_registration.pdf"

file_content
string
required

The file content, encoded in Base64.

Example:

"JVBERi0xLjQKJeLjz9MKMSAwIG9iago8PC9UeXBlL0NhdGFsb2cvUGFnZXMgMiAwIFI+PgplbmRvYmoK"

Response

The request was successful.

file_id
string
required

The AWS file link of the uploaded file.

Example:

"https://example-bucket.s3.us-east-1.amazonaws.com/uploads/business_registration.pdf"

expired_timestamp
integer<int64>
required

The time when the uploaded file link expires, in Unix timestamp format, measured in milliseconds.

Example:

1701483266000