Account

Verify identity

post

Create a new KYC identity for an individual or business.

Authorizations

ServiceKey

X-Service-KeystringRequired

Your Switch API service key. Contact us at [e-mail] to obtain your service key.

Body

application/jsonexample

anyOptional

or

Responses

200

Successfully created identity

application/json

400

Bad request - validation error or invalid parameters

application/json

post

/account/identity

HTTPcURLJavaScriptPython

POST /account/identity HTTP/1.1
Host: api.onswitch.xyz
X-Service-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 170

{
  "holder_type": "INDIVIDUAL",
  "country": "AD",
  "first_name": "text",
  "last_name": "text",
  "callback_url": "https://example.com",
  "reference": "123e4567-e89b-12d3-a456-426614174000"
}

application/jsonexample

{
  "success": true,
  "status": 200,
  "message": "Identity created successfully",
  "timestamp": "2024-01-01T00:00:00.000Z",
  "data": {
    "reference": "550e8400-e29b-41d4-a716-446655440000",
    "status": "NOT_STARTED",
    "kyc_url": "https://kyc.example.com/verify/abc123",
    "note": [
      "Complete KYC verification using the provided URL",
      "You will receive a webhook when status changes"
    ],
    "payload": {
      "holder_type": "INDIVIDUAL",
      "country": "NG",
      "first_name": "John",
      "last_name": "Doe"
    },
    "issues": []
  }
}

Create account

post

Create a virtual bank account for receiving payments.

Authorizations

ServiceKey

X-Service-KeystringRequired

Your Switch API service key. Contact us at [e-mail] to obtain your service key.

Body

application/json

identitystringRequired

currencystring · enumRequiredPossible values:

wallet_addressstringRequired

Wallet address for receiving deposits in stablecoin. Supports Ethereum and Solana addresses.

Example: 0x1234567890123456789012345678901234567890

assetstring · enumOptional

Optional asset identifier. If not specified, defaults to a default asset.

Possible values:

callback_urlstring · uriOptional

referencestring · uuidOptional

Responses

200

Successfully created virtual account

application/json

400

Bad request - validation error or invalid parameters

application/json

post

/account/create

HTTPcURLJavaScriptPython

POST /account/create HTTP/1.1
Host: api.onswitch.xyz
X-Service-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 256

{
  "identity": "550e8400-e29b-41d4-a716-446655440000",
  "currency": "USD",
  "wallet_address": "0x1234567890123456789012345678901234567890",
  "asset": "base:usdc",
  "callback_url": "https://your-app.com/webhooks/account",
  "reference": "660e8400-e29b-41d4-a716-446655440001"
}

{
  "success": true,
  "status": 200,
  "message": "Virtual account creation initiated successfully",
  "timestamp": "2024-01-01T00:00:00.000Z",
  "data": {
    "reference": "660e8400-e29b-41d4-a716-446655440001",
    "status": "PENDING",
    "account_number": "0123456789",
    "account_name": "John Doe",
    "bank_name": "Example Bank",
    "bank_code": "058",
    "currency": "USD",
    "note": [
      "Account creation is in progress",
      "You will receive a webhook when account is active"
    ]
  }
}