Get Started
Customer
Customer Document
Go!Chat
Go!KYT
Go!Press
Go!Scan
Go!Vid
Appendix
Go!Scan
Name search
undefined
POST
/
api
/
v1
/
scan
/
namesearch
Copy
{
"company_input_data": {
"company_name": "string",
"countries": [
"string"
]
},
"entity_type": "integer",
"exact_match": "boolean",
"keep_results_under_threshold": "boolean",
"page_size": "integer",
"page_token": "string",
"person_input_data": {
"AllowNamesInversion": "boolean",
"countries": [
"string"
],
"date_of_birth": "string",
"domicile_code": "string",
"exact_date_of_birth": "boolean",
"first_name": "string",
"last_name": "string",
"nationality_code": "string"
},
"post_filtering_alias": "string",
"query": "string"
}
Copy
{
"next_page_token": "string",
"results": [
{
"associates": [
{
"list_id": "string"
}
],
"company_name_scores": [
{
"candidate": "string",
"explanations": [
"string"
],
"query": "string",
"score": "integer"
}
],
"concat_name_scores": [
{
"candidate": "string",
"explanations": [
"string"
],
"query": "string",
"score": "integer"
}
],
"first_name_scores": [
{
"candidate": "string",
"explanations": [
"string"
],
"query": "string",
"score": "integer"
}
],
"is_pep": "boolean",
"is_rca": "boolean",
"is_rca_pep": "boolean",
"is_rca_san": "boolean",
"is_rca_sie": "boolean",
"is_rca_sip": "boolean",
"is_rca_soe": "boolean",
"is_rca_sop": "boolean",
"is_san": "boolean",
"is_sie": "boolean",
"is_sip": "boolean",
"is_soe": "boolean",
"is_sop": "boolean",
"last_name_scores": [
{
"candidate": "string",
"explanations": [
"string"
],
"query": "string",
"score": "integer"
}
],
"list_name": "string",
"list_profile": {
"addresses": [
{
"address_city": "string",
"address_country": "string",
"address_line": "string",
"url": "string"
}
],
"birth_place": [
"string"
],
"company_details": [
{
"address_city": "string",
"address_country": "string",
"address_line": "string",
"url": "string"
}
],
"countries": [
{
"codes": [
"string"
],
"country_type": "string",
"country_type_code": "integer",
"iso3_codes": [
"string"
],
"names": [
"string"
]
}
],
"date": "string",
"date_formated": "string",
"dates": [
{
"date_type": "string",
"date_type_code": "integer",
"date_values": [
{
"day": "string",
"dnote": "string",
"formated": "string",
"month": "string",
"year": "string"
}
]
}
],
"deceased": "boolean",
"descriptions": {
"descriptions1": [
{
"id": "string",
"text": "string"
}
],
"descriptions2": [
{
"id": "string",
"text": "string"
}
],
"descriptions3": [
{
"id": "string",
"text": "string"
}
]
},
"gender": "string",
"id_number_type": [
{
"id_type": "string",
"id_values": [
{
"id_notes": "string",
"value": "string"
}
]
}
],
"images": [
"string"
],
"list_id": "string",
"names": [
{
"name_type": "string",
"name_type_code": "integer",
"name_values": [
{
"entity_name": [
"string"
],
"first_name": [
"string"
],
"maiden_name": [
"string"
],
"middle_name": [
"string"
],
"original_script_name": [
"string"
],
"single_string_name": [
"string"
],
"suffix": [
"string"
],
"surname": [
"string"
],
"title_honorific": [
"string"
]
}
]
}
],
"profile_notes": "string",
"roles": [
{
"occupations": [
{
"category": "string",
"code": "string",
"since_day": "string",
"since_formated": "string",
"since_month": "string",
"since_year": "string",
"title": "string",
"to_day": "string",
"to_formated": "string",
"to_month": "string",
"to_year": "string"
}
],
"role_type": "string",
"role_type_code": "integer"
}
],
"sanctions": [
{
"reference": "string",
"since_day": "string",
"since_formated": "string",
"since_month": "string",
"since_year": "string",
"to_day": "string",
"to_formated": "string",
"to_month": "string",
"to_year": "string"
}
],
"sources": [
"string"
],
"status": "string",
"type": "string",
"vessels": [
{
"vessel_call_sign": "string",
"vessel_flag": "string",
"vessel_grt": "string",
"vessel_owner": "string",
"vessel_tonnage": "string",
"vessel_type": "string"
}
]
},
"list_types": [
"string"
],
"middle_name_scores": [
{
"candidate": "string",
"explanations": [
"string"
],
"query": "string",
"score": "integer"
}
],
"over_threshold": "boolean",
"score": "integer",
"trading_name_scores": [
{
"candidate": "string",
"explanations": [
"string"
],
"query": "string",
"score": "integer"
}
]
}
],
"total": "integer"
}
Body parameters
Mandatory. 1 means Individual, 2 means Firm
Returns results under threashold defined by the post-filtering alias (or 50% by default).
Optional. Set to empty string or don’t set for first page.
Show properties
Show properties
If set to true then we will also look for results when first and last names are inverted.
Format should be YYYY-MM-DD or YYYY-MM or YYYY or YYYY-00-00 or YYYY-MM-00
ISO3 or ISO2, only if post_filtering_alias is set to non-null
ISO3 or ISO2, only if post_filtering_alias is set to non-null
null to not use any post-filtering, empty string to use the default post-filtering settings, or use an alias.
Deprecated. Use ScanIndividualInput or ScanFirmInput instead.
Response body
Show properties
Show properties
Politically Exposed Person
Relative or Close Associate to a sanctioned record
Relative or Close Associate to Politically Exposed Person
Relative or Close Associate to Special Interest Entity
Relative or Close Associate to Special Interest Person
Special Interest Entity
Special Interest Person
Name of the source list
Show properties
Show properties
Record update date
Record update date formatted
Show properties
Show properties
See NameTypes
See NameTypes
Show properties
Show properties
Name of the firm or non-individual entity
null or list of strings
null or list of strings
null or list of strings
Name in original alphabet
All names concatenated in one string
null or list of strings
null or list of strings
Additional notes
Source url, newspaper links etc
Overall match score between 0 and 100
Show properties
Show properties
Politically Exposed Person
Relative or Close Associate to a sanctioned record
Relative or Close Associate to Politically Exposed Person
Relative or Close Associate to Special Interest Entity
Relative or Close Associate to Special Interest Person
Special Interest Entity
Special Interest Person
Name of the source list
Show properties
Show properties
Record update date
Record update date formatted
Show properties
Show properties
See NameTypes
See NameTypes
Show properties
Show properties
Name of the firm or non-individual entity
null or list of strings
null or list of strings
null or list of strings
Name in original alphabet
All names concatenated in one string
null or list of strings
null or list of strings
Additional notes
Source url, newspaper links etc
Overall match score between 0 and 100
Copy
{
"company_input_data": {
"company_name": "string",
"countries": [
"string"
]
},
"entity_type": "integer",
"exact_match": "boolean",
"keep_results_under_threshold": "boolean",
"page_size": "integer",
"page_token": "string",
"person_input_data": {
"AllowNamesInversion": "boolean",
"countries": [
"string"
],
"date_of_birth": "string",
"domicile_code": "string",
"exact_date_of_birth": "boolean",
"first_name": "string",
"last_name": "string",
"nationality_code": "string"
},
"post_filtering_alias": "string",
"query": "string"
}
Copy
{
"next_page_token": "string",
"results": [
{
"associates": [
{
"list_id": "string"
}
],
"company_name_scores": [
{
"candidate": "string",
"explanations": [
"string"
],
"query": "string",
"score": "integer"
}
],
"concat_name_scores": [
{
"candidate": "string",
"explanations": [
"string"
],
"query": "string",
"score": "integer"
}
],
"first_name_scores": [
{
"candidate": "string",
"explanations": [
"string"
],
"query": "string",
"score": "integer"
}
],
"is_pep": "boolean",
"is_rca": "boolean",
"is_rca_pep": "boolean",
"is_rca_san": "boolean",
"is_rca_sie": "boolean",
"is_rca_sip": "boolean",
"is_rca_soe": "boolean",
"is_rca_sop": "boolean",
"is_san": "boolean",
"is_sie": "boolean",
"is_sip": "boolean",
"is_soe": "boolean",
"is_sop": "boolean",
"last_name_scores": [
{
"candidate": "string",
"explanations": [
"string"
],
"query": "string",
"score": "integer"
}
],
"list_name": "string",
"list_profile": {
"addresses": [
{
"address_city": "string",
"address_country": "string",
"address_line": "string",
"url": "string"
}
],
"birth_place": [
"string"
],
"company_details": [
{
"address_city": "string",
"address_country": "string",
"address_line": "string",
"url": "string"
}
],
"countries": [
{
"codes": [
"string"
],
"country_type": "string",
"country_type_code": "integer",
"iso3_codes": [
"string"
],
"names": [
"string"
]
}
],
"date": "string",
"date_formated": "string",
"dates": [
{
"date_type": "string",
"date_type_code": "integer",
"date_values": [
{
"day": "string",
"dnote": "string",
"formated": "string",
"month": "string",
"year": "string"
}
]
}
],
"deceased": "boolean",
"descriptions": {
"descriptions1": [
{
"id": "string",
"text": "string"
}
],
"descriptions2": [
{
"id": "string",
"text": "string"
}
],
"descriptions3": [
{
"id": "string",
"text": "string"
}
]
},
"gender": "string",
"id_number_type": [
{
"id_type": "string",
"id_values": [
{
"id_notes": "string",
"value": "string"
}
]
}
],
"images": [
"string"
],
"list_id": "string",
"names": [
{
"name_type": "string",
"name_type_code": "integer",
"name_values": [
{
"entity_name": [
"string"
],
"first_name": [
"string"
],
"maiden_name": [
"string"
],
"middle_name": [
"string"
],
"original_script_name": [
"string"
],
"single_string_name": [
"string"
],
"suffix": [
"string"
],
"surname": [
"string"
],
"title_honorific": [
"string"
]
}
]
}
],
"profile_notes": "string",
"roles": [
{
"occupations": [
{
"category": "string",
"code": "string",
"since_day": "string",
"since_formated": "string",
"since_month": "string",
"since_year": "string",
"title": "string",
"to_day": "string",
"to_formated": "string",
"to_month": "string",
"to_year": "string"
}
],
"role_type": "string",
"role_type_code": "integer"
}
],
"sanctions": [
{
"reference": "string",
"since_day": "string",
"since_formated": "string",
"since_month": "string",
"since_year": "string",
"to_day": "string",
"to_formated": "string",
"to_month": "string",
"to_year": "string"
}
],
"sources": [
"string"
],
"status": "string",
"type": "string",
"vessels": [
{
"vessel_call_sign": "string",
"vessel_flag": "string",
"vessel_grt": "string",
"vessel_owner": "string",
"vessel_tonnage": "string",
"vessel_type": "string"
}
]
},
"list_types": [
"string"
],
"middle_name_scores": [
{
"candidate": "string",
"explanations": [
"string"
],
"query": "string",
"score": "integer"
}
],
"over_threshold": "boolean",
"score": "integer",
"trading_name_scores": [
{
"candidate": "string",
"explanations": [
"string"
],
"query": "string",
"score": "integer"
}
]
}
],
"total": "integer"
}
Copy
{
"company_input_data": {
"company_name": "string",
"countries": [
"string"
]
},
"entity_type": "integer",
"exact_match": "boolean",
"keep_results_under_threshold": "boolean",
"page_size": "integer",
"page_token": "string",
"person_input_data": {
"AllowNamesInversion": "boolean",
"countries": [
"string"
],
"date_of_birth": "string",
"domicile_code": "string",
"exact_date_of_birth": "boolean",
"first_name": "string",
"last_name": "string",
"nationality_code": "string"
},
"post_filtering_alias": "string",
"query": "string"
}
Copy
{
"next_page_token": "string",
"results": [
{
"associates": [
{
"list_id": "string"
}
],
"company_name_scores": [
{
"candidate": "string",
"explanations": [
"string"
],
"query": "string",
"score": "integer"
}
],
"concat_name_scores": [
{
"candidate": "string",
"explanations": [
"string"
],
"query": "string",
"score": "integer"
}
],
"first_name_scores": [
{
"candidate": "string",
"explanations": [
"string"
],
"query": "string",
"score": "integer"
}
],
"is_pep": "boolean",
"is_rca": "boolean",
"is_rca_pep": "boolean",
"is_rca_san": "boolean",
"is_rca_sie": "boolean",
"is_rca_sip": "boolean",
"is_rca_soe": "boolean",
"is_rca_sop": "boolean",
"is_san": "boolean",
"is_sie": "boolean",
"is_sip": "boolean",
"is_soe": "boolean",
"is_sop": "boolean",
"last_name_scores": [
{
"candidate": "string",
"explanations": [
"string"
],
"query": "string",
"score": "integer"
}
],
"list_name": "string",
"list_profile": {
"addresses": [
{
"address_city": "string",
"address_country": "string",
"address_line": "string",
"url": "string"
}
],
"birth_place": [
"string"
],
"company_details": [
{
"address_city": "string",
"address_country": "string",
"address_line": "string",
"url": "string"
}
],
"countries": [
{
"codes": [
"string"
],
"country_type": "string",
"country_type_code": "integer",
"iso3_codes": [
"string"
],
"names": [
"string"
]
}
],
"date": "string",
"date_formated": "string",
"dates": [
{
"date_type": "string",
"date_type_code": "integer",
"date_values": [
{
"day": "string",
"dnote": "string",
"formated": "string",
"month": "string",
"year": "string"
}
]
}
],
"deceased": "boolean",
"descriptions": {
"descriptions1": [
{
"id": "string",
"text": "string"
}
],
"descriptions2": [
{
"id": "string",
"text": "string"
}
],
"descriptions3": [
{
"id": "string",
"text": "string"
}
]
},
"gender": "string",
"id_number_type": [
{
"id_type": "string",
"id_values": [
{
"id_notes": "string",
"value": "string"
}
]
}
],
"images": [
"string"
],
"list_id": "string",
"names": [
{
"name_type": "string",
"name_type_code": "integer",
"name_values": [
{
"entity_name": [
"string"
],
"first_name": [
"string"
],
"maiden_name": [
"string"
],
"middle_name": [
"string"
],
"original_script_name": [
"string"
],
"single_string_name": [
"string"
],
"suffix": [
"string"
],
"surname": [
"string"
],
"title_honorific": [
"string"
]
}
]
}
],
"profile_notes": "string",
"roles": [
{
"occupations": [
{
"category": "string",
"code": "string",
"since_day": "string",
"since_formated": "string",
"since_month": "string",
"since_year": "string",
"title": "string",
"to_day": "string",
"to_formated": "string",
"to_month": "string",
"to_year": "string"
}
],
"role_type": "string",
"role_type_code": "integer"
}
],
"sanctions": [
{
"reference": "string",
"since_day": "string",
"since_formated": "string",
"since_month": "string",
"since_year": "string",
"to_day": "string",
"to_formated": "string",
"to_month": "string",
"to_year": "string"
}
],
"sources": [
"string"
],
"status": "string",
"type": "string",
"vessels": [
{
"vessel_call_sign": "string",
"vessel_flag": "string",
"vessel_grt": "string",
"vessel_owner": "string",
"vessel_tonnage": "string",
"vessel_type": "string"
}
]
},
"list_types": [
"string"
],
"middle_name_scores": [
{
"candidate": "string",
"explanations": [
"string"
],
"query": "string",
"score": "integer"
}
],
"over_threshold": "boolean",
"score": "integer",
"trading_name_scores": [
{
"candidate": "string",
"explanations": [
"string"
],
"query": "string",
"score": "integer"
}
]
}
],
"total": "integer"
}
Assistant
Responses are generated using AI and may contain mistakes.