full_namestring required
Full name of the person or company to be screened.
entity_typestring
Type of entity to screen. Either 'person' or 'company'. Defaults to 'person'.
date_of_birthstring
Date of birth for persons or incorporation date for companies, with format: YYYY-MM-DD. For example, 1990-05-15.
nationalitystring
Nationality of the person to be screened with format ISO 3166-1 alpha-2. For example: ES. Only applicable for person entity type.
document_numberstring
Document number of the person to be screened. Only applicable for person entity type.
aml_score_approve_thresholdnumber
Score threshold below which hits are auto-approved (0-100). Hits with match scores below this threshold will be marked as approved. Default: 86.
aml_score_review_thresholdnumber
Score threshold above which hits are auto-declined (0-100). Hits with match scores above this threshold will be declined. Scores between approve and review thresholds require manual review. Default: 100.
aml_name_weightinteger
Weight for name similarity in match score calculation (0-100). The sum of aml_name_weight + aml_dob_weight + aml_country_weight must equal 100. Default: 60.
aml_dob_weightinteger
Weight for date of birth in match score calculation (0-100). The sum of aml_name_weight + aml_dob_weight + aml_country_weight must equal 100. Default: 25.
aml_country_weightinteger
Weight for country/nationality in match score calculation (0-100). The sum of aml_name_weight + aml_dob_weight + aml_country_weight must equal 100. Default: 15.
aml_match_score_thresholdinteger
Match score threshold (0-100) that determines if a hit is a False Positive or Unreviewed (Possible Match). Hits with match_score below this are marked as 'False Positive' and excluded from risk assessment. Hits at or above are 'Unreviewed' (Possible Match). Default: 93.
include_adverse_mediaboolean
Wheter to include adverse media in the screening. If included, the request will take approximately 10 seconds.
include_ongoing_monitoringboolean
Whether to include ongoing monitoring in the screening. If included, the save_api_request must be included as well, otherwise it will raise an error.
save_api_requestboolean
Whether to save this API request. If true, then it will appear on the Manual Checks section in the Business Console.
vendor_datastring
A unique identifier for the vendor or user, such as a UUID or email. This field enables proper session tracking and user data aggregation across multiple verification sessions.