Search

Search

POST https://biometrid.com/api/providers/custom/aml01/search?processId={{processId}}

This endpoint allows you to search for entity aml

Query Parameters

Name	Type	Description
processId	string	ID of process to save the search result

Headers

Name	Type	Description
Accept-Language	string	en (default), pt
Content-type	string	application/json
Authorization	string	Authentication account or user token

Request Body

Name	Type	Description
removeSearch	boolean	If true, this search will be removed from watch list
entityType	string	String of "person", "company", "organisation", "vessel", "aircraft"
removeDeceased	number	Removes deceased people when set to "1".
exactMatch	boolean	Exact match disables all standard and optional matching behaviours
types	array	Array of "sanction", "warning", "fitness-probity", "pep", "pep-class-1", "pep-class-2", "pep-class-3", "pep-class-4"
fuzziness	number	Settings - Fuzziness, from 0.0 to 1.0 inclusive decides the match fuzziness level from exact match (0.0) to loose (1.0). Default 0.5
searchTerm	string	Search term - general, required when searchTermLastName, searchTermMiddleNames or searchTermFirstName is missing
searchTermLastName	string	Search term by last name
searchTermMiddleNames	string	Search term by middle names
searchTermFirstName	string	Search term by first name
birthYear	string	Filter by birth year
countryCodes	string	Filter by country codes (ISO 3166-1 alpha-2)

200

{
  "data": {
    "status": true,
    "result": {
      "id": 628165328,
      "match_status": "potential_match",
      ...
  }
}

{
	"searchTermLastName": "last name",
	"searchTermMiddleNames": "middle names",
	"searchTermFirstName": "first name",
	"fuzziness": 0.6,
	"types": [
		"sanction",
		"warning"
	],
	"birthYear": "1957",
	"countryCodes": [
		"SA",
		"YE",
		"AF"
	],
	"entityType": "person",
	"removeDeceased": 0,
	"removeSearch": true
}