Skip to main content
POST
/
v1
/
verification
/
user
Initiate KYC verification
curl --request POST \
  --url https://api.ledger.so/v1/verification/user \
  --header 'Api-Key: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "userId": "<string>"
}
'
{
  "object": "verification",
  "userId": "<string>",
  "applicationStatus": "notStarted",
  "verificationUrl": "<string>"
}

Authorizations

​
Api-Key
string
header
required

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

Body

application/json
​
userId
string
required

ID of the user to verify

Response

Verification initiated

​
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