Getting started
Quickstart
Install a client, make your first v2 API call, and open a pasby identification flow.
Get from zero to a working API v2 identification flow in sandbox: install a client, create a wildcard request, and poll until claims are ready.
Domains
| Environment | Base URL |
|---|---|
| Sandbox | https://s.pasby.africa |
| Production | https://l.pasby.africa |
Before calling the API you need an API key and app secret from the pasby console. For decrypted claims after identification you also need communication keys (RSA PEM files). New to Console? Follow How to get API keys, then Your first call.
Choose your client
curl --versionMore clients: Client libraries.
First API request
Start a wildcard identification flow in sandbox (no NIN upfront):
curl -sS -X POST "https://s.pasby.africa/api/v2/identification/wildcard" \
-H "x-api-key: bk-test_YOUR_KEY" \
-H "Content-Type: application/json" \
-d '{
"action": "signup",
"claims": ["naming.family", "naming.given", "contact.email"],
"seeds": 4,
"payload": "Create your account with pasby"
}'Poll for completion
const { data: ping } = await pasby.flows.ping({
request: data.data.request.id,
});When identification completes, decrypt data.request.claims — see Handling encrypted claims.
What's next?
- Identification guide — same-device, different-device, wildcard
- Claims reference — every claim key
- Errors — status codes and fixes
- SampleCode on GitHub — end-to-end reference server