API Reference

post
AML Search
https://api.app.authenteq.com/aml/search
This endpoint makes the AML search using the ComplyAdvantage AML API.
Request
Response
Request
Headers
Authentication
required
string
Your client credentials combined with a colon separator, base64-encoded and prefixed with "Basic ".
Body Parameters
verificationId
required
string
The id of a verification from which to extract the exact search terms.
types
optional
array
The alert and warning filter. The possible values are: "SANCTION", "WARNING", "FITNESS_PROBITY", "PEP", "PEP_CLASS_1", "PEP_CLASS_2", "PEP_CLASS_3", "PEP_CLASS_4", "ADVERSE_MEDIA", "ADVERSE_MEDIA_FINANCIAL_CRIME", "ADVERSE_MEDIA_VIOLENT_CRIME",
"ADVERSE_MEDIA_SEXUAL_CRIME", "ADVERSE_MEDIA_TERRORISM", "ADVERSE_MEDIA_FRAUD", "ADVERSE_MEDIA_NARCOTICS", "ADVERSE_MEDIA_GENERAL".
fuzziness
optional
number
Determines how closely the returned results must match the supplied search terms. Means exact match when not specified. The value must be between 0.0 and 1.0.
offset
optional
integer
The offset value from where to retrieve the result entries. The default value is 0.
limit
optional
integer
The desired maximum amount of the result entries to retrieve. The default and maximum value is 100.
Response
200: OK
The AML search has been performed successfully.
{
  "matchStatus": "POTENTIAL_MATCH",
  "riskLevel": "UKNOWN",
  "totalHits": 1,
  "hits": [
    {
      "entity": {
        "entityType": "PERSON",
        "name": "Mugabe Robert Gabriel",
        "sources": [
          "europe-sanctions-list"
        ],
        "sourceNotes": {
          "europe-sanctions-list": {
            "name": "EU External Action Service - Consolidated list of Sanctions",
            "amlTypes": [
              "SANCTION"
            ],
            "url": "https://eeas.europa.eu/headquarters/headquarters-homepage_en/8442/Consolidated%20list%20of%20sanctions",
            "listingStartedAt": "2005-06-16T00:00:00Z",
            "listingEndedAt": "2020-02-25T00:00:00Z"
          }
        },
        "types": [
          "ADVERSE_MEDIA",
          "ADVERSE_MEDIA_FINANCIAL_CRIME",
          "ADVERSE_MEDIA_FRAUD",
          "ADVERSE_MEDIA_GENERAL",
          "ADVERSE_MEDIA_NARCOTICS",
          "ADVERSE_MEDIA_SEXUAL_CRIME",
          "ADVERSE_MEDIA_TERRORISM",
          "ADVERSE_MEDIA_VIOLENT_CRIME",
          "PEP",
          "PEP_CLASS_1",
          "PEP_CLASS_2",
          "PEP_CLASS_4",
          "SANCTION"
        ],
        "aka": [
          {
            "name": "Robert Mugabe"
          },
          {
            "name": "R. G. Mugabe"
          },
          {
            "name": "Robert G. Mugabe"
          }
        ],
        "associates": [
          {
            "name": "Gabriel Mugabe Matibiri",
            "association": "parent"
          },
          {
            "name": "Bona Mugabe",
            "association": "parent"
          },
          {
            "name": "Michael Mugabe",
            "association": "sibling"
          },
          {
            "name": "Grace Mugabe",
            "association": "spouse"
          },
          {
            "name": "Chatunga Bellarmine Mugabe",
            "association": "child"
          }
        ],
        "fields": [
          {
            "name": "Gender",
            "value": "male",
            "source": "complyadvantage"
          }
        ],
        "assets": [
          {
            "publicUrl": "http://complyadvantage-asset-development.s3.amazonaws.com/13530e09-a2c0-47b9-b72c-5bd75fccb627.pdf",
            "source": "complyadvantage",
            "type": "pdf"
          }
        ],
        "media": [
          {
            "date": "2019-09-06T00:00:00Z",
            "title": "Breaking: Zimbabwe ex-President Robert Mugabe is dead",
            "snippet": "At first, he worked for the African nationalist cause with Joshua Nkomo, before breaking away to become a founder member of the Zimbabwe African National Union (Zanu). In 1964, after making a speech in which he called Rhodesian Prime Minister Ian Smith and his government \"cowboys\", Mugabe was arrested and detained without trial for a decade. His baby son died while he was still in prison and he was refused permission to attend the funeral.",
            "url": "https://www.vanguardngr.com/2019/09/breaking-zimbabwe-ex-president-robert-mugabe-is-dead/"
          }
        ]
      },
      "matchTypes": [
        "NAME_EXACT",
        "YEAR_OF_BIRTH"
      ],
      "matchingTypesDetails": {
        "Mugabe Robert Gabriel": {
          "matchTypes": {
            "robert": [
              "NAME_EXACT"
            ],
            "gabriel": [
              "NAME_EXACT"
            ],
            "mugabe": [
              "NAME_EXACT"
            ]
          },
          "type": "name"
        }
      },
      "score": 21.756067
    }
  ],
  "offset": 0,
  "limit": 100
}
400: Bad Request
The request contains an invalid data.
Missing Request Body
Invalid Request Body
Missing Request Body
{
  "errorCode": "MISSING_REQUEST_BODY",
  "errorMessage": "Required request body is missing"
}
Invalid Request Body
{
  "errorCode": "INVALID_REQUEST_BODY",
  "errorMessage": "Request body contains an invalid data",
  "errorDetails": {
    "verificationId": [
      "must not be null"
    ]
  }
}
401: Unauthorized
Full authentication is required to perform AML search.
Missing API Keys
Invalid API Keys
Bad API Keys
Missing API Keys
{
  "errorCode": "API_KEYS_MISSING",
  "errorMessage: "No API Keys in the Authorization header"
}
Invalid API Keys
{
  "errorCode": "API_KEYS_INVALID",
  "errorMessage: "Invalid API Keys in the Authorization header"
}
Bad API Keys
{
  "errorCode": "API_KEYS_BAD",
  "errorMessage: "Bad API Keys"
}
403: Forbidden
The authenticated customer is disabled and cannot perform AML search.
Account Deactivated
Account Deactivated
{
  "errorCode": "ACCOUNT_DEACTIVATED",
  "errorMessage: "Account deactivated. Please contact your Authenteq Sales  Representative in order to keep using this service"
}
404: Not Found
No verification with the given id.
{
  "errorCode": "VERIFICATION_NOT_FOUND",
  "errorMessage": "Verification not found"
}
The detailed documentation for the used ComplyAdvantage AML API is accessible here: https://docs.complyadvantage.com/api-docs. Please read it to get understanding of things.
This endpoint expects a search request in the request body represented in JSON, conforming to the following JSON schema: https://api.app.authenteq.com/aml/search-request-schema.json.
This endpoint produces a search response in the response body represented in JSON, conforming to the following JSON schema: https://api.app.authenteq.com/aml/search-response-schema.json.
Use matchStatus and riskLevel fields to make a decision.
​
AML - Previous
AML Overview
Next - Recognition
Recognition Overview
Last updated 11 months ago
API Reference

postAML Search

post
AML Search
