API Reference
AML Search by Verification
POST https://api.app.authenteq.com/aml/search-by-verification
This endpoint makes the AML search taking the person details from the given identity verification.
A search request in the request body should be represented in JSON and conforms to the following JSON schema:
https://api.app.authenteq.com/aml/search-by-verification-request-schema.json
Headers
Authentication*
string
Your client credentials combined with a colon separator, base64-encoded and prefixed with "Basic ".
Request Body
verificationId*
string
The id of an identity verification from which to extract the exact person details.
The AML check has been requested successfully. Please sign in to your account in Amiqus Dashboard and review the result.
{
"uuid": "b4abfad2-3d9f-11ee-924e-784f4385af2b",
"searchType": "BY_VERIFICATIOIN",
"reference": "d364cb70-3cdc-11ee-b43e-784f4385af2b",
"surname": "DOE",
"givenNames": "JOHN",
"dateOfBirth": "1961-08-24",
"countryCode": "USA",
"url": "https://id.amiqus.co/clients/123/records/456"
}
{
"errorCode": "MISSING_REQUEST_BODY",
"errorMessage": "Required request body is missing"
}{
"errorCode": "INVALID_REQUEST_BODY",
"errorMessage": "Request body contains an invalid data",
"errorDetails": {
"verificationId": [
"must not be null"
]
}
}{
"errorCode": "REQUEST_UNPROCESSABLE",
"errorMessage": "Given request cannot be processed",
"errorDetails": {
"reason": "Requested verification not found"
}
}{
"errorCode": "REQUEST_UNPROCESSABLE",
"errorMessage": "Given request cannot be processed",
"errorDetails": {
"reason": "Requested verification has an unexpected status: FAILED"
}
}{
"errorCode": "REQUEST_UNPROCESSABLE",
"errorMessage": "Given request cannot be processed",
"errorDetails": {
"reason": "Requested verification has no document data"
}
}{
"errorCode": "ACCOUNT_DEACTIVATED",
"errorMessage: "Account deactivated. Please contact your Authenteq Sales Representative in order to keep using this service"
}{
"errorCode": "AML_DISABLED",
"errorMessage: "Account deactivated. Please contact your Authenteq Sales Representative in order to keep using this service to get access to this service"
}AML Search by Person
POST https://api.app.authenteq.com/aml/search-by-person
This endpoint makes the AML seach with the given person details.
A search request in the request body should be represented in JSON and conforms to the following JSON schema:
https://api.app.authenteq.com/aml/search-by-person-request-schema.json
Headers
Authentication*
string
Your client credentials combined with a colon separator, base64-encoded and prefixed with "Basic ".
Request Body
surname*
string
The person's surname. It must not be longer than 255 characters.
givenNames*
string
The person's given names. It must not be longer than 255 characters.
dateOfBirth
string
The person's date of birth. Format: YYYY-MM-DD. Example: 1976-12-01. The age must be in range of 16 to 200 years.
countryCode
string
The country code as ISO 3166-1 alpha-2 and alpha-3 strings of the person's country of residence.
reference*
UUID
The reference that uniqely identifies the person.
The AML check has been requested successfully. Please sign in to your account in Amiqus Dashboard and review the result.
{
"uuid": "b4abfad2-3d9f-11ee-924e-784f4385af2b",
"searchType": "BY_PERSON",
"reference": "d364cb70-3cdc-11ee-b43e-784f4385af2b",
"surname": "DOE",
"givenNames": "JOHN",
"dateOfBirth": "1961-08-24",
"countryCode": "USA",
"url": "https://id.amiqus.co/clients/123/records/456"
}{
"errorCode": "MISSING_REQUEST_BODY",
"errorMessage": "Required request body is missing"
}{
"errorCode": "INVALID_REQUEST_BODY",
"errorMessage": "Request body contains an invalid data",
"errorDetails": {
"surname": [
"must not be blank"
],
"givenNames": [
"must not be blank"
],
"reference": [
"must not be null"
]
}
}{
"errorCode": "ACCOUNT_DEACTIVATED",
"errorMessage: "Account deactivated. Please contact your Authenteq Sales Representative in order to keep using this service"
}{
"errorCode": "AML_DISABLED",
"errorMessage: "Account deactivated. Please contact your Authenteq Sales Representative in order to keep using this service to get access to this service"
}Last updated
Was this helpful?