API Reference

Match Types Details

The field "match_types_details" gives a comprehensive explanation of why a match happened. For each entity name you matched, it provides information on how each word from your search term was matched with the entity, along with other relevant information about the name.
The components of each "match_types" document in the list include:

"matching_name": a name that your search matched with, including alternate names.
"sources": the sources (e.g. OFAC SDN List) connected to the matching name.

"aml_types": the Anti-Money Laundering types (e.g. sanctions) related to the matching name.

"name_matches": a breakdown of how each word in the search term corresponds to the matching name. The components for each element in the list are:

"query_term": a cleaned word from your search term.

"match_types": the ways the word matched, including exact match, edit distance, phonetic match, equivalent name, and others.

"secondary_matches": a breakdown of how other information provided with your search (e.g. birth year) matched the matching name. The components include:

"query_term": a secondary piece of information from your search.

"match_types": the ways the term matched, including exact birth year match and fuzzy birth year match.