AML
Retrieving detailed information about the user collected during the AML process
The method retrieves data found in AML lists based on user data. Data from AML lists as defined when creating the conversation. When a continuous AML monitoring subscription is activated, only the latest available data is returned.
We can specify the list type in the query by specifying one of the following AML list types: PEP, SIP, SANCTIONS, ADVERSE_MEDIA, OTHER. Depending on the type of list you select, the structure of the response may vary.
::note AML verification sources provide data in an inconsistent form, e.g., some dates and country names. We currently provide this data as received from the source, but in future we may unify them on Authologic side. This may change the format of the data available to the API. ::
Response Parameters Available for PEP List Type
| Parameter | Example | Description |
|---|---|---|
| type | PERSON | Informs if entry describes user or users's relative: PERSON - user, RCA - users's relative |
| score | 0.98 | Compliance level of provided personal data with results (0-1 if provided or null) |
| reason | -- | Reason why person is on the list |
| user.person | -- | Data found on AML lists for provided person |
| user.person.name.firstName | -- | User name |
| user.person.name.lastName | -- | User surname |
| user.person.name.middleName | -- | Second name |
| user.person.name.spellings | -- | Correct spelling of name and surname (including national language) |
| user.person.name.alsoKnownAs | -- | Alias names of person under verification |
| user.person.name.alsoKnownAs.firstName | -- | User's other firstname |
| user.person.name.alsoKnownAs.lastName | -- | User's other surname |
| user.person.name.alsoKnownAs.title | -- | User alias |
| user.person.address.country | POLAND (no unified country name format) | Country of residence of the person |
| user.person.info | -- | Additional information about the person under verification |
| user.person.info.gender | MALE | The gender of the user: MALE, FEMALE, OTHER |
| user.person.info.nationality | Poland (no unified country name format) | User's nationality |
| user.person.info.birthDate | 1972-10-18 (no unified date format) | Date of birth |
| user.person.info.deceased | true/false | Information if person is dead |
| user.person.info.deceaseDate | 2020-10-18 (no unified date format) | Date of death |
| user.person.info.image | -- | URL to person's picture |
| user.person.info.roles | -- | Information about the exposed position held by the person |
| user.person.info.roles[].title | -- | Position held or Unknown if position is unknown |
| user.person.info.roles[].country | (no unified country name format) | The country in which the position was held or 'Unknown' if country is unknown |
| user.person.info.roles[].fromDate | 2014-05-01 (no unified date format) | Start date of tenure |
| user.person.info.roles[].tillDate | 2019 (no unified date format) | End date of tenure |
Response Parameters Available for SANCTIONS List Type
| Parameter | Example | Description |
|---|---|---|
| type | PERSON | Informs if entry describes user or users's relative: PERSON - user, RCA - user's relative |
| score | 0.98 | Compliance level of provided personal data with results (0-1 if provided or null) |
| reason | -- | Reason why person is on the list |
| sources | -- | Names of AML list types on which the person was found |
| user.person | -- | Data found on AML lists for provided person |
| user.person.name.firstName | -- | User name |
| user.person.name.lastName | -- | User surname |
| user.person.name.middleName | -- | Second name |
| user.person.name.spellings | -- | Correct spelling of name and surname (including national language) |
| user.person.name.alsoKnownAs | -- | Alias names of person under verification |
| user.person.name.alsoKnownAs.firstName | -- | User's other firstname |
| user.person.name.alsoKnownAs.lastName | -- | User's other surname |
| user.person.name.alsoKnownAs.title | -- | User alias |
| user.person.address.country | POLAND (no unified country name format) | Country of residence of the person |
| user.person.info | -- | Additional information about the person under verification |
| user.person.info.gender | MALE | The gender of the user: MALE, FEMALE, OTHER |
| user.person.info.nationality | Poland (no unified country name format) | User's nationality |
| user.person.info.birthDate | 1972-10-18 (no unified date format) | Date of birth |
| user.person.info.deceased | true/false | Information if person is dead |
| user.person.info.deceaseDate | 2020-10-18 (no unified date format) | Date of death |
| user.person.info.image | -- | URL to person's picture |
| user.person.info.roles | -- | Information about the exposed position held by the person |
| user.person.info.roles[].title | -- | Position held or 'Unknown' if position is unknown |
| user.person.info.roles[].country | (no unified country name format) | The country in which the position was held or 'Unknown' if country is unknown |
| user.person.info.roles[].fromDate | 2014-05-01 (no unified date format) | Start date of tenure |
| user.person.info.roles[].tillDate | 2019 (no unified date format) | End date of tenure |
Response Parameters Available for SIP List Type
| Parameter | Example | Description |
|---|---|---|
| type | PERSON | Informs if entry describes user or users's relative PERSON - user, RCA - user's relative |
| score | 0.98 | Compliance level of provided personal data with results (0-1 if provided or null) |
| reason | -- | Reason why person is on the list |
| user.person | -- | Data found on AML lists for provided person |
| user.person.name.firstName | -- | User name |
| user.person.name.lastName | -- | User surname |
| user.person.name.middleName | -- | Second name |
| user.person.name.spellings | -- | Correct spelling of name and surname (including national language) |
| user.person.name.alsoKnownAs | -- | Alias names of person under verification |
| user.person.name.alsoKnownAs.firstName | -- | User's other firstname |
| user.person.name.alsoKnownAs.lastName | -- | User's other surname |
| user.person.name.alsoKnownAs.title | -- | User alias |
| user.person.address.country | POLAND (no unified country name format) | Country of residence of the person |
| user.person.info | -- | Additional information about the person under verification |
| user.person.info.gender | MALE | The gender of the user: MALE, FEMALE, OTHER |
| user.person.info.nationality | Poland (no unified country name format) | User's nationality |
| user.person.info.birthDate | 1972-10-18 (no unified date format) | Date of birth |
| user.person.info.deceased | true/false | Information if person is dead |
| user.person.info.deceaseDate | 2020-10-18 (no unified date format) | Date of death |
| user.person.info.image | -- | URL to person's picture |
| user.person.info.roles | -- | Information about the exposed position held by the person |
| user.person.info.roles[].title | -- | Position held or 'Unknown' if position is unknown |
| user.person.info.roles[].country | (no unified country name format) | The country in which the position was held or Unknown if country is unknown |
| user.person.info.roles[].fromDate | 2014-05-01 (no unified date format) | Start date of tenure |
| user.person.info.roles[].tillDate | 2019 (no unified date format) | End date of tenure |
Response Parameters Available for ADVERSE_MEDIA List Type
| Parameter | Example | Description |
|---|---|---|
| originalUrl | -- | Link to adverse article |
| date | 2020-10-18 (date format yyyy-MM-dd) | Adverse media publication date |
| url | -- | Link to PDF with original adverse media publication |
| categories | -- | Media categorization |
Response Parameters Available for OTHER List Type
| Parameter | Example | Description |
|---|---|---|
| type | PERSON | Informs if entry describes user or users's relative: PERSON - user, RCA - user's relative |
| score | 0.98 | Compliance level of provided personal data with results (0-1 if provided or null) |
| reason | -- | Reason why person is on the list |
| user.person | -- | Data found on AML lists for provided person |
| user.person.name.firstName | -- | User name |
| user.person.name.lastName | -- | User surname |
| user.person.name.middleName | -- | Second name |
| user.person.name.spellings | -- | Correct spelling of name and surname (including national language) |
| user.person.name.alsoKnownAs | -- | Alias names of person under verification |
| user.person.name.alsoKnownAs.firstName | -- | User's other firstname |
| user.person.name.alsoKnownAs.lastName | -- | User's other surname |
| user.person.name.alsoKnownAs.title | -- | User alias |
| user.person.address.country | POLAND (no unified country name format) | Country of residence of the person |
| user.person.info | -- | Additional information about the person under verification |
| user.person.info.gender | MALE | The gender of the user: MALE, FEMALE, OTHER |
| user.person.info.nationality | Poland (no unified country name format) | User's nationality |
| user.person.info.birthDate | 1972-10-18 (no unified date format) | Date of birth |
| user.person.info.deceased | true/false | Information if person is dead |
| user.person.info.deceaseDate | 2020-10-18 (no unified date format) | Date of death |
| user.person.info.image | -- | URL to person's picture |
| user.person.info.roles | -- | Information about the exposed position held by the person |
| user.person.info.roles[].title | -- | Position held or Unknown if position is unknown |
| user.person.info.roles[].country | (no unified country name format) | The country in which the position was held or Unknown if country is unknown |
| user.person.info.roles[].fromDate | 2014-05-01 (no unified date format) | Start date of tenure |
| user.person.info.roles[].tillDate | 2019 (no unified date format) | End date of tenure |
get/api/conversations/{conversationId}/aml/{list}
Path parameters
conversationIdstring required
Conversation ID
list'PEP' | 'SANCTIONS' | 'ADVERSE_MEDIA' | 'SIP' | 'OTHER' required
List name
Query parameters
pageinteger
Page number
pageSizeinteger
The number of items on the page
Response
User found on given AML list
Changes
No recorded changes to this endpoint across all 1 revision of this API.