Welcome to the Probe API!

The Probe API is used to programmatically access your Probe account and perform functions like running searches using the Probe AML search tool in an automated way, directly from your web application or from within your own internal tooling ecosystem.

Example 1 - New/Existing Customer Screening For example, Financial Institutions can gain value from Probe by integrating the Probe API directly into their internal applications to screen existing customers or new customers as they're onboarded. If a hit occurs, the FI can investigate further using Probe results and take appropriate action.

Example Workflow with Probe API integration

Example 2 - Transaction Screening FIs handle multiple financial transactions daily. There are two parties involved in every transaction - The Payer makes the payment and the Payee receives the payment. Either party can be an individual, commercial business, or government entity.

The Probe API can be used for automated screening of transaction Payers and Payees, but due to the high volume of daily transactions that FIs usually experience, and the cost per search via the Probe API, it won't be cost-effective to screen all transactions. A more efficient approach would be to screen only specific transactions that meet certain criteria: like the transaction amount exceeds a defined price threshold (e.g. transactions above ₦1 Million) or strange transaction patterns have been detected on the Payer's or Payee's account.

Also, screening can generate a lot of hits and subsequent reports that analysts will have to sift through for further investigation. Screening every single transaction would generate more reports and unnecessary work than analysts would be able to cope with.

Beta Warning
API Server: https://app.probecompliance.com/api/v1/

This API is still in Beta phase. There may be some slight behavioural and specification changes of which we'll do our best to notify you in advance

We aim to maintain a solid, stable and long-term API contract with future additional functionality branching out as new versioned APIs thus preserving existing functionality with zero code changes on your part.

API Response Data All endpoint calls will return results in JSON format. The returned data is minimalistic and designed for efficiency in order to conserve bandwidth. The resulting JSON object will always have two keys set unless explicitly stated otherwise: success (boolean) and result (object). HTTP status codes are also provided with each response.

Future iterations of the Probe API may allow users further customize what data is returned via a list of keys.

JSON Result Object

Probe uses token-based authentication (1st-party) and OAuth 2.0 (3rd-party) to allow access to your account via the Probe API. You can register a new API token at the following address: https://app.probecompliance.com.

Tokens are expected to be included in all API requests to the server in the header that looks like the following:

Authorization: Bearer {token}

You can use the Validate Token endpoint to validate a correct request.

A number of APIs require submission of JSON data when requesting results. In this case please make sure the request JSON object is valid and submitted using the correct HTTP request method (typically POST).

Also include a proper Content-Type: application/json header value if possible too with the request - though this is not a hard requirement.

API Throttling Performing too many Probe API requests per minute will result in your API Key getting throttled/rate-limited. Throttled API requests will get a http error response with a status code of 429 - Too Many Requests.

If your API access is throttled, a retry-after response header will be included in the response. This header will let you know how much time in seconds you'll have to wait before being able to regain access to Probe API endpoints. E.g. retry-after: 30 means you need to wait for 30 seconds before calling the endpoint again.

As a Developer or API user, best practises is to stop making calls to the Probe API once you receive a 429 response and check the retry-after header to see when you can resume making calls. Ensure you spread out API requests evenly to avoid traffic spikes and subsequent rate-limits.

GET Validate Token This endpoint is available for testing purposes only. You can use it to validate a correct request.

HTTP Request GET https://app.probecompliance.com/api/v1/validate

Scope N/A

JSON Parameters N/A

Scopes allow you to specify the permissions or authorizations that your API key will have. Depending on the scope you assign, your API key will have restricted or unlimited access to specific endpoints.

It's usually good practise to limit the scopes that your API key has to the bare minimum.

Note: During your development stage (implementation and testing), we recommend you enable the sandbox scope, which will ensure that all endpoints with POST, PUT and DELETE http request methods won't modify your data or deduct from your wallet. These endpoints will return sample, no-value results rather than real, high-value results.

Once you've completed development and are production-ready, you can then disable the sandbox scope to go live!

Synopsis Search is the core functionality of the Probe API. These set of endpoints allow you to run a search using the Probe AML search tool and retrieve the results of the operation.

POST Run Search This endpoint allows you to run a search using the Probe AML search tool.

To search for an Individual, specify search_type Individual, to search for an Entity, specify search_type Entity, to search for a Crypto Address, specify search_type Crypto Address, to search for an ID Number, specify search_type ID Number, to search for an Aircraft, specify search_type Aircraft and to search for a Vessel, specify search_type Vessel.

When searching for an individual, you're required to specify either a first_name or a last_name or both. When searching for an entity, you're required to specify an entity_name. When searching for a crypto address, you're required to specify a crypto_address. When searching for an id number, you're required to specify an id_number. When searching for an aircraft, you're required to specify an aircraft_name. When searching for a vessel, you're required to specify a vessel_name.

A successful call returns a json object with the search_id, query parameters used for the search, a list of datasources where matches occurred and an indication of total matches for each datasource.

This data is limited to conserve bandwidth. To get more detailed results information, use the search_id along with the Retrieve Search Results endpoint.

HTTP Request POST https://app.probecompliance.com/api/v1/search

Scope search

JSON Parameters The data used to refine the search can be large and complex so should be sent in the request body in JSON format.

ID Number Types When searching for the ID Number types listed below, you must provide a JSON object in the id_number field that conforms to the schema outlined below.

GET Retrieve Search History This endpoint retrieves a list of all your past searches in order of most recent first.

For each search, the returned json object contains the search_id, query parameters used for the search, a list of datasources where matches occurred and an indication of total matches for each datasource.

This data is limited to conserve bandwidth. To get more detailed results information, use the search_id along with the Retrieve Search Results endpoint.

By specifying extra parameters like page and records_limit you can paginate the data to suit your workflow. These parameters are both optional.

HTTP Request GET https://app.probecompliance.com/api/v1/search/history?page=1&records_limit=10

Scope search

Query Parameters Parameters sent as query arguments in the url and are used to filter the results.

GET Retrieve Search Info This endpoint returns search information for the specified search_id.

The returned json object contains the search_id, query parameters used for the search, a list of datasources where matches occurred and an indication of total matches for each datasource.

This data is limited to conserve bandwidth. To get more detailed results information, use the search_id along with the Retrieve Search Results endpoint.

HTTP Request GET https://app.probecompliance.com/api/v1/search/{search_id}

Scope search

Query Parameters Parameter included in the url path and used as a locator to retrieve the exact resource you require.

GET Retrieve Search Results This endpoint returns more detailed results information for the specified search_id.

Hits can occur in one or more of the available datasources. Due to the high number of possible hits, and to conserve bandwidth, the datasource_id and result_id parameters must be specified to get more details about a specific hit.

Each datasource formats its results in a unique way. You can familiarize yourself with these different formats by visiting the schemas section.

HTTP Request GET https://app.probecompliance.com/api/v1/search/{search_id}/results/{datasource_id}/{result_id}

Scope search

Query Parameters Parameters included in the url path and used as locators to retrieve the exact resource you require.

Synopsis These set of endpoints allow you to run multiple, automated, asynchronous, searches using the Probe AML search tool.

The difference between a regular search and a bulk search is that regular searches are synchronous, i.e. you need to complete one search before you start another, and you also have to manage the whole process. Bulk searches require less work on your end. All you have to do is submit a list of names to the relevant endpoint. After that, no further work or interaction is required, you effectively hand-off the heavy lifting to the Probe API and you can be notified via webhooks once the batch job operation is completed so you can examine the results.

Bulk searches have dynamic schedules. They often run during periods of medium to low traffic and can be queued up to be executed during the evening or weekend when the server traffic is typically lower.

POST Run Bulk Search This endpoint allows you to run a bulk search using the Probe AML search tool.

To get started you need to build a valid json object array containing your list of names and their individual query parameters. Once you're done you can then submit the JSON data to the endpoint. Refer to the Run Search endpoint for more details about the query parameters. For any missing parameter, the default value will be used.

Note: Remember to use the correct HTTP Request Method: POST and include a proper Content-Type: application/json header value.

A successful call returns a bulk_search_id used to uniquely identify the bulk search operation. You can use the bulk_search_id along with the Retrieve Bulk Search Info endpoint to poll the status of the batch job operation. Additionally, if you have setup a webhook then your Webhook URL will be called when the search is complete.

HTTP Request POST https://app.probecompliance.com/api/v1/search/bulk

Scope bulk_search

JSON Parameters The data used to refine the search can be large and complex so should be sent in the request body in JSON format.

GET Retrieve Bulk Search Info This endpoint returns detailed information about the bulk search operation identified by bulk_search_id.

The returned json object contains an array of the original query parameters used to initiate the bulk search, an indication of the status of each individual search (i.e. whether or not the search has been executed), and for completed searches - the associated search_id. Also included is an indication of the status of the overall bulk search operation.

With the individual search_ids you can get more detailed search results using the Retrieve Search Results endpoint.

HTTP Request GET https://app.probecompliance.com/api/v1/search/bulk/{bulk_search_id}

Scope bulk_search

Query Parameters Parameter included in the url path and used as a locator to retrieve the exact resource you require.

Synopsis Datasources refer to the various data repositories that the Probe AML search tool searches through to find information relating to Individuals, Entities, ID Numbers, Aircrafts, Vessels and Crypto Addresses. These repositories include internet search engines, and various local and international sanctions lists.

Click Here to view a list of all our available data sources along with their current status and input types.

Latest Datasources

GET Retrieve Datasources This endpoint returns a list of all available datasources including their ID number, short name, full name and a short description.

The datasource_id is an important data item that can be used in the query parameters for several other endpoint calls.

HTTP Request GET https://app.probecompliance.com/api/v1/datasources

Scope datasources

JSON Parameters N/A

Synopsis A search slot enables you to run a single search using the Probe AML search tool, whether the search is conducted on the Probe web platform or via the Probe API.

Probe users are provided with a specific number of search slots per month depending on their subscription package and/or the slots allocated to them by their Probe account admin. For every single search you execute, your total search slots will be deducted by one slot.

Once you exhaust your slots for the month, you will no longer be able to run searches. Search-related endpoint calls will result in an error response with HTTP Status Code: 402 - Payment Required. At this point the User can either purchase more slots of contact their Probe account admin to get more slots allocated to them if available.

These endpoints help you to keep track of your slots so that you can better manage your use of the Probe search resource and plan ahead to ensure you never lose access to the search feature which may negatively impact your business operations.

GET Retrieve Slots This endpoint returns the total number of search slots the authenticating user has remaining (for the rest of the month).

HTTP Request GET https://app.probecompliance.com/api/v1/slots

Scope slots

JSON Parameters N/A

Synopsis Investigations are used for grouping searches to better organize your workflow. For example, you could create an investigation called "Userbase Checks" when carrying out searches on existing customers and another called "Onboarding Checks" when carrying out searches on new customers.

Investigations can be managed (created, edited and deleted) both on the Probe web platform and via the Probe API. Investigations also have a company-wide scope. This means that investigations created by one user will be visible to other users registered under the same company.

Note: Searches performed without specifying an investigation will be uncategorized. Also, if you delete an existing investigation, all related searches will become uncategorized.

GET Retrieve Investigations This endpoint returns a list of all investigations associated with the company of the authenticating user.

HTTP Request GET https://app.probecompliance.com/api/v1/investigations

Scope read_investigations or write_investigations

JSON Parameters N/A

POST Create Investigation This endpoint allows you create a new investigation to be used to group searches.

HTTP Request POST https://app.probecompliance.com/api/v1/investigations

Scope write_investigations

JSON Parameters This is the data that will be used to create the resource and should be sent in the request body in JSON format.

PUT Update Investigation This endpoint allows you update the name and/or details of an existing investigation.

HTTP Request PUT https://app.probecompliance.com/api/v1/investigations/{investigation_id}

Scope write_investigations

Query Parameters Parameter included in the url path and used as a locator to target the exact resource you require.

JSON Parameters This is the data that will be used to update the resource and should be sent in the request body in JSON format. You can specify any 1 or more of the parameters.

DELETE Delete Investigation This endpoint allows you to delete an existing investigation.

Note: If you delete an existing investigation, all related searches will become uncategorized.

HTTP Request DELETE https://app.probecompliance.com/api/v1/investigations/{investigation_id}

Scope write_investigations

Query Parameters Parameter included in the url path and used as a locator to target the exact resource you require.

Synopsis These endpoints allow you pull various data items regarding your company for information purposes and also so that you can use as parameters when calling other Probe API endpoints.

GET Retrieve Company Information This endpoint returns all your company information and a list of all users and teams associated with your company.

The list also includes the ID numbers of users and teams. These are important parameters that are required when calling some endpoints.

HTTP Request GET https://app.probecompliance.com/api/v1/company

Scope company

JSON Parameters N/A

Synopsis Webhooks are automated one-way messages sent from apps when something happens.

They typically transmit data and are sent to a unique URL specified by the user. They are a faster alternative to polling which requires more work on your end.

You can specify a webhook URL at the following address on your Probe dashboard: https://app.probecompliance.com so your app is notified when specific events are triggered on the Probe platform, such as when bulk searches are completed.

Note: Webhook responses are sent in JSON format. Your Webhook URL should return a response with HTTP Status Code: 200 else will be treated as a failure. Failures will trigger exponential backoff retries, but multiple failures may result in your Webhook URL being deleted.

Webhook JSON responses typically have three main keys: event (string), success (boolean) and data (object).

Verification Webhook URLs are publicly available so you'll need to verify that the webhook events you receive originated from Probe and not a bad actor.

All webhook events sent from Probe will have a probe-signature header. The header value is generated from a HMAC SHA512 hash of the webhook event payload signed with your API key.

Ensure you verify the header signature before processing the webhook event to confirm that it originated from Probe.

POST Bulk Search Event This event is triggered when one of the individual searches within a bulk search batch job operation has completed.

Event Schema Success { "event":"bulk_search", "success":true, "data":{ "bulk_search_id":123, "search_info":{ "id":1, "completed":true, "first_name":"Musa", "last_name":"Ibrahim" } } } Failure { "event":"bulk_search", "success":false, "error":"402 - Payment Required, user wallet funds exhausted", "data":{ "bulk_search_id":123, "search_info":{ "id":null, "completed":true, "first_name":"Musa", "last_name":"Ibrahim" } } }

JSON Parameters

POST Bulk Search Complete Event This event is triggered when the bulk search batch job operation is complete, i.e. all the individual searches within the batch job operation have been executed.

Event Schema Success { "event":"bulk_search_complete", "success":true, "data":{ "bulk_search_id":123, "total_searches":10, "searches":[ { "id":1, "success":true }, { "id":1, "success":true }, { "id":1, "success":false, "error":"500 - Internal server error" }, {...} ] } } Failure { "event":"bulk_search_complete", "success":false, "error":"402 - Payment Required, user wallet funds exhausted", "data":{ "bulk_search_id":123, "total_searches":10, "searches":[ { "id":null, "success":false, "error":"402 - Payment required" }, { "id":null, "success":false, "error":"402 - Payment required" }, { "id":null, "success":false, "error":"402 - Payment required" }, {...} ] } }

JSON Parameters

Synopsis Search results from each datasource are formatted in a unique way. In this section, you can familiarize yourself with the different formats for each of the available datasources.

AMS Schema Adverse Media (Google) // ams schema { "image_url":"https://news.com/article/image.jpg", "title":"News Article Title", "link":"https://news.com/article", "snippet":"A short summary of the news title.", "tags":[ { "name":"Lawsuit", "total":1 }, {...} ] }

OFAC SDN Schema Office of Foreign Assets Control - Specially Designated Nationals List

Results from this datasource can be in 1 of 2 categories: Individual or Entity. Schemas for each category are identical. // ofac sdn schema { "uid":12345, "firstName":"Musa", "lastName":"Ibrahim", "title":"", "sdnType":"Individual", "remarks":"(Linked To: WORLDGROUP LIMITED LIABILITY COMPANY)", "programList":["WORLD-ABCDEF"], "idList":[ { "uid":23456, "idType":"Tax ID No.", "idNumber":"111111111111", "idCountry":"Nigeria" }, { "uid":34567, "idType":"Gender", "idNumber":"Male" } ], "akaList":[ { "uid":45678, "type":"a.k.a.", "category":"strong", "lastName":"Ibraheem", "firstName":"Musah" } ], "addressList":[ { "uid":56789, "city":"Lagos", "country":"Nigeria" } ], "nationalityList":[ { "uid":67890, "country":"Nigeria", "mainEntry":true } ], "citizenshipList":null, "dateOfBirthList":[ { "uid":78901, "dateOfBirth":"26 Sep 1965", "mainEntry":true } ], "placeOfBirthList":[ { "uid":89012, "placeOfBirth":"Ikeja, Lagos, Nigeria", "mainEntry":true } ], "vesselInfo":null, "score":84 }

OFAC Non-SDN Schema Office of Foreign Assets Control - Consolidated Sanctions List

Results from this datasource can be in 1 of 2 categories: Individual or Entity. Schemas for each category are identical. // ofac non-sdn schema { "uid":1234, "firstName":"Musa", "lastName":"Ibrahim", "title":"President", "sdnType":"Individual", "remarks":null, "programList":["AB-123"], "idList":null, "akaList":[ { "uid":2345, "type":"a.k.a.", "category":"strong", "lastName":"Ibraheem", "firstName":"Musah" } ], "addressList":[ { "uid":1111, "city":"Khan Younis", "stateOrProvince":"West Bank", "country":"Palestinian" } ], "nationalityList":null, "citizenshipList":null, "dateOfBirthList":[ { "uid":2222, "dateOfBirth":"1958", "mainEntry":true } ], "placeOfBirthList":null, "vesselInfo":null, "score":55 }

OFSI AFT Schema Office of Financial Sanctions Implementation - Asset Freeze Targets List

Results from this datasource can be in 1 of 3 categories: Individual, Entity or Ship. Schemas for each category are identical. // ofsi aft schema { "group_id":1234, "regime":"World", "group_type":"Individual", "last_name":"Ibrahim", "first_name":"Musa", "title_list":[], "date_of_birth_list":["01/01/1960"], "place_of_birth_list":[], "alias_list":[ { "category":"good quality", // good quality, low quality "last_name":"Ibraheem", "first_name":"Mussah" }, {...} ], "nationality_list":[], "passport_list":[], "national_id_list":[ { "number":"111-22-33", "details":"Nigerian National Identification Number" } ], "position_list":["Former Chairman, Company Name"], "address_list":[ { "address1":"", "city":"Lagos", "country":"Nigeria" } ], "other_info":"(UN Ref):XXX.001 Musa escaped from jail 1 Jan 2000", "listed_date":"01/01/2020", "designated_date":"01/01/2020", "last_updated_date":"01/01/2020", "score":70 }

OFSI IBT Schema Office of Financial Sanctions Implementation - Investment Ban Targets List

Results from this datasource can be in 1 of 3 categories: Individual, Entity or Ship. Schemas for each category are identical. // ofsi ibt schema { "group_id":1234, "regime":"World", "group_type":"Entity", "last_name":"ROSNEFT", "first_name":"", // entities have only first_name "title_list":[], "date_of_birth_list":[], "place_of_birth_list":[], "alias_list":[], "nationality_list":[], "passport_list":[], "national_id_list":[], "position_list":[], "address_list":[], "other_info":"Listed under Schedule 2 of World Sanctions", "listed_date":"01/01/2020", "designated_date":"", "last_updated_date":"01/01/2020", "score":70 }

OFSI UKSL Schema Office of Financial Sanctions Implementation - UK Sanctions List

Results from this datasource can be in 1 of 3 categories: Individual, Entity or Ship. Schemas for each category are identical. // ofsi uksl schema { "unique_id":"XXX1234", "group_type":"Individual", "regime":"World Sanctions Regulations 2020", "sanctions_imposed_list":["Asset freeze","Travel Ban"], "other_info":"", "uk_statement_of_reasons":"Financial crimes: money laundering", "date_of_birth_list":["01/01/1960"], "passport_list":[], "nationality_list":["Nigeria"], "national_id_list":[], "position_list":["Member of the State, Nigeria"], "gender":"Male", "place_of_birth_list":[ { "town_of_birth":"Lagos", "country_of_birth":"Nigeria" } ], "type_of_entities_list":[], "subsidiaries_list":[], "parent_companies_list":[], "business_registration_numbers_list":[], "imo_numbers_list":[], "current_owner_operators_list":[], "current_believed_flag_of_ships_list":[], "previous_flags_list":[], "type_of_ship_details_list":[], "tonnage_of_ship_details_list":[], "length_of_ship_details_list":[], "years_built_list":[], "last_name":"Ibrahim", "first_name":"Musa", "alias_list":[], "title_list":[], "address_list":[ { "address1":"", "city":"Lagos", "postal_code":11111, "country":"Nigeria" } ], "phone_numbers_list":[], "websites_list":[], "email_addresses_list":[], "designation_source":"UK", "designated_date":"01/01/2020", "last_updated_date":"01/01/2020", "ofsi_group_id":12345, "un_reference_number":55555, "score":69 }

ICIJ OLDB Schema International Consortium of Investigative Journalists - Offshore Leaks Database

Results from this datasource can be in 1 of 4 categories: ENTITIES, INTERMEDIARIES, OFFICERS or OTHERS. Each category has its own unique schema but have similar fields. // icij oldb entities schema { "node_id":11111111, "table":"ENTITIES", "score":100, "name":"Best Company Nigeria Ltd.", "original_name":"Best Company Nigeria Ltd.", "former_name":"", "jurisdiction":"NG", "jurisdiction_description":"Nigeria", "company_type":"", "address":"Lagos; Nigeria", "internal_id":1111256, "incorporation_date":"01-JAN-2020", "inactivation_date":"01-JAN-2020", "struck_off_date":"01-JAN-2020", "dorm_date":"", "status":"Defaulted", "service_provider":"Awesome Services Nig. Ltd.", "ibcRUC":12345, "country_codes":"NG", "countries":"Nigeria", "sourceID":"Panama Papers", // Offshore Leaks, Panama Papers, Bahamas Leaks, Paradise Papers, Pandora Papers "valid_until":"The Panama Papers data is current through 2015", "note":"" } // icij oldb intermediaries schema { "node_id":11111111, "table":"INTERMEDIARIES", "score":100, "name":"Best Company Nigeria Ltd.", "status":"Defaulted", "internal_id":1111256, "address":"Lagos; Nigeria", "countries":"Nigeria", "country_codes":"NG", "sourceID":"Panama Papers", // Offshore Leaks, Panama Papers, Bahamas Leaks, Paradise Papers, Pandora Papers "valid_until":"The Panama Papers data is current through 2015", "note":"" } // icij oldb officers schema { "node_id":12345678, "table":"OFFICERS", "score":88, "name":"Ibrahim Musa", "countries":"Nigeria", "country_codes":"NG", "sourceID":"Offshore Leaks", // Offshore Leaks, Panama Papers, Bahamas Leaks, Paradise Papers, Pandora Papers "valid_until":"The Offshore Leaks data is current through 2010", "note":"" } // icij oldb others schema { "node_id":11111111, "table":"OTHERS", "score":100, "name":"Best Company Nigeria Ltd.", "type":"LIMITED LIABILITY COMPANY", "incorporation_date":"01-JAN-2020", "struck_off_date":"01-JAN-2020", "closed_date":"01-JAN-2020", "jurisdiction":"NG", "jurisdiction_description":"Nigeria", "country_codes":"NG", "countries":"Nigeria", "sourceID":"Panama Papers", // Offshore Leaks, Panama Papers, Bahamas Leaks, Paradise Papers, Pandora Papers "valid_until":"The Panama Papers data is current through 2015", "note":"" }

INTERPOL RED Schema International Criminal Police Organization - Red Notices

Results from this datasource can only be in 1 category: PERSONS. // interpol red persons schema { "entity_id":1234/56789, "forename":"Musa", "name":"Ibrahim", "date_of_birth":"1980/01/01", "nationalities":["NG"], "thumbnail":"https://link.to/image.jpg", "images":[ { "picture_id":123, "href":"https://link.to/image.jpg" }, {...} ], "score":100, "arrest_warrants":[ { "issuing_country":"NG", "charge":"Financial Crimes", "charge_translation":null }, {...} ], "weight":80, "languages_spoken_ids":["ENG","GER"], "height":1.68, "sex_id":"M", "country_of_birth_id":"NG", "distinguishing_marks":null, "eyes_colors_id":["BRO"], "hairs_id":["BLA"], "place_of_birth":"Lagos" }

INTERPOL UN Schema International Criminal Police Organization - United Nations Security Council Special Notices

Results from this datasource can be in 1 of 2 categories: PERSONS or ENTITIES. Each category has its own unique schema but have similar fields. // interpol un persons schema { "notice_type":"persons", "entity_id":1234/56789, "forename":"Musa", "name":"Ibrahim", "date_of_birth":"1980/01/01", "thumbnail":"https://link.to/image.jpg", "images":[ { "picture_id":123, "href":"https://link.to/image.jpg" }, {...} ], "score":100, "summary":"The reason for listing", "purposes":["TRB","ARE","FOA"], "name_in_original_script":null, "un_resolution":1234, "associates":[ { "reference_number":"ABCD1234", "forename":"Musa", "name":"Ibrahim", "date_of_birth":"1980/01/01" }, {...} ], "un_reference_date":"2010/01/01", "un_reference":"ABCD1234", "adresses":["Lagos (Nigeria)"], "weight":80, "profession":"Doctor", "aliases":[ { "qualification":"ALIAS", "forename":"Musah", "country_of_birth_id":null, "name":"Ibraheem", "date_of_birth":null, "name_in_original_script":null, "forename_in_original_script":null, "place_of_birth":null }, {..} ], "father_name":null, "identity_documents":[ { "citizenship_id":"NG", "issuing_country_id":null, "nr":1234567890, "expiry_date":null, "place_of_issue":null, "type":"NATIONAL IDENTIFICATION NR", // or PASSPORT "issued_on":null }, {..} ], "nationalities":["NG"], "name_at_birth":null, "father_forename":null, "mother_forename":null, "forename_in_original_script":null, "languages_spoken_ids":["ENG","GER"], "country_of_birth_id":"NG", "sex_id":"M", "mother_name":null, "place_of_birth":"Lagos" } // interpol un entities schema { "notice_type":"entities", "entity_id":1234/56789, "un_reference":"ABc.123", "name":"Terror Network", "score":100, "summary":"The reason for listing", "purposes":["TRB","ARE","FOA"], "name_in_original_script":null, "un_resolution":1234, "associates":[ { "reference_number":"ABCD1234", "forename":"Musa", "name":"Ibrahim", "date_of_birth":"1980/01/01" }, {...} ], "un_reference_date":"2010/01/01", "adresses":["Lagos (Nigeria)"], "main_activity":"Terrorism, Military Training", "created_on":"2010/01/01", "country_of_registration":"NG", "from_chamber_of_commerce":null, "legal_form":null, "also_known_as":"Terror Group; Terror Gang", "administrators":[ { "reference_number":"ABCD1234", "forename":"Musa", "name":"Ibrahim", "date_of_birth":"1980/01/01" }, {...} ], "additional_informations":null, "registration_number":null, "formerly_known_as":null }

FBI Schema Federal Bureau of Investigation

Results from this datasource can only be in 1 category: INDIVIDUAL. // fbi individual schema { "entity_id":1234/56789, "forename":"Musa", "name":"Ibrahim", "date_of_birth":"1980/01/01", "nationalities":["NG"], "thumbnail":"https://link.to/image.jpg", "images":[ { "picture_id":123, "href":"https://link.to/image.jpg" }, {...} ], "score":100, "arrest_warrants":[ { "issuing_country":"NG", "charge":"Financial Crimes", "charge_translation":null }, {...} ], "weight":80, "languages_spoken_ids":["ENG","GER"], "height":1.68, "sex_id":"M", "country_of_birth_id":"NG", "distinguishing_marks":null, "eyes_colors_id":["BRO"], "hairs_id":["BLA"], "place_of_birth":"Lagos" }

ICPC Schema Independent Corrupt Practices Commission

Results from this datasource can only be in 1 category: INDIVIDUAL. // icpc individual schema { "entity_id":1234/56789, "forename":"Musa", "name":"Ibrahim", "date_of_birth":"1980/01/01", "nationalities":["NG"], "thumbnail":"https://link.to/image.jpg", "images":[ { "picture_id":123, "href":"https://link.to/image.jpg" }, {...} ], "score":100, "arrest_warrants":[ { "issuing_country":"NG", "charge":"Financial Crimes", "charge_translation":null }, {...} ], "weight":80, "languages_spoken_ids":["ENG","GER"], "height":1.68, "sex_id":"M", "country_of_birth_id":"NG", "distinguishing_marks":null, "eyes_colors_id":["BRO"], "hairs_id":["BLA"], "place_of_birth":"Lagos" }

EFCC Schema Economic and Financial Crimes Commission

Results from this datasource can only be in 1 category: INDIVIDUAL. // efcc individual schema { "entity_id":1234/56789, "forename":"Musa", "name":"Ibrahim", "date_of_birth":"1980/01/01", "nationalities":["NG"], "thumbnail":"https://link.to/image.jpg", "images":[ { "picture_id":123, "href":"https://link.to/image.jpg" }, {...} ], "score":100, "arrest_warrants":[ { "issuing_country":"NG", "charge":"Financial Crimes", "charge_translation":null }, {...} ], "weight":80, "languages_spoken_ids":["ENG","GER"], "height":1.68, "sex_id":"M", "country_of_birth_id":"NG", "distinguishing_marks":null, "eyes_colors_id":["BRO"], "hairs_id":["BLA"], "place_of_birth":"Lagos" }

NDLEA Schema National Drug Law Enforcement Agency

Results from this datasource can only be in 1 category: INDIVIDUAL. // ndlea individual schema { "entity_id":1234/56789, "forename":"Musa", "name":"Ibrahim", "date_of_birth":"1980/01/01", "nationalities":["NG"], "thumbnail":"https://link.to/image.jpg", "images":[ { "picture_id":123, "href":"https://link.to/image.jpg" }, {...} ], "score":100, "arrest_warrants":[ { "issuing_country":"NG", "charge":"Financial Crimes", "charge_translation":null }, {...} ], "weight":80, "languages_spoken_ids":["ENG","GER"], "height":1.68, "sex_id":"M", "country_of_birth_id":"NG", "distinguishing_marks":null, "eyes_colors_id":["BRO"], "hairs_id":["BLA"], "place_of_birth":"Lagos" }

WRITESONIC Schema Writesonic: Enhanced Natural Language Models (Chatsonic AI)

Results from this datasource can be in 1 of 2 categories: Individual or Entity. Schemas for each category are identical. // writesonic individual/entity schema { "entity_id":1234/56789, "forename":"Musa", "name":"Ibrahim", "date_of_birth":"1980/01/01", "nationalities":["NG"], "thumbnail":"https://link.to/image.jpg", "images":[ { "picture_id":123, "href":"https://link.to/image.jpg" }, {...} ], "score":100, "arrest_warrants":[ { "issuing_country":"NG", "charge":"Financial Crimes", "charge_translation":null }, {...} ], "weight":80, "languages_spoken_ids":["ENG","GER"], "height":1.68, "sex_id":"M", "country_of_birth_id":"NG", "distinguishing_marks":null, "eyes_colors_id":["BRO"], "hairs_id":["BLA"], "place_of_birth":"Lagos" }

OPENAI Schema Open Artificial Intelligence: Natural Language Models (ChatGPT AI)

Results from this datasource can be in 1 of 2 categories: Individual or Entity. Schemas for each category are identical. // openai individual/entity schema { "entity_id":1234/56789, "forename":"Musa", "name":"Ibrahim", "date_of_birth":"1980/01/01", "nationalities":["NG"], "thumbnail":"https://link.to/image.jpg", "images":[ { "picture_id":123, "href":"https://link.to/image.jpg" }, {...} ], "score":100, "arrest_warrants":[ { "issuing_country":"NG", "charge":"Financial Crimes", "charge_translation":null }, {...} ], "weight":80, "languages_spoken_ids":["ENG","GER"], "height":1.68, "sex_id":"M", "country_of_birth_id":"NG", "distinguishing_marks":null, "eyes_colors_id":["BRO"], "hairs_id":["BLA"], "place_of_birth":"Lagos" }

Upcoming Features

API Changes