Skip to main content
POST
/
api
/
v1
/
members
/
{userId}
/
kyc
/
documents
Record KYC document metadata after upload
curl --request POST \
  --url https://app.mlm-platform.com/api/v1/members/{userId}/kyc/documents \
  --header 'Content-Type: application/json' \
  --header 'x-tenant-api-key: <api-key>' \
  --data '
{
  "fileName": "<string>",
  "mimeType": "<string>",
  "fileSize": 123,
  "filePath": "<string>"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "documentType": "<string>",
  "fileName": "<string>",
  "mimeType": "<string>",
  "fileSize": 123,
  "status": "<string>",
  "createdAt": "2023-11-07T05:31:56Z"
}

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
​
fileSize
integer
required
​
filePath
string

Response

Document recorded

​
id
string<uuid>
​
documentType
string
​
fileName
string
​
mimeType
string
​
fileSize
integer
​
status
string
​
createdAt
string<date-time>