Getting Started

Quickstart
  1. Create an API key in your dashboard
  2. Send a POST to /api/v1/screen with name/dob/country
  3. Handle JSON response and log the referenceId for audits

Welcome to SecurePointAfrica API! This guide will help you get up and running with our sanctions screening service in minutes.

Quick Start

  1. Sign up for a free account and get your API key
  2. Make your first API call to test the connection
  3. Integrate screening into your application
  4. Monitor usage and results in your dashboard

Base URL

https://api.securepointafrica.com/v1

Your First API Call

curl -X POST https://api.securepointafrica.com/v1/screen \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "John Doe",
    "dob": "1980-01-01",
    "country": "NG"
  }'

Response Format

{
  "match": false,
  "bestScore": 0.45,
  "status": "clear",
  "candidates": [
    {
      "primary_name": "John Doe Smith",
      "score": 0.45,
      "list_code": "OFAC"
    }
  ],
  "referenceId": "screening_123456789"
}