For a deeper look into our World Check One API, look into:

Overview |  Quickstart |  Documentation |  Downloads

question

Upvotes
Accepted
32 4 7 12

SEQ-5b: Get screening results. Not having Primary Name

How can I retrive the primary Name

world-checkworld-check-onec#
icon clock
10 |1500

Up to 2 attachments (including images) can be used with a maximum of 512.0 KiB each and 1.0 MiB total.

1 Answer

Upvotes
Accepted
4.2k 8 5 6

@ziad.abourizk

Kindly note we do not have the attribute "primary name" in the JSON response of the API call "Screening result" API.

Currently the screening result API, only displays the submitted value and the matched value Instead of the attribute "primary name", we display the attribute "matchedNameType" which tells you whether it is a primary name or an AKA, etc.

For example: Few JSON excerpts:

1. "matchStrength": "EXACT",
"matchedTerm": "Kurt RUSSELL",
"submittedTerm": "Kurt Russell",
"matchedNameType": "PRIMARY",

2. "matchStrength": "STRONG",
"matchedTerm": "RUSSELL,Kurtis",
"submittedTerm": "Kurt Russell",
"matchedNameType": "AKA",

The complete list of values that the attribute "matchedNameType" can take are:

PRIMARY, AKA, AKAENHANCED, FKA, DBA, MAIDEN, LANG_VARIATION, LOW_QUALITY_AKA, NATIVE_AKA)

If you want to know the primary name of the match, I suggest you call the API "SEQ-case-investigate-world-check-profile: Get a World-Check profile", you will have the complete list of names of the profile including the primary name.

The primaryName as an attribute is available only in the JSON response of the API call "SEQ-screen-sync-simple: Perform Synchronous Screening: Simple". This API response lets you save, screen and return screening results all in a single API call. The result JSON returned by this API call has the primary name in it.

Kindly note the API call "SEQ-screen-sync-simple: Perform Synchronous Screening" is available in the Postman Collection 1.5 only.

icon clock
10 |1500

Up to 2 attachments (including images) can be used with a maximum of 512.0 KiB each and 1.0 MiB total.