Skip to main content

​
Users

Users are KYC-verified individuals who fund card spending. Each user goes through identity verification, deposits funds, and their agents can then issue cards.

​
Lifecycle

1

Create

Create a user application with basic info
2

KYC

User completes verification via the provided link
3

Deposit

User deposits funds
4

Active

Agents can issue cards against the user’s balance

​
Create a User

curl -X POST https://api.ledger.so/v1/applications/user/initiate \
  -H "Api-Key: $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "firstName": "John",
    "lastName": "Doe",
    "email": "[email protected]"
  }'

{
  "id": "user_abc123",
  "applicationStatus": "pending",
  "applicationCompletionLink": "https://verify.ledger.so/xyz"
}
The user completes KYC via the applicationCompletionLink.

​
Application Status

StatusDescription
pendingAwaiting KYC completion
needsInformationAdditional info required
manualReviewUnder manual review
approvedReady to deposit
deniedVerification failed

​
Check Balance

curl https://api.ledger.so/v1/users/$USER_ID/balance \
  -H "Api-Key: $API_KEY"

{
  "userId": "user_abc123",
  "balance": 10000,
  "pendingCharges": 0,
  "postedCharges": 0,
  "spendingPower": 10000
}
FieldDescription
balanceTotal deposited (cents)
pendingChargesAuthorized but unsettled
postedChargesSettled transactions
spendingPowerAvailable for new cards

​
Webhooks

EventDescription
user.application.approvedKYC passed
user.application.deniedKYC failed
user.balance.updatedBalance changed
deposit.receivedFunds received

Deposits & Withdrawals

Learn how to deposit and withdraw funds