Skip to main content
PUT
/
v1
/
verification
/
user
/
{userId}
/
document
Upload KYC document
curl --request PUT \
  --url https://api.ledger.so/v1/verification/user/{userId}/document \
  --header 'Api-Key: <api-key>' \
  --header 'Content-Type: multipart/form-data' \
  --form documentType=passport \
  --form file='@example-file'
{
  "object": "verification",
  "userId": "<string>",
  "applicationStatus": "notStarted",
  "verificationUrl": "<string>"
}

Authorizations

Api-Key
string
header
required

API key for authentication. Get your key from the Dashboard.

Path Parameters

userId
string
required

The user ID

Body

multipart/form-data
documentType
enum<string>
required
Available options:
passport,
driversLicense,
nationalId,
proofOfAddress
file
file
required

Response

Document uploaded

object
enum<string>
required
Available options:
verification
userId
string
required
applicationStatus
enum<string>
required
Available options:
notStarted,
pending,
needsInformation,
needsVerification,
manualReview,
approved,
denied,
locked,
canceled
verificationUrl
string<uri>

URL for the user to complete KYC