Skip to main content
POST
/
api
/
v1
/
members
/
{userId}
/
kyc
/
documents
/
upload-url
Create signed upload URL for KYC document bytes
curl --request POST \
  --url https://app.mlm-platform.com/api/v1/members/{userId}/kyc/documents/upload-url \
  --header 'Content-Type: application/json' \
  --header 'x-tenant-api-key: <api-key>' \
  --data '
{
  "documentType": "government_id_front",
  "fileName": "<string>",
  "mimeType": "<string>"
}
'
{
  "uploadUrl": "<string>",
  "filePath": "<string>",
  "expiresInSeconds": 123
}

Authorizations

​
x-tenant-api-key
string
header
required

Tenant API key for authentication. Keys are scoped to specific environments (LIVE or SANDBOX). Obtain keys from the admin dashboard.

Path Parameters

​
userId
string<uuid>
required

Body

application/json
​
documentType
enum<string>
required
Available options:
government_id_front,
government_id_back,
passport,
proof_of_address,
selfie
​
fileName
string
required
​
mimeType
string
required

MIME type of the file being uploaded. Allowed values are image/jpeg, image/png, and application/pdf.

Response

Signed upload URL created

​
uploadUrl
string<uri>
required
​
filePath
string
required
​
expiresInSeconds
integer
required