Envelope
Unique event type. Check documentation below to see available types.Example: app.amlyze.customer.riskmanagement.kyc_scoring.completed
Event source - request ID (communication number).Example: 893af30c-7dda-44b2-bf98-476da6ca4326
Event subject represents a resource external id.Example: extId
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.
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
Customer sanctioned or not.
When a screening match is not found then this value is empty because there is no decision.
An indication that the screening process found any matches
Examples:
{
"externalId": "bb2274b1-6804-41f3-9e6f-81b9eb6700e3",
"screeningMatch": false
}
{
"sanctioned": false,
"externalId": "bb2274b1-6804-41f3-9e6f-81b9eb6700e3",
"screeningMatch": true
}
{
"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
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
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.
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
}
The event is fired when a human decision is needed
Customer external id.Example:{
"externalId": "bb2274b1-6804-41f3-9e6f-81b9eb6700e3"
}
The event is always fired on screening finished with resolution
Customer found in adverse media or not.
When a screening match is not found then this value is empty because there is no decision.
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
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
Customer found in adverse media or not.
When a screening match is not found then this value is empty because there is no decision.
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
External id of customer, to which related entity is related.
Related entity external id.
Related entity birth date. Applicable when entityType
is INDIVIDUAL
.
Related entity establishment date. Applicable when entityType
is ORGANIZATION
.
Related entity type.Enum class values: INDIVIDUAL
, ORGANIZATION
, UNKNOWN
Related entity first name. Applicable when entityType
is INDIVIDUAL
.
Related entity last name. Applicable when entityType
is INDIVIDUAL
.
Related entity national code.
relationCode
string from classifier list
Related entity relation type.Show Path to extract classifier values
HTTP Method: GET
Path: {{baseUrl}}
/classifier/relationType
countryCode
string from classifier list
For Individual related entity:
Citizenship country.
For Organization related entity:
Registration country.Show Path to extract classifier values
HTTP Method: GET
Path: {{baseUrl}}
/classifier/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
Related entity sanctioned or not.
When a screening match is not found then this value is empty because there is no decision.
External id of customer, to which related entity is related.
Related entity external id.
Related entity birth date. Applicable when entityType
is INDIVIDUAL
.
Related entity establishment date. Applicable when entityType
is ORGANIZATION
.
Related entity type.Enum class values: INDIVIDUAL
, ORGANIZATION
, UNKNOWN
Related entity first name. Applicable when entityType
is INDIVIDUAL
.
Related entity last name. Applicable when entityType
is INDIVIDUAL
.
Related entity national code.
relationCode
string from classifier list
Related entity relation type.Show Path to extract classifier values
HTTP Method: GET
Path: {{baseUrl}}
/classifier/relationType
countryCode
string from classifier list
For Individual related entity:
Citizenship country.
For Organization related entity:
Registration country.Show Path to extract classifier values
HTTP Method: GET
Path: {{baseUrl}}
/classifier/country
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
External id of customer, to which related entity is related.
Related entity external id.
Related entity birth date. Applicable when entityType
is INDIVIDUAL
.
Related entity establishment date. Applicable when entityType
is ORGANIZATION
.
Related entity type.Enum class values: INDIVIDUAL
, ORGANIZATION
, UNKNOWN
Related entity first name. Applicable when entityType
is INDIVIDUAL
.
Related entity last name. Applicable when entityType
is INDIVIDUAL
.
Related entity national code.
relationCode
string from classifier list
Related entity relation type.Show Path to extract classifier values
HTTP Method: GET
Path: {{baseUrl}}
/classifier/relationType
countryCode
string from classifier list
For Individual related entity:
Citizenship country.
For Organization related entity:
Registration country.Show Path to extract classifier values
HTTP Method: GET
Path: {{baseUrl}}
/classifier/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
Related entity pep or not.
When a screening match is not found then this value is empty because there is no decision.
External id of customer, to which related entity is related.
Related entity external id.
Related entity birth date. Applicable when entityType
is INDIVIDUAL
.
Related entity establishment date. Applicable when entityType
is ORGANIZATION
.
Related entity type.Enum class values: INDIVIDUAL
, ORGANIZATION
, UNKNOWN
Related entity first name. Applicable when entityType
is INDIVIDUAL
.
Related entity last name. Applicable when entityType
is INDIVIDUAL
.
Related entity national code.
relationCode
string from classifier list
Related entity relation type.Show Path to extract classifier values
HTTP Method: GET
Path: {{baseUrl}}
/classifier/relationType
countryCode
string from classifier list
For Individual related entity:
Citizenship country.
For Organization related entity:
Registration country.Show Path to extract classifier values
HTTP Method: GET
Path: {{baseUrl}}
/classifier/country
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
External id of customer, to which related entity is related.
Related entity external id.
Related entity birth date. Applicable when entityType
is INDIVIDUAL
.
Related entity establishment date. Applicable when entityType
is ORGANIZATION
.
Related entity type.Enum class values: INDIVIDUAL
, ORGANIZATION
, UNKNOWN
Related entity first name. Applicable when entityType
is INDIVIDUAL
.
Related entity last name. Applicable when entityType
is INDIVIDUAL
.
Related entity national code.
relationCode
string from classifier list
Related entity relation type.Show Path to extract classifier values
HTTP Method: GET
Path: {{baseUrl}}
/classifier/relationType
countryCode
string from classifier list
For Individual related entity:
Citizenship country.
For Organization related entity:
Registration country.Show Path to extract classifier values
HTTP Method: GET
Path: {{baseUrl}}
/classifier/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
Related entity in adverse media or not.
When a screening match is not found then this value is empty because there is no decision.
External id of customer, to which related entity is related.
Related entity external id.
Related entity birth date. Applicable when entityType
is INDIVIDUAL
.
Related entity establishment date. Applicable when entityType
is ORGANIZATION
.
Related entity type.Enum class values: INDIVIDUAL
, ORGANIZATION
, UNKNOWN
Related entity first name. Applicable when entityType
is INDIVIDUAL
.
Related entity last name. Applicable when entityType
is INDIVIDUAL
.
Related entity national code.
relationCode
string from classifier list
Related entity relation type.Show Path to extract classifier values
HTTP Method: GET
Path: {{baseUrl}}
/classifier/relationType
countryCode
string from classifier list
For Individual related entity:
Citizenship country.
For Organization related entity:
Registration country.Show Path to extract classifier values
HTTP Method: GET
Path: {{baseUrl}}
/classifier/country
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
External id of customer, to which related entity is related.
Related entity external id.
Related entity birth date. Applicable when entityType
is INDIVIDUAL
.
Related entity establishment date. Applicable when entityType
is ORGANIZATION
.
Related entity type.Enum class values: INDIVIDUAL
, ORGANIZATION
, UNKNOWN
Related entity first name. Applicable when entityType
is INDIVIDUAL
.
Related entity last name. Applicable when entityType
is INDIVIDUAL
.
Related entity national code.
relationCode
string from classifier list
Related entity relation type.Show Path to extract classifier values
HTTP Method: GET
Path: {{baseUrl}}
/classifier/relationType
countryCode
string from classifier list
For Individual related entity:
Citizenship country.
For Organization related entity:
Registration country.Show Path to extract classifier values
HTTP Method: GET
Path: {{baseUrl}}
/classifier/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
Related entity in internal list or not.
When a screening match is not found then this value is empty because there is no decision.
External id of customer, to which related entity is related.
Related entity external id.
Related entity birth date. Applicable when entityType
is INDIVIDUAL
.
Related entity establishment date. Applicable when entityType
is ORGANIZATION
.
Related entity type.Enum class values: INDIVIDUAL
, ORGANIZATION
, UNKNOWN
Related entity first name. Applicable when entityType
is INDIVIDUAL
.
Related entity last name. Applicable when entityType
is INDIVIDUAL
.
Related entity national code.
relationCode
string from classifier list
Related entity relation type.Show Path to extract classifier values
HTTP Method: GET
Path: {{baseUrl}}
/classifier/relationType
countryCode
string from classifier list
For Individual related entity:
Citizenship country.
For Organization related entity:
Registration country.Show Path to extract classifier values
HTTP Method: GET
Path: {{baseUrl}}
/classifier/country
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
}