Skip to main content
WEBHOOK
app.amlyze.related_entity.screening.sanctions.completed
{
  "customerExternalId": "bb2274b1-6804-41f3-9e6f-81b9eb6700e3",
  "externalId": "bb2274b1-6804-41f3-9e6f-81b9eb6700o6",
  "establishmentDate": "1998-04-07",
  "type": "ORGANIZATION",
  "title": "Company LTD",
  "nationalCode": "554555447884557",
  "relationCode": "OWNER",
  "countryCode": "LT",
  "sanctioned": true,
  "screeningMatch": true,
  "screeningGuid": "0199bee4-a5e6-71d6-8f81-9bd85806942b"
}

Body

application/json
​
customerExternalId
string

External id of the customer to which the related entity is related.

Example:

"49187e79-e3be-4bc4-82e3-571f3b8a073e"

​
externalId
string

Related entity external id.

Example:

"de1be215-776d-4aa4-8063-5e77c8f3e905"

​
type
enum<string>

Related entity type.

Available options:
INDIVIDUAL,
ORGANIZATION,
UNKNOWN
Example:

"INDIVIDUAL"

​
birthDate
string<date>

Related entity birth date (for INDIVIDUAL).

Example:

"2000-01-01"

​
establishmentDate
string<date>

Related entity establishment date (for ORGANIZATION).

Example:

"2000-01-01"

​
firstName
string

Related entity first name (for INDIVIDUAL).

Example:

"John"

​
lastName
string

Related entity last name (for INDIVIDUAL).

Example:

"Doe"

​
title
string

Related entity title.

Example:

"My Company Ltd."

​
nationalCode
string

Related entity national code.

Example:

"1234567890"

​
relationCode
string

Related entity relation type. Value from /classifier/relationType endpoint

Example:

"OWNER"

​
countryCode
string

Related entity country code.

Example:

"LT"

​
screeningMatch
boolean

Indicates if the screening process found any matches.

Example:

true

​
screeningGuid
string

Identifier of the screening alert. Only returned if there is a match.

Example:

"fda4c67e-b031-40f4-b71b-cb6270be1eee"

​
sanctioned
boolean

Related entity sanctioned or not.

Example:

true