Search for a person

POST /v2/natural-entities/search endpoint will search for person’s profile.

Request data

You can provide the following data in the request:

	Name	Description	Mandatory/Optional

	Name	Description	Mandatory/Optional
1	name	Full name of the individual.	MANDATORY
2	datasets	https://ondato.atlassian.net/wiki/spaces/PUB/pages/2379743241 to search against.	MANDATORY
3	threshold	Minimum matching `score`. Results with lower `score` than the entered `threshold` will not be returned in the response. Default value: 85.	optional
4	birthDate	Either date of birth or year of birth of the searched person. Formats: YYYY-MM-DD or YYYY.	optional
5	countries	A list of two-letter country codes ISO-3166-2. The result will be filtered based on the individual’s nationality and country. This parameter applies only to the results of External type datasets.	optional
6	countryRequired	Tells if individuals with unknown nationality and country should be filtered out of the search results when `countries` parameter is defined. Values (boolean): `True`/`False` Default value: `False`	optional

Example

{
  "name": "Borissov Boyko",
  "datasets": [
    "All",
    "GeneralPep",
    "GeneralSanctions",
    "OndatoAll",
    "OndatoPep",
    "OndatoPepCurrent",
    "OndatoSanctions",
    "OndatoSanctionsCurrent",
    "ExternalAll",
    "ExternalPep",
    "ExternalPepCurrent",
    "ExternalPepFormer",
    "ExternalPepLinked",
    "ExternalSanctions",
    "ExternalSanctionsCurrent",
    "ExternalSanctionsFormer",
    "ExternalAdverseMedia",
    "ExternalRegulatoryEnforcementList"
  ],
  "threshold": 90,
  "birthDate": "1958-06-13",
  "countries": [
    "US"
  ],
  "countryRequired": false
}

Response data

In the response you can expect the following fields:

	Name	Description

	Name	Description
1	matchCount	Total number of found persons.
2	matches	Search results.
3	matches.resourceId	The resource ID can be used to retrieve the detailed info or the PDF of the person.
4	matches.score	The match score. This means how accurate the found person match the searched person. E.g. `"score": 100` means that the found person is the exact match to the provided in the search. Possible values from `75` to `100`
5	matches.match	The name that has been matched in the search.
6	matches.name	The name of the found person.
7	matches.countries	The list of countries from the addresses and nationalities of the profile.
8	matches.datasets	Active datasets where person is tagged in. Possible enum values are any of the described datasets here.
9	matches.birthDates	List of person’s dates of birth in ISO format: YYYY-MM-DD.
10	matches.gender	Gender of the person.
11	matches.profileImage	The URL to person’s profile image.
12	resourceId	Unique search request identifier for historical data.

Example

{
  "matchCount": 15,
  "matches": [
    {
      "resourceId": "1f5a940e6a16d390bfe45655c3176f64c5b123880ff08e04b61ad7325af76cc4",
      "score": 100,
      "match": "John Doe",
      "name": "John Jack Doe",
      "countries": [
        "US",
        "GB"
      ],
      "dataSets": [
        "All",
        "GeneralPep",
        "GeneralSanctions",
        "OndatoAll",
        "OndatoPep",
        "OndatoPepCurrent",
        "OndatoSanctions",
        "OndatoSanctionsCurrent",
        "ExternalAll",
        "ExternalPep",
        "ExternalPepCurrent",
        "ExternalPepFormer",
        "ExternalPepLinked",
        "ExternalSanctions",
        "ExternalSanctionsCurrent",
        "ExternalSanctionsFormer",
        "ExternalAdverseMedia",
        "ExternalRegulatoryEnforcementList"
      ],
      "birthDates": [
        "1959",
        "1959-08-22"
      ],
      "gender": "Male",
      "profileImage": "https://ec.europa.eu/commission/commissioners/sites/default/files/styles/biography_portrait_160x160/public/commissioner_portraits/ursula-von-der-leyen.jpg"
    }
  ],
  "resourceId": "e2092c9fae9c4b10be5ead528a3a143d52c961d1957d4ff58354aea2a43a87f5"
}

Get person details by id

After accessing a person’s profile with the basic information you can use its resourceId to access the person’s details.

You can do this by calling the person details endpoint:

GET /v2/natural-entities/{resourceId}

Request data

In the request provide the resourceId of the person’s profile.

Example

{
  "resourceId": "f48f946857281571f7254d8fa51a7f9da0b75e9728c5ab16acace934c08b93d8"
}

Response data

In the response you can expect the following fields:

	Name	Description

	Name	Description
1	resourceId	The resource ID can be used to retrieve the detailed info or the PDF of the person.
2	fullName	-
3	firstName	-
4	middleName	-
5	lastName	-
6	gender	-
7	isDeleted	Boolean value which indicates if person was deleted or not.
8	deletionReason	The block with information about deletion reason.
9	deletionReason.reason	Reason why person was deleted.
10	deletionReason.otherReason	Additional info about deletion reason.
11	isDeceased	Boolean value which indicates if person was dead or not.
12	aliases	List of person’s aliases or Also Known As’es (AKAs).
13	aliases.fullName	-
14	aliases.firstName	-
15	aliases.middleName	-
16	aliases.lastName	-
17	aliases.type	Type of the alias. One of the enum values: Original Script Name Name Spelling Variation Shortened Name Maiden Name, Nickname Previous Name Fake Name
18	datesOfBirthIso	List of birth dates of the person. Formats: YYYY-MM-DD; YYYY-MM; YYYY.
19	nationalitiesIsoCodes	List of person’s nationalities. List of the person's nationalities in ISO 3166 (alpha-2) format.
20	addresses	List of person’s addresses.
21	addresses.addressType	One of the enum values: Place of birth Residential Business Previous Residential Previous Business
22	addresses.line1	Primary information, including the street address.
23	addresses.line2	Detailed information of the address. May include: Apartment number, suite number, room number, floor number, box number, care-of address etc.
24	addresses.postcode	-
25	addresses.city	-
26	addresses.county	Name of the region.
27	addresses.countryIsoCode	Country ISO 3166 (alpha-2) code.
28	profileImages	List of person images URLs.
29	notes	List of notes.
30	notes.value	A particular note from the notes list.
31	contactEntries	List of person’s contacts.
32	contactEntries.category	Contact’s category. One of the enum values: Telephone Fax Mobile Email
33	contactEntries.value	The contact itself.
34	identifiers	List of person’s identifiers.
35	identifiers.category	Indentifiers’s category.
36	identifiers.value	The santion’s identifier itself.
37	evidences	List of evidences of person’s entries into datasets.
38	evidences.datasets	List of evidence datasets. Active datasets where person is tagged in. Possible enum values are any of the described datasets here.
39	evidences.evidenceId	The unique id of the evidence to link with `Entries` lists.
40	evidences.originalUrl	URL to the aticle which proves person’s political exposureness.
41	evidences.title	The title captured from the article.
42	evidences.credibility	Level of credibility of the evidence. One of the enum values: Low Medium High
43	evidences.language	The ISO 639 (alpha-3) code for the language of the evidence.
44	evidences.summary	Snippet from the article.
45	evidences.keywords	Key words associated with the evidence.
46	evidences.publicationDateIso	Date when evidence was originally published. In ISO format: YYYY - MM - DD.
47	evidences.assetUrl	The URL link to the PDF version of the evidence. This is only available if `isCopyrighted` is false.
48	sanctionEntries	List of person's sanctions.
49	sanctionEntries.current	List of current sanctions.
50	sanctionEntries.current.sanctionId	Sanction’s unique id.
51	sanctionEntries.current.measures	The list of measures enforced by the sanctioning body.
52	sanctionEntries.current.regime	Details about sanctioning body.
53	sanctionEntries.current.regime.body	The name of the sanction issuing body.
54	sanctionEntries.current.regime.name	The name of the sanction Regime allocated by the sanctioning body.
55	sanctionEntries.current.regime.origin	Country or region issuing sanction.
56	sanctionEntries.current.regime.types	Type of the sanction by sanctioning body. One of the enum values: Counter Narcotics Human Rights Non-Proliferation Territorial Violation Terrorism
57	sanctionEntries.current.events	The list of the events related to sanctions with links to evidences.
58	sanctionEntries.current.events.type	Type of the event. One of the enum values: Added Amended Removed
59	sanctionEntries.current.events.evidenceIds	The list of evidence Ids associated with the sanction event.
60	sanctionEntries.former	List of former sanctions.
61	sanctionEntries.former.sanctionId	Same as for sanctionEntries.current.
62	sanctionEntries.former.measures	Same as for sanctionEntries.current.
63	sanctionEntries.former.regime	Same as for sanctionEntries.current.
64	sanctionEntries.former.regime.body	Same as for sanctionEntries.current.
65	sanctionEntries.former.regime.name	Same as for sanctionEntries.current.
66	sanctionEntries.former.regime.origin	Same as for sanctionEntries.current.
67	sanctionEntries.former.regime.types	Same as for sanctionEntries.current.
68	sanctionEntries.former.events	Same as for sanctionEntries.current.
69	sanctionEntries.former.events.type	Same as for sanctionEntries.current.
70	sanctionEntries.former.events.evidenceIds	Same as for sanctionEntries.current.
71	regulatoryEnforcementListEntries	Person’s entries in the Regulatory Enforcement List (REL).
72	regulatoryEnforcementListEntries.category	Category of the Regulatory Enforcement. One of the enum values: Financial Regulator Law Enforcement
73	regulatoryEnforcementListEntries.subcategory	Name of the REL.
74	regulatoryEnforcementListEntries.events	The list of events related to REL with links to evidences.
75	regulatoryEnforcementListEntries.events.type	The type of the event associated with the list entry.
76	regulatoryEnforcementListEntries.events.currencyCode	For specific event types, there can be associated financial penalties. This field indicates the international currency code.
77	regulatoryEnforcementListEntries.events.amount	For specific event types, there can be associated financial penalties. This field indicates the monetary amount.
78	regulatoryEnforcementListEntries.events.period	The length of the penalty.
79	regulatoryEnforcementListEntries.events.period.days	-
80	regulatoryEnforcementListEntries.events.period.years	-
81	regulatoryEnforcementListEntries.events.period.months	-
82	regulatoryEnforcementListEntries.events.evidenceIds	The list of evidence Ids associated with the REL event.
83	adverseMediaEntries	List of person’s mentions in adverse media.
84	adverseMediaEntries.category	Category of the adverse media.
85	adverseMediaEntries.subcategory	Subcategory of the adverse media.
86	adverseMediaEntries.events	List of the events. The list of the events related to adverse media with links to evidences.
87	adverseMediaEntries.events.type	Event type.
88	adverseMediaEntries.events.evidenceIds	The list of evidence Ids associated with the adverse media event.
89	pepEntries	List of person’s entries into Politically Exposed Persons dataset.
90	pepEntries.pepTier	Defines the PEP tier of the person. One of the enum values: PEP Tier 1 PEP Tier 2 PEP Tier 3 PEP By Assocation
91	pepEntries.current	List of current PEP positions.
92	pepEntries.current.countryIsoCode	The ISO country code of the country where the position is held.
93	pepEntries.current.segment	The category of PEP position in scope of particular country.
94	pepEntries.current.position	The exact political position.
95	pepEntries.current.dateFromIso	The start date of the position. In ISO format: YYYY - MM - DD.
96	pepEntries.current.dateToIso	The end date of the position. In ISO format: YYYY - MM - DD.
97	pepEntries.current.evidenceIds	The list of evidence Ids associated with the PEP entry.
98	pepEntries.former	List of former PEP positions.
99	pepEntries.former.countryIsoCode	Same as for pepEntries.current.
100	pepEntries.former.segment	Same as for pepEntries.current.
101	pepEntries.former.position	Same as for pepEntries.current.
102	pepEntries.former.dateFromIso	Same as for pepEntries.current.
103	pepEntries.former.dateToIso	Same as for pepEntries.current.
104	pepEntries.former.evidenceIds	Same as for pepEntries.current.
105	pepByAssociationEntries	List of links to persons because of whom they considered PEP by association.
106	pepByAssociationEntries.resourceId	The resource ID can be used to retrieve the detailed info or the PDF of the PEP person.
107	pepByAssociationEntries.evidenceIds	The list of evidence Ids associated with the linked person.
108	individualLinks	List of associated persons.
109	individualLinks.firstName	-
110	individualLinks.middleName	-
111	individualLinks.lastName	-
112	individualLinks.relationship	Description of relationship with the person.
113	individualLinks.ownershipPercentage	For certain relationship type related to business ownership this value will indicate the percentage ownership when known. Values from `1` to `100`.
114	individualLinks.resourceId	The resource ID can be used to retrieve the detailed info or the PDF of the linked person.
115	individualLinks.datasets	The active datasets, where person is tagged in. Enum values are described here.
116	businessLinks	List of associated businesses.
117	businessLinks.name	The name of the linked business.
118	businessLinks.relationship	Description of relationship with the person.
119	businessLinks.ownershipPercentage	Same as for individualLinks.ownershipPercentage
120	businessLinks.resourceId	The resource ID can be used to retrieve the detailed info or the PDF of the linked business.
121	businessLinks.datasets	The active datasets, where business is tagged in. Possible enum values are any of the described datasets here.
122	businessLinks.individualLinks	List of persons associated with businesses.
123	businessLinks.individualLinks.firstName	-
124	businessLinks.individualLinks.middleName	-
125	businessLinks.individualLinks.lastName	-
126	businessLinks.individualLinks.relationship	Same as for individualLinks.
127	businessLinks.individualLinks.ownershipPercentage	Same as for individualLinks.
128	businessLinks.individualLinks.resourceId	Same as for individualLinks.
129	businessLinks.individualLinks.datasets	Same as for individualLinks.
130	datasets	The active datasets, where person is tagged in. Possible enum values are any of the described datasets here.

Example

Retrieve the saved basic search of the person

Once the basic search for a person is performed, it can be accessed by providing its unique resourceId in the request of the endpoint:

All the data in the request and response is the same as described in the section:

https://ondato.atlassian.net/wiki/spaces/PUB/pages/2379612161/Person+AML+Screening#%F0%9F%94%8E-Search-for-a-person.