put https://api.idwise.com/checks/aml/
Replace AML search result on existing journey with new input data.
Usage
You can use this API for providing the different search data for re-performing the AML search on existing journey.
Use Cases
- Correcting Name Variations
- Example: A journey extracts the name
Johnfrom a document and performs an AML search. If the full name is later identified asJohn Doe, this API can update the search criteria to refine results and reduce false matches.
- Example: A journey extracts the name
- Updating AML Configuration
- Example: If AML settings (e.g., match threshold, filters) are modified in the flow definition, the changes apply only to new searches by default. Use this API to enforce updated configurations on existing journeys, ensuring consistency across all AML checks.
Base URL by Region
The base URL you should use depends on the region where your services are hosted. Below are the available URLs for each region. By default, the EU region URL is used.
- EU (Default): https://api.idwise.com/
- UAE: https://api-uae.idwise.com/
- Qatar: https://api-qat.idwise.com/
Authentication
Please refer to the API Credentials and Authentication page for more detailed information
Request Model
The request is a PUT request with the following parameters sent in the body
| Input Parameter | Description |
|---|---|
| entity_details | Type: object optionalThe entity object, only full_name is mandatory, birth_date and sex are optional parametersCheck the entity_details request model table for more information |
entity_details request model
| Property | Description |
|---|---|
| full_name | Type: string requiredThe full name of the applicant. |
| birth_date | Type: string optionalThe birth year of the applicant (ex: 2022-03-02) |
| sex | Type: string optionalmale or female |
Request Response
| Output Parameter | Description |
|---|---|
| success | Type: boolThe success result. |
Error Handling
To effectively handle errors from this API, refer to our comprehensive Error Handling Guide. This page provides detailed explanations of error codes, their meanings, and best practices for handling them in your integration.
Behavior
1. Change in AML Matches
- If the journey had AML matches that failed the AML check but the new search returns no matches, the AML check will pass, which could affect the journey's outcome.
- If the journey had no AML matches and passed the AML check, but the new search returns new matches, the AML check will fail, impacting the journey's status.
2. No Change in AML Results
- If the existence of AML results remains unchanged, no modifications will be made to the AML check or journey status.
3. Handling Whitelisted Matches
- If a previously whitelisted match reappears in the current search, its whitelist and match_type status will be preserved.
- This could still impact the AML check and journey status based on the current matching criteria.
Important Considerations
- Always ensure AML is enabled in the Flow before initiating the search.
- The AML check status may dynamically change based on new search results.
- Whitelisted matches maintain their previous status but can still influence the overall AML check outcome.