API reference / Risk & Location
Negative due diligence
Screens an individual or entity against AML, CFT, non-compliance and lending watchlists: sanctions, PEP, defaulter and enforcement lists.
POST
/v1/risk/negative-due-diligence- Authentication
- Bearer token
- Scope
kyc:verify
Before you integrate
- About 50 further lists are returned in the same way, for example nse_defaulters, sfioconviction, irda_defaulters and eusanction_list. Each is a list that is empty when nothing matched.
- Every item in a list has a scores object (name_match, dob_match, country_match and similar) and a details object describing the matching record.
Request body
| Field | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Name of the person or entity to screen, 2 to 200 characters. |
type | string | Yes | Either individual or entity. |
categories | array | No | Which lists to search: any of AML, CFT, NONCOMPLIANCE and LENDING. Defaults to all four. |
match_score_threshold | number | No | Lowest match score to report, from 0 to 1. Defaults to 0.5. |
country | string | No | Country to narrow the search, 2 to 60 characters. Defaults to INDIA. |
date_of_birth_or_incorporation | string | No | Date of birth, or date of incorporation for an entity, up to 20 characters. |
aliases | array | No | Other names the subject is known by; up to 20, each 1 to 200 characters. |
Sample code
Set your key in the GRAPPI_API_KEY environment variable. Sample values are placeholders.
curl -sS -X POST 'https://grappi.ai/v1/risk/negative-due-diligence' \
-H "Authorization: Bearer $GRAPPI_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "Acme Traders",
"type": "entity"
}'Sample response
{
"request_id": "req_01HZY3K8M2",
"result": {
"match_status": "no_match",
"general_watchlist": [],
"sanction_list": [],
"politically_exposed_person": [],
"adverse_media": [],
"enforcement": [],
"mcadefaulter_entities": [],
"mcadefaulter_directors": [],
"fatf": [],
"world_bank": []
}
}Response fields
| Field | Type | Description |
|---|---|---|
match_status | string | Overall outcome of the screening. |
general_watchlist | array | Matches on general watchlists. |
sanction_list | array | Matches on sanctions lists. |
politically_exposed_person | array | Matches on lists of politically exposed persons. |
adverse_media | array | Matches in news coverage, each with scores, details, relevance and overall_score. |
enforcement | array | Matches on enforcement action lists. |
mcadefaulter_entities | array | Companies on the corporate-affairs defaulter lists. |
mcadefaulter_directors | array | Directors on the corporate-affairs defaulter lists. |
mca_proclaimed_offendors | array | Matches on lists of proclaimed offenders. |
fatf | array | Matches on high-risk-jurisdiction lists. |
cibil_defaulters | array | Matches on credit-bureau defaulter lists. |
world_bank | array | Matches on debarment lists. |
ofac_sdncriminal_entities | array | Matches on US sanctions lists. |
unsanctions_list_entities | array | Matches on UN sanctions lists. |
Errors
Every failure has the same shape. A call that fails on our side or at the data source is refunded to your wallet; a "no record found" answer is charged. See the error reference.