Getting Started

​Getting Started

Follow this guide to make your first Scrub API call in under five minutes.

​Integration journey

1
Create an account
Sign up at usescrub.io and request sandbox API credentials from the dashboard.
2
Authenticate
Obtain a Bearer token via POST /accounts/login/ or use your API key in the Authorization header.
3
Verify a customer
Call POST /verify-bvn/ or POST /verify-nin/ during onboarding to confirm identity.
4
Screen transactions
Send each transfer to POST /fraud/analyze/ and act on the recommended_action field.
5
Subscribe to webhooks
Register your endpoint in the dashboard to receive fraud.alert and credit.report.ready events.

​Quickstart — verify a BVN

1. Authenticate

POST /v1/accounts/login/
Content-Type: application/json

{
  "email": "you@company.ng",
  "password": "your_password"
}
http

2. Verify identity

POST /v1/verify-bvn/
Authorization: Bearer <access_token>
Content-Type: application/json

{
  "bvn": "22345678901"
}
http

3. Expected response

{
  "valid": true,
  "full_name": "Adebola James",
  "phone_number": "08031234567",
  "date_of_birth": "1990-05-15",
  "request_id": "req_abc123"
}
json

​Quickstart — screen a transaction

Send each transfer to the fraud analysis endpoint before settlement:

POST /v1/fraud/analyze/
Authorization: Bearer <access_token>
Idempotency-Key: idem_unique_key_001
Content-Type: application/json

{
  "transaction_id": "TXN123456789",
  "sender_account": "0123456789",
  "receiver_account": "9876543210",
  "amount": 125000.50,
  "channel": "web",
  "ip_address": "102.89.23.45"
}
http
Example response risk score
45/ 100Medium
SafeCritical

Act on the recommended_action field: approve, review, decline, or step_up_auth.

​Next steps

IntroductionAuthentication