Download OpenAPI specification:
API for NIGSAC search functionality and supporting data services. The main feature is the advanced fuzzy search capability for individuals, entities, and ID numbers in the NIGSAC database.
Authenticate using email and password to get a JWT token
| email required | string <email> |
| password required | string |
{- "email": "user@example.com",
- "password": "your_password"
}{- "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
}Authenticate using an API key to get a JWT token
| X-Api-Key required | string |
{- "X-Api-Key": "your_api_key_here"
}{- "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
}Advanced fuzzy search in the NIGSAC (Nigeria Financial Intelligence Unit Sanctions and Compliance) database. Supports searching for individuals, entities, and ID numbers with sophisticated fuzzy matching algorithms including Jaro-Winkler similarity, SOUNDEX phonetic matching, and Damerau-Levenshtein distance.
| search_type required | string Enum: "Individual" "Entity" "ID Number" Type of search to perform |
| first_name | string First name for Individual search (required for Individual search if last_name not provided) |
| last_name | string Last name for Individual search (required for Individual search if first_name not provided) |
| entity_name | string Entity name for Entity search (required for Entity search) |
| id_number | string ID number for ID Number search (required for ID Number search) |
| fuzzy_value | integer [ 0 .. 100 ] Default: 80 Fuzzy matching threshold (0-100). Higher values require closer matches. Default is 80. |
| country | string Filter results by country (optional) |
| dob_day | string Day of birth (1-31) for Individual search |
| dob_month | string Month of birth (1-12 or month name) for Individual search |
| dob_year | string Year of birth (YYYY) for Individual search |
Search for a person using first and last name with fuzzy matching
{- "search_type": "Individual",
- "first_name": "sahabi",
- "last_name": "Isail",
- "fuzzy_value": 80,
- "country": "Nigeria"
}{- "success": true,
- "results": [
- {
- "id": "NLJASI.9",
- "designation_id": "NLJASI.9",
- "record_type": "Individual",
- "first_name": "Sahabi",
- "last_name": "Ismail",
- "aka_list": [
- {
- "first_name": "Sahabi",
- "last_name": "Ismail"
}
], - "date_of_birth": "1980-05-15",
- "date_of_registration": "2023-01-15",
- "email": null,
- "id_list": [
- {
- "type": "Passport",
- "number": "A12345678",
- "country": "Nigeria"
}
], - "address_list": [
- {
- "address": "123 Main Street",
- "city": "Lagos",
- "country": "Nigeria"
}
], - "place_of_origin": {
- "city": "Kano",
- "country": "Nigeria"
}, - "languages_list": [
- "English",
- "Hausa"
], - "phone_list": [
- {
- "type": "Mobile",
- "number": "+234801234567"
}
], - "reason_for_designation": "Suspected money laundering activities",
- "score": 95.67
}
], - "count": 1
}Retrieve a list of all countries with their currency codes and capitals
{- "status": "success",
- "data": [
- {
- "countryCode": "NG",
- "countryName": "Nigeria",
- "currencyCode": "NGN",
- "capital": "Abuja"
}
]
}Retrieve a specific country by its country code
| code required | string^[A-Z]{2}$ Example: NG Two-letter country code (e.g., NG, US, GB) |
{- "status": "success",
- "data": {
- "countryCode": "NG",
- "countryName": "Nigeria",
- "currencyCode": "NGN",
- "capital": "Abuja"
}
}