Go from zero to your first API call. Authenticate, create a customer, verify identity, screen for compliance, and process a payment — all from your terminal.
Prerequisites: A Korastratum sandbox account and curl. Request sandbox access
Request sandbox access to get your Tenant ID and API credentials. You'll receive a client_id and client_secret for your sandbox environment.
# You'll receive these after requesting sandbox access: TENANT_ID="550e8400-e29b-41d4-a716-446655440000" CLIENT_ID="sandbox_client_abc123" CLIENT_SECRET="sandbox_secret_xyz789" BASE_URL="https://sandbox.korastratum.com"
Exchange your credentials for a JWT access token and refresh token. Include the X-Tenant-ID header on every subsequent request.
curl -X POST $BASE_URL/api/v1/auth/login \
-H "X-Tenant-ID: $TENANT_ID" \
-H "Content-Type: application/json" \
-d '{
"client_id": "'$CLIENT_ID'",
"client_secret": "'$CLIENT_SECRET'"
}'
# Response:
# {
# "access_token": "eyJhbGciOiJSUzI1NiIs...",
# "refresh_token": "dGhpcyBpcyBhIHJlZnJl...",
# "expires_in": 3600,
# "token_type": "Bearer"
# }
export TOKEN="eyJhbGciOiJSUzI1NiIs..."Create your first customer record. The platform supports individual and corporate customer types with country-specific ID requirements.
curl -X POST $BASE_URL/api/v1/customers \
-H "Authorization: Bearer $TOKEN" \
-H "X-Tenant-ID: $TENANT_ID" \
-H "Idempotency-Key: quickstart-cust-001" \
-H "Content-Type: application/json" \
-d '{
"customer_type": "INDIVIDUAL",
"first_name": "Amara",
"last_name": "Okafor",
"email": "amara@example.com",
"phone": "+2348123456789",
"country": "NG",
"national_id": {
"id_type": "BVN",
"id_value": "12345678901",
"country": "NG",
"is_primary": true
}
}'
# Response: 201 Created
# {
# "data": {
# "id": "c7b3d8e0-5a2f-4b1c-9d6e-8f0a1b2c3d4e",
# "customer_number": "CUST-00142",
# "status": "ACTIVE",
# "kyc_level": "BASIC"
# }
# }
export CUSTOMER_ID="c7b3d8e0-5a2f-4b1c-9d6e-8f0a1b2c3d4e"Submit a document and selfie for identity verification. The platform runs OCR, face matching, and liveness detection in a single call. In sandbox mode, use the test images provided with your credentials.
curl -X POST $BASE_URL/api/v1/kyc-verification/verify \
-H "Authorization: Bearer $TOKEN" \
-H "X-Tenant-ID: $TENANT_ID" \
-H "Content-Type: application/json" \
-d '{
"customer_id": "'$CUSTOMER_ID'",
"documentFrontBase64": "<base64_encoded_front>",
"documentBackBase64": "<base64_encoded_back>",
"selfieBase64": "<base64_encoded_selfie>",
"documentType": "national_id"
}'
# Response: 200 OK
# {
# "success": true,
# "data": {
# "verification_id": "v-a1b2c3d4",
# "status": "VERIFIED",
# "scores": {
# "overall": 92,
# "faceMatch": 95,
# "dataMatch": 89,
# "liveness": 91
# }
# }
# }Run AML/sanctions screening on the customer. The platform checks against 1M+ watchlist entries across 9 sanctions sources and 4 PEP databases.
curl -X POST $BASE_URL/api/v1/screening/entity \
-H "Authorization: Bearer $TOKEN" \
-H "X-Tenant-ID: $TENANT_ID" \
-H "Content-Type: application/json" \
-d '{
"entity_type": "INDIVIDUAL",
"name": "Amara Okafor",
"country": "NG",
"customer_id": "'$CUSTOMER_ID'"
}'
# Response: 200 OK
# {
# "data": {
# "screening_id": "scr-e5f6g7h8",
# "status": "CLEAR",
# "matches": [],
# "sources_checked": 13,
# "screened_at": "2026-02-10T14:35:00Z"
# }
# }Validate and pay a bill in two steps. First validate the customer's bill reference, then submit the payment. Biller codes are market-specific — use the /billers endpoint to discover available billers for your tenant's market.
# Step 1: Validate
curl -X POST $BASE_URL/api/v1/bills/validate \
-H "Authorization: Bearer $TOKEN" \
-H "X-Tenant-ID: $TENANT_ID" \
-H "Content-Type: application/json" \
-d '{
"biller_code": "UTILITY_PREPAID",
"customer_bill_id": "04123456789"
}'
# Step 2: Pay
curl -X POST $BASE_URL/api/v1/bills/pay \
-H "Authorization: Bearer $TOKEN" \
-H "X-Tenant-ID: $TENANT_ID" \
-H "Idempotency-Key: quickstart-bill-001" \
-H "Content-Type: application/json" \
-d '{
"source_account_id": "<account_uuid>",
"biller_code": "UTILITY_PREPAID",
"customer_bill_id": "04123456789",
"amount": 5000,
"channel": "API"
}'
# Response: 201 Created
# {
# "data": {
# "reference": "BP2026021001234",
# "status": "PROCESSED",
# "amount": 5000,
# "currency": "USD"
# }
# }You've authenticated, created a customer, verified their identity, screened them for compliance, and processed a payment. Explore the full API reference or dive into the documentation.