​
Envelope

​
type
string
Unique event type. Check documentation below to see available types.Example: app.amlyze.customer.riskmanagement.kyc_scoring.completed
​
specversion
string
Cloud Events Specification version that is being used.Example: 1.0
​
source
URI-reference
RFC 3986 - Uniform Recource Identifier (URI)Event source.Example: customer
​
subject
string
Event subject represents a resource external id.Example: 82deaa92-d559-40bd-96b7-053341a08e28
​
id
string
Unique event ID.Example: 0412a5ca-3be7-46b7-87de-38366397602e
​
time
date
Event time.Example: 2019-12-13T12:01:02.694Z
​
datacontenttype
string
Data content typeExample: application/json
​
data
object
Event response. Differs on the event type.

​
Customer sanctions screening

​
app.amlyze.customer.screening.sanctions.pending

The event is fired when a human decision is needed
​
externalId
string(255)
Customer external id.Example:
{
    "externalId": "bb2274b1-6804-41f3-9e6f-81b9eb6700e3"
}

​
app.amlyze.customer.screening.sanctions.completed

The event is always fired on screening finished with resolution
​
sanctioned
boolean
Customer sanctioned or not. When a screening match is not found then this value is empty because there is no decision.
​
externalId
string(255)
Customer external id.
​
screeningMatch
boolean
An indication that the screening process found any matches
Examples: 
{
    "externalId": "bb2274b1-6804-41f3-9e6f-81b9eb6700e3",
    "screeningMatch": false
}

{
    "sanctioned": true,
    "externalId": "bb2274b1-6804-41f3-9e6f-81b9eb6700e3",
    "screeningMatch": true
}

​
Customer politically exposed person screening

​
app.amlyze.customer.screening.pep.pending

The event is fired when a human decision is needed
​
externalId
string(255)
Customer external id.Example:
{
    "externalId": "bb2274b1-6804-41f3-9e6f-81b9eb6700e3"
}

​
app.amlyze.customer.screening.pep.completed

The event is always fired on screening finished with resolution
​
pep
boolean
The customer is or is not a politically exposed person. When a screening match is not found then this value is empty because there is no decision.
​
externalId
string(255)
Customer external id.
​
screeningMatch
boolean
An indication that the screening process found any matches
Examples: 
{
    "externalId": "bb2274b1-6804-41f3-9e6f-81b9eb6700e3",
    "screeningMatch": false
}

{
    "pep": false,
    "externalId": "bb2274b1-6804-41f3-9e6f-81b9eb6700e3",
    "screeningMatch": true
}

{
    "pep": true,
    "externalId": "bb2274b1-6804-41f3-9e6f-81b9eb6700e3",
    "screeningMatch": true
}

​
Customer adverse media screening

​
app.amlyze.customer.screening.adverse_media.pending

The event is fired when a human decision is needed
​
externalId
string(255)
Customer external id.Example:
{
    "externalId": "bb2274b1-6804-41f3-9e6f-81b9eb6700e3"
}

​
app.amlyze.customer.screening.adverse_media.completed

The event is always fired on screening finished with resolution
​
inAdverseMedia
boolean
Customer found in adverse media or not. When a screening match is not found then this value is empty because there is no decision.
​
externalId
string(255)
Customer external id.
​
screeningMatch
boolean
An indication that the screening process found any matches
Examples: 
{
    "externalId": "bb2274b1-6804-41f3-9e6f-81b9eb6700e3",
    "screeningMatch": false
}

{
    "inAdverseMedia": false,
    "externalId": "bb2274b1-6804-41f3-9e6f-81b9eb6700e3",
    "screeningMatch": true
}

{
    "inAdverseMedia": true,
    "externalId": "bb2274b1-6804-41f3-9e6f-81b9eb6700e3",
    "screeningMatch": true
}

​
Customer internal list screening

​
app.amlyze.customer.screening.internal_list.pending

The event is fired when a human decision is needed
​
externalId
string(255)
Customer external id.Example:
{
    "externalId": "bb2274b1-6804-41f3-9e6f-81b9eb6700e3"
}

​
app.amlyze.customer.screening.internal_list.completed

The event is always fired on screening finished with resolution
​
inInternalList
boolean
Customer found in adverse media or not. When a screening match is not found then this value is empty because there is no decision.
​
externalId
string(255)
Customer external id.
​
screeningMatch
boolean
An indication that the screening process found any matches
Examples: 
{
    "externalId": "bb2274b1-6804-41f3-9e6f-81b9eb6700e3",
    "screeningMatch": false
}

{
    "inInternalList": false,
    "externalId": "bb2274b1-6804-41f3-9e6f-81b9eb6700e3",
    "screeningMatch": true
}

{
    "inInternalList": true,
    "externalId": "bb2274b1-6804-41f3-9e6f-81b9eb6700e3",
    "screeningMatch": true
}
The event is fired when a human decision is needed
​
customerExternalId
string(255)
External id of customer, to which related entity is related.
​
externalId
string(255)
Related entity external id.
​
birthDate
date
Related entity birth date. Applicable when entityType is INDIVIDUAL.
​
establishmentDate
date
Related entity establishment date. Applicable when entityType is ORGANIZATION.
​
type
string from enum
Related entity type.Enum class values: INDIVIDUAL, ORGANIZATION, UNKNOWN
​
firstName
string(255)
Related entity first name. Applicable when entityType is INDIVIDUAL.
​
lastName
string(255)
Related entity last name. Applicable when entityType is INDIVIDUAL.
​
title
string(255)
Related entity title.
​
nationalCode
string(50)
Related entity national code.
​
relationCode
string(255) from classifier list
Related entity relation type.
​
countryCode
string(ISO 3166-1 alpha-2) from classifier list
For Individual related entity: Citizenship country. For Organization related entity: Registration country.
Example: 
{
  "customerExternalId": "bb2274b1-6804-41f3-9e6f-81b9eb6700e3",
  "externalId": "bb2274b1-6804-41f3-9e6f-81b9eb6700o6",
  "birthDate": "1981-08-06",
  "type": "INDIVIDUAL",
  "firstName": "John",
  "lastName": "Doe",
  "nationalCode": "32108068863",
  "relationCode": "OWNER",
  "countryCode": "LT"
}
The event is always fired on screening finished with resolution
​
sanctioned
boolean
Related entity sanctioned or not. When a screening match is not found then this value is empty because there is no decision.
​
customerExternalId
string(255)
External id of customer, to which related entity is related.
​
externalId
string(255)
Related entity external id.
​
birthDate
date
Related entity birth date. Applicable when entityType is INDIVIDUAL.
​
establishmentDate
date
Related entity establishment date. Applicable when entityType is ORGANIZATION.
​
type
string from enum
Related entity type.Enum class values: INDIVIDUAL, ORGANIZATION, UNKNOWN
​
firstName
string(255)
Related entity first name. Applicable when entityType is INDIVIDUAL.
​
lastName
string(255)
Related entity last name. Applicable when entityType is INDIVIDUAL.
​
title
string(255)
Related entity title.
​
nationalCode
string(50)
Related entity national code.
​
relationCode
string(255) from classifier list
Related entity relation type.
​
countryCode
string(ISO 3166-1 alpha-2) from classifier list
For Individual related entity: Citizenship country. For Organization related entity: Registration country.
​
screeningMatch
boolean
An indication that the screening process found any matches.
Examples: 
{
  "customerExternalId": "bb2274b1-6804-41f3-9e6f-81b9eb6700e3",
  "externalId": "bb2274b1-6804-41f3-9e6f-81b9eb6700o6",
  "birthDate": "1981-08-06",
  "type": "INDIVIDUAL",
  "firstName": "John",
  "lastName": "Doe",
  "nationalCode": "32108068863",
  "relationCode": "OWNER",
  "countryCode": "LT",
  "screeningMatch": false
}

{
  "sanctioned": false,
  "customerExternalId": "bb2274b1-6804-41f3-9e6f-81b9eb6700e3",
  "type": "INDIVIDUAL",
  "firstName": "John",
  "lastName": "Doe",
  "title": "John Doe",
  "nationalCode": "32108068863",
  "relationCode": "OWNER",
  "countryCode": "LT",
  "screeningMatch": true
}

{
  "sanctioned": true,
  "customerExternalId": "bb2274b1-6804-41f3-9e6f-81b9eb6700e3",
  "type": "INDIVIDUAL",
  "firstName": "John",
  "lastName": "Doe",
  "title": "John Doe",
  "nationalCode": "32108068863",
  "relationCode": "OWNER",
  "countryCode": "LT",
  "screeningMatch": true
}

​
Realted entity politically exposed person screening

The event is fired when a human decision is needed
​
customerExternalId
string(255)
External id of customer, to which related entity is related.
​
externalId
string(255)
Related entity external id.
​
birthDate
date
Related entity birth date. Applicable when entityType is INDIVIDUAL.
​
establishmentDate
date
Related entity establishment date. Applicable when entityType is ORGANIZATION.
​
type
string from enum
Related entity type.Enum class values: INDIVIDUAL, ORGANIZATION, UNKNOWN
​
firstName
string(255)
Related entity first name. Applicable when entityType is INDIVIDUAL.
​
lastName
string(255)
Related entity last name. Applicable when entityType is INDIVIDUAL.
​
title
string(255)
Related entity title.
​
nationalCode
string(50)
Related entity national code.
​
relationCode
string(255) from classifier list
Related entity relation type.
​
countryCode
string(ISO 3166-1 alpha-2) from classifier list
For Individual related entity: Citizenship country. For Organization related entity: Registration country.
Example: 
{
  "customerExternalId": "bb2274b1-6804-41f3-9e6f-81b9eb6700e3",
  "externalId": "bb2274b1-6804-41f3-9e6f-81b9eb6700o6",
  "birthDate": "1981-08-06",
  "type": "INDIVIDUAL",
  "firstName": "John",
  "lastName": "Doe",
  "nationalCode": "32108068863",
  "relationCode": "OWNER",
  "countryCode": "LT"
}
The event is always fired on screening finished with resolution
​
pep
boolean
Related entity pep or not. When a screening match is not found then this value is empty because there is no decision.
​
customerExternalId
string(255)
External id of customer, to which related entity is related.
​
externalId
string(255)
Related entity external id.
​
birthDate
date
Related entity birth date. Applicable when entityType is INDIVIDUAL.
​
establishmentDate
date
Related entity establishment date. Applicable when entityType is ORGANIZATION.
​
type
string from enum
Related entity type.Enum class values: INDIVIDUAL, ORGANIZATION, UNKNOWN
​
firstName
string(255)
Related entity first name. Applicable when entityType is INDIVIDUAL.
​
lastName
string(255)
Related entity last name. Applicable when entityType is INDIVIDUAL.
​
title
string(255)
Related entity title.
​
nationalCode
string(50)
Related entity national code.
​
relationCode
string(255) from classifier list
Related entity relation type.
​
countryCode
string(ISO 3166-1 alpha-2) from classifier list
For Individual related entity: Citizenship country. For Organization related entity: Registration country.
​
screeningMatch
boolean
An indication that the screening process found any matches.
Examples: 
{
  "customerExternalId": "bb2274b1-6804-41f3-9e6f-81b9eb6700e3",
  "externalId": "bb2274b1-6804-41f3-9e6f-81b9eb6700o6",
  "birthDate": "1981-08-06",
  "type": "INDIVIDUAL",
  "firstName": "John",
  "lastName": "Doe",
  "nationalCode": "32108068863",
  "relationCode": "OWNER",
  "countryCode": "LT",
  "screeningMatch": false
}

{
  "pep": false,
  "customerExternalId": "bb2274b1-6804-41f3-9e6f-81b9eb6700e3",
  "type": "INDIVIDUAL",
  "firstName": "John",
  "lastName": "Doe",
  "title": "John Doe",
  "nationalCode": "32108068863",
  "relationCode": "OWNER",
  "countryCode": "LT",
  "screeningMatch": true
}

{
  "pep": true,
  "customerExternalId": "bb2274b1-6804-41f3-9e6f-81b9eb6700e3",
  "type": "INDIVIDUAL",
  "firstName": "John",
  "lastName": "Doe",
  "title": "John Doe",
  "nationalCode": "32108068863",
  "relationCode": "OWNER",
  "countryCode": "LT",
  "screeningMatch": true
}
The event is fired when a human decision is needed
​
customerExternalId
string(255)
External id of customer, to which related entity is related.
​
externalId
string(255)
Related entity external id.
​
birthDate
date
Related entity birth date. Applicable when entityType is INDIVIDUAL.
​
establishmentDate
date
Related entity establishment date. Applicable when entityType is ORGANIZATION.
​
type
string from enum
Related entity type.Enum class values: INDIVIDUAL, ORGANIZATION, UNKNOWN
​
firstName
string(255)
Related entity first name. Applicable when entityType is INDIVIDUAL.
​
lastName
string(255)
Related entity last name. Applicable when entityType is INDIVIDUAL.
​
title
string(255)
Related entity title.
​
nationalCode
string(50)
Related entity national code.
​
relationCode
string(255) from classifier list
Related entity relation type.
​
countryCode
string(ISO 3166-1 alpha-2) from classifier list
For Individual related entity: Citizenship country. For Organization related entity: Registration country.
Example: 
{
  "customerExternalId": "bb2274b1-6804-41f3-9e6f-81b9eb6700e3",
  "externalId": "bb2274b1-6804-41f3-9e6f-81b9eb6700o6",
  "birthDate": "1981-08-06",
  "type": "INDIVIDUAL",
  "firstName": "John",
  "lastName": "Doe",
  "nationalCode": "32108068863",
  "relationCode": "OWNER",
  "countryCode": "LT"
}
The event is always fired on screening finished with resolution
​
inAdverseMedia
boolean
Related entity in adverse media or not. When a screening match is not found then this value is empty because there is no decision.
​
customerExternalId
string(255)
External id of customer, to which related entity is related.
​
externalId
string(255)
Related entity external id.
​
birthDate
date
Related entity birth date. Applicable when entityType is INDIVIDUAL.
​
establishmentDate
date
Related entity establishment date. Applicable when entityType is ORGANIZATION.
​
type
string from enum
Related entity type.Enum class values: INDIVIDUAL, ORGANIZATION, UNKNOWN
​
firstName
string(255)
Related entity first name. Applicable when entityType is INDIVIDUAL.
​
lastName
string(255)
Related entity last name. Applicable when entityType is INDIVIDUAL.
​
title
string(255)
Related entity title.
​
nationalCode
string(50)
Related entity national code.
​
relationCode
string(255) from classifier list
Related entity relation type.
​
countryCode
string(ISO 3166-1 alpha-2) from classifier list
For Individual related entity: Citizenship country. For Organization related entity: Registration country.
​
screeningMatch
boolean
An indication that the screening process found any matches.
Examples: 
{
  "customerExternalId": "bb2274b1-6804-41f3-9e6f-81b9eb6700e3",
  "externalId": "bb2274b1-6804-41f3-9e6f-81b9eb6700o6",
  "birthDate": "1981-08-06",
  "type": "INDIVIDUAL",
  "firstName": "John",
  "lastName": "Doe",
  "nationalCode": "32108068863",
  "relationCode": "OWNER",
  "countryCode": "LT",
  "screeningMatch": false
}

{
  "inAdverseMedia": false,
  "customerExternalId": "bb2274b1-6804-41f3-9e6f-81b9eb6700e3",
  "type": "INDIVIDUAL",
  "firstName": "John",
  "lastName": "Doe",
  "title": "John Doe",
  "nationalCode": "32108068863",
  "relationCode": "OWNER",
  "countryCode": "LT",
  "screeningMatch": true
}

{
  "inAdverseMedia": true,
  "customerExternalId": "bb2274b1-6804-41f3-9e6f-81b9eb6700e3",
  "type": "INDIVIDUAL",
  "firstName": "John",
  "lastName": "Doe",
  "title": "John Doe",
  "nationalCode": "32108068863",
  "relationCode": "OWNER",
  "countryCode": "LT",
  "screeningMatch": true
}
The event is fired when a human decision is needed
​
customerExternalId
string(255)
External id of customer, to which related entity is related.
​
externalId
string(255)
Related entity external id.
​
birthDate
date
Related entity birth date. Applicable when entityType is INDIVIDUAL.
​
establishmentDate
date
Related entity establishment date. Applicable when entityType is ORGANIZATION.
​
type
string from enum
Related entity type.Enum class values: INDIVIDUAL, ORGANIZATION, UNKNOWN
​
firstName
string(255)
Related entity first name. Applicable when entityType is INDIVIDUAL.
​
lastName
string(255)
Related entity last name. Applicable when entityType is INDIVIDUAL.
​
title
string(255)
Related entity title.
​
nationalCode
string(50)
Related entity national code.
​
relationCode
string(255) from classifier list
Related entity relation type.
​
countryCode
string(ISO 3166-1 alpha-2) from classifier list
For Individual related entity: Citizenship country. For Organization related entity: Registration country.
Example: 
{
  "customerExternalId": "bb2274b1-6804-41f3-9e6f-81b9eb6700e3",
  "externalId": "bb2274b1-6804-41f3-9e6f-81b9eb6700o6",
  "birthDate": "1981-08-06",
  "type": "INDIVIDUAL",
  "firstName": "John",
  "lastName": "Doe",
  "nationalCode": "32108068863",
  "relationCode": "OWNER",
  "countryCode": "LT"
}
The event is always fired on screening finished with resolution
​
inInternalList
boolean
Related entity in internal list or not. When a screening match is not found then this value is empty because there is no decision.
​
customerExternalId
string(255)
External id of customer, to which related entity is related.
​
externalId
string(255)
Related entity external id.
​
birthDate
date
Related entity birth date. Applicable when entityType is INDIVIDUAL.
​
establishmentDate
date
Related entity establishment date. Applicable when entityType is ORGANIZATION.
​
type
string from enum
Related entity type.Enum class values: INDIVIDUAL, ORGANIZATION, UNKNOWN
​
firstName
string(255)
Related entity first name. Applicable when entityType is INDIVIDUAL.
​
lastName
string(255)
Related entity last name. Applicable when entityType is INDIVIDUAL.
​
title
string(255)
Related entity title.
​
nationalCode
string(50)
Related entity national code.
​
relationCode
string(255) from classifier list
Related entity relation type.
​
countryCode
string(ISO 3166-1 alpha-2) from classifier list
For Individual related entity: Citizenship country. For Organization related entity: Registration country.
​
screeningMatch
boolean
An indication that the screening process found any matches.
Examples: 
{
  "customerExternalId": "bb2274b1-6804-41f3-9e6f-81b9eb6700e3",
  "externalId": "bb2274b1-6804-41f3-9e6f-81b9eb6700o6",
  "birthDate": "1981-08-06",
  "type": "INDIVIDUAL",
  "firstName": "John",
  "lastName": "Doe",
  "nationalCode": "32108068863",
  "relationCode": "OWNER",
  "countryCode": "LT",
  "screeningMatch": false
}

{
  "inInternalList": false,
  "customerExternalId": "bb2274b1-6804-41f3-9e6f-81b9eb6700e3",
  "type": "INDIVIDUAL",
  "firstName": "John",
  "lastName": "Doe",
  "title": "John Doe",
  "nationalCode": "32108068863",
  "relationCode": "OWNER",
  "countryCode": "LT",
  "screeningMatch": true
}

{
  "inInternalList": true,
  "customerExternalId": "bb2274b1-6804-41f3-9e6f-81b9eb6700e3",
  "type": "INDIVIDUAL",
  "firstName": "John",
  "lastName": "Doe",
  "title": "John Doe",
  "nationalCode": "32108068863",
  "relationCode": "OWNER",
  "countryCode": "LT",
  "screeningMatch": true
}