Skip to main content
POST
/
api
/
external
/
file
/
get-presigned-url
Request file upload URL
curl --request POST \
  --url https://api-prod.blaaiz.com/api/external/file/get-presigned-url \
  --header 'Content-Type: application/json' \
  --header 'x-blaaiz-api-key: <api-key>' \
  --data '
{
  "customer_id": "customer_123",
  "file_category": "identity"
}
'
{
  "message": "Upload URL generated successfully",
  "file_id": "file_123456789",
  "url": "https://s3.amazonaws.com/bucket/path?signature=xyz",
  "headers": {
    "Content-Type": "image/jpeg"
  }
}

Authorizations

x-blaaiz-api-key
string
header
required

Body

application/json

This endpoint allows you to request a pre-signed URL to upload a file for a customer. You will specify the file type you want to upload and for whom.

File Category identity - Identity. Required to verify a customer. proof_of_address - Proof of address. liveness_check - Liveness check.

customer_id
string
required

Unique identifier of the customer

file_category
enum<string>
required

Category of the file

Available options:
identity,
proof_of_address,
liveness_check

Response

Upload URL generated successfully

message
string
required
file_id
string
required

Unique identifier for the file

url
string<uri>
required

Pre-signed URL to upload the file

headers
object
required

Headers to include when uploading the file