Quickstart

Use this guide to take a business from verification to issued cards.

Checklist

Complete KYB
Enroll as a business (POST /business/application)
Create users (POST /users)
Enroll user(s) (POST /cards/enroll)
Create cards (POST /cards/users/{userId}/issue) - up to 50 non-canceled cards per user

Before you start

EasyOnRamp gives you a Bearer JWT for each environment. Sandbox and production use separate credentials and separate data. See Production and sandbox and Authentication. Confirm your token and KYB status:

GET /business

curl -s https://b2b-api.easyonramp.com/api/v1/business \
  -H "Authorization: Bearer YOUR_JWT"

You need an API token and approved business KYB before the company application. If kybStatus is not approved, complete the verification link returned by GET /business when it is present.

1. Complete KYB

Poll GET /business or subscribe to business.kyb.* until KYB is approved. Start here: Business account

2. Enroll as a business

Fetch agreement copy (public), then submit one EasyCard application.

GET /business/application/terms

curl -s "https://b2b-api.easyonramp.com/api/v1/business/application/terms"

POST /business/application

curl -s -X POST "https://b2b-api.easyonramp.com/api/v1/business/application" \
  -H "Authorization: Bearer YOUR_JWT" \
  -H "Content-Type: application/json" \
  -d '{
    "initialUser": {
      "firstName": "Jane",
      "lastName": "Doe",
      "birthDate": "1990-05-15",
      "nationalId": "9005155800085",
      "countryOfIssue": "ZA",
      "email": "jane@acme.example",
      "phoneCountryCode": "27",
      "phoneNumber": "821234567",
      "occupation": "15-1132",
      "annualSalary": "50000",
      "accountPurpose": "Business spending",
      "expectedMonthlyVolume": "1000",
      "role": "ADMIN",
      "address": {
        "line1": "12 Main Road",
        "city": "Johannesburg",
        "postalCode": "2000",
        "countryCode": "ZA"
      }
    },
    "name": "Acme Pty Ltd",
    "address": {
      "line1": "12 Main Road",
      "city": "Johannesburg",
      "region": "Gauteng",
      "postalCode": "2000",
      "countryCode": "ZA"
    },
    "entity": {
      "name": "Acme Pty Ltd",
      "description": "Payments platform",
      "industry": "522320",
      "registrationNumber": "2020/123456/07",
      "taxId": "9123456789",
      "website": "https://acme.example",
      "type": "limitedLiabilityCompany",
      "expectedSpend": "10000"
    },
    "agreements": {
      "eSignConsent": true,
      "cardTerms": true,
      "infoAccuracy": true,
      "noSolicitation": true
    }
  }'

Poll GET /business/application or subscribe to business.application.* until status is approved.

3. Create users

Create end users with name, birthDate (YYYY-MM-DD, age 18+), email, phone, password, and optional subAccountId / physicalAddress. Complete user KYC when required. Start here: Create and manage users

4. Enroll user(s)

After the EasyCard application is approved, enroll end users on that application. userId accepts a single id or an array of ids in one request. Each user must already exist on your account (from POST /users).

POST /cards/enroll (one user)

curl -s -X POST "https://b2b-api.easyonramp.com/api/v1/cards/enroll" \
  -H "Authorization: Bearer YOUR_JWT" \
  -H "Content-Type: application/json" \
  -d '{"userId":"USER_ID"}'

POST /cards/enroll (multiple users)

curl -s -X POST "https://b2b-api.easyonramp.com/api/v1/cards/enroll" \
  -H "Authorization: Bearer YOUR_JWT" \
  -H "Content-Type: application/json" \
  -d '{"userId":["USER_ID_1","USER_ID_2"]}'

Poll GET /cards/users/{userId}/enroll or subscribe to card.enrollment.* until status is approved for each user. You cannot issue cards while enrollment is pending.

5. Create cards

Issue a virtual or physical card (repeat up to 50 non-canceled cards per user).

Virtual: send physicalAddress unless the user already has one stored.
Physical: require shippingAddress (and acceptCharge when fees apply).

POST /cards/users/USER_ID/issue (virtual)

curl -s -X POST "https://b2b-api.easyonramp.com/api/v1/cards/users/USER_ID/issue" \
  -H "Authorization: Bearer YOUR_JWT" \
  -H "Content-Type: application/json" \
  -d '{
    "cardType": "virtual",
    "displayName": "Jane Doe Card",
    "physicalAddress": {
      "line1": "12 Main Road",
      "city": "Johannesburg",
      "postalCode": "2000",
      "countryCode": "ZA"
    }
  }'

POST /cards/users/USER_ID/issue (physical)

curl -s -X POST "https://b2b-api.easyonramp.com/api/v1/cards/users/USER_ID/issue" \
  -H "Authorization: Bearer YOUR_JWT" \
  -H "Content-Type: application/json" \
  -d '{
    "cardType": "physical",
    "displayName": "Jane Doe Physical Card",
    "shippingAddress": {
      "line1": "12 Main Road",
      "line2": "Suite 4",
      "city": "Johannesburg",
      "region": "Gauteng",
      "postalCode": "2000",
      "countryCode": "ZA",
      "phoneNumber": "+27821234567"
    }
  }'

See Virtual and physical cards.

6. Set PIN, fund, and limit

Managing a card’s PIN
Fund and withdraw (POST /wallet/fund, GET /wallet/balance)
Apply spending limits
Lifecycle controls
Fund treasury and a card

Event pattern	Why it matters
`business.kyb.*`	Business verification
`business.application.*`	EasyCard application ready
`user.kyc.*`	End-user KYC
`card.enrollment.*`	User ready for card issue
`card.status.*`	Activation, freeze, terminate

Get started

Core concepts

Common workflows

How to manage users

How to fund your business wallet

How to use cards

How to use reports

Integration services

Checklist

Before you start

1. Complete KYB

2. Enroll as a business

3. Create users

4. Enroll user(s)

5. Create cards

6. Set PIN, fund, and limit

​Checklist

​Before you start

​1. Complete KYB

​2. Enroll as a business

​3. Create users

​4. Enroll user(s)

​5. Create cards

​6. Set PIN, fund, and limit

​Status events to subscribe to

Checklist

Before you start

1. Complete KYB

2. Enroll as a business

3. Create users

4. Enroll user(s)

5. Create cards

6. Set PIN, fund, and limit

Status events to subscribe to