Skip to main content
GET
/
v1
/
verification
/
user
/
{userId}
/
link
Get KYC verification link
curl --request GET \
  --url https://api.ledger.so/v1/verification/user/{userId}/link \
  --header 'Api-Key: <api-key>'
{
  "object": "verification_link",
  "userId": "user_abc123",
  "verificationUrl": "https://kyc.ledger.so/verify/xyz789",
  "applicationStatus": "pending"
}

Authorizations

​
Api-Key
string
header
required

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

Path Parameters

​
userId
string
required

The user ID

Response

Verification link

​
object
enum<string>
required
Available options:
verification_link
​
userId
string
required

The user ID

​
verificationUrl
string<uri>
required

URL for the user to complete KYC verification

​
applicationStatus
enum<string>
required

Current KYC status

Available options:
notStarted,
pending,
needsInformation,
needsVerification,
manualReview