Stodacom Africa Documentation
Everything you need to integrate, configure, and get the most from Stodacom Africa's risk intelligence platform — from quick-start guides to full API references.
Introduction
Welcome to the Stodacom Africa documentation. This reference covers everything you need to screen, verify, and monitor people and organisations across Africa's 54 markets.
Our platform offers two modes of access: a web interface through StodacomDesktop® and API access for programmatic integration into your own systems. Both share the same underlying data — 5M+ records across 54 African countries, updated daily.
Quick Start Guide
Get up and running in under 10 minutes. Follow these steps to run your first background check via the API.
Create an account
Register at stodacomdesktop.com or contact our team for enterprise access.
Get your API key
Navigate to Settings → API in your StodacomDesktop® account. Copy your secret key — keep it safe and never expose it client-side.
Make your first request
Use the example below to run a basic screening check. Replace YOUR_API_KEY with your actual key.
Handle the response
All responses return JSON. Check the status field — values are clear, review, or flag.
curl -X POST https://api.stodacom.com/v1/screen \
-H 'Authorization: Bearer YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
"type": "individual",
"first_name": "John",
"last_name": "Doe",
"country": "UG",
"checks": ["criminal", "sanctions", "pep"]
}'Example response:
{
"id": "scr_01HXYZ9ABC123DEF",
"status": "clear",
"subject": {
"name": "John Doe",
"country": "UG"
},
"checks": [
{ "type": "criminal", "result": "clear" },
{ "type": "sanctions", "result": "clear" },
{ "type": "pep", "result": "clear" }
],
"created_at": "2026-03-29T10:23:45Z",
"turnaround": "instant"
}Authentication
All API requests must include a valid API key passed in the Authorization header as a Bearer token.
Authorization: Bearer YOUR_API_KEYKey scopes
| Scope | Description | Endpoints |
|---|---|---|
read | Retrieve existing reports and results | GET /v1/* |
write | Create new screening requests | POST /v1/* |
webhooks | Register and manage webhooks | /v1/webhooks/* |
admin | Account and user management | /v1/account/* |
StodacomDesktop®
StodacomDesktop® is Stodacom Africa's flagship risk intelligence platform — combining background screening, continuous monitoring, and actionable intelligence across all 54 African countries.
Background Screening
Run due diligence checks on individuals or companies — criminal records, identity, business registration, and reputation.
View API docs →Continuous Monitoring
Set up always-on alerts. Get notified when a subject's status changes — new criminal charges, sanctions hits, ownership changes.
View API docs →Risk Intelligence
Risk flags, contextual insights, and structured profiles that help your team make faster, smarter decisions.
View API docs →https://api.stodacom.com/v1
JSON
Bearer token
v4.3.1
API Overview
The Stodacom Africa REST API gives you programmatic access to all screening, verification, and monitoring services. All endpoints accept and return JSON.
Endpoints
/v1/screen
Run a new background check
write
/v1/screen/{id}
Retrieve a screening result
read
/v1/screen
List all screening requests
read
/v1/verify
Submit a verification request
write
/v1/verify/{id}
Retrieve a verification result
read
/v1/monitor
Create a monitoring subscription
write
/v1/monitor
List monitoring subjects
read
/v1/monitor/{id}
Remove a monitoring subject
write
/v1/webhooks
Register a webhook endpoint
webhooks
/v1/webhooks
List registered webhooks
webhooks
Errors & Status Codes
The API uses standard HTTP status codes. All error responses include a JSON body with a code and message field.
| Status | Code | Description |
|---|---|---|
| 200 | ok | Request succeeded. |
| 201 | created | Resource created successfully. |
| 400 | bad_request | Missing or invalid parameters. |
| 401 | unauthorized | Invalid or missing API key. |
| 403 | forbidden | Insufficient scope for this endpoint. |
| 404 | not_found | Resource does not exist. |
| 429 | rate_limited | Too many requests — see rate limits. |
| 500 | server_error | Internal error — contact support. |
Integrations
Stodacom Africa integrates with your existing tools. Whether you're using a major HR platform, a compliance system, or building custom workflows, we have a path for you.
REST API
Full programmatic access to all services. Supports JSON, webhooks, and OAuth 2.0.
Request access →Zapier
Connect Stodacom to 5,000+ apps without writing code. Trigger checks from new hires, CRM events, and more.
Request access →SAP SuccessFactors
Trigger background checks directly from candidate records in SuccessFactors.
Request access →Workday
Embed screening workflows into your Workday hiring pipeline via our certified connector.
Request access →Salesforce
Run partner and customer due diligence directly from Salesforce CRM records.
Request access →Custom Webhook
Receive real-time alerts via HTTP POST to any endpoint you control.
Request access →Changelog
- Added Arabic language support across all screening endpoints.
- New
/v1/monitor/bulkendpoint for batch monitoring subscriptions. - Improved turnaround times for South African criminal record searches.
- StodacomWatch® now covers 30 risk areas (previously 20).
- Launched Swahili language support.
- Added
turnaroundfield to all screening responses. - Webhook retry logic improved — up to 5 retries with exponential backoff.
- New country added: São Tomé and Príncipe.
- Launched StodacomSupply® API for supply chain risk.
- Rate limits increased for enterprise plans.
- SDK released for Python and Node.js (beta).
Sign in with Google