Skip to main content
We use Cloud Events (v1.0.2) standard to deliver information asynchronously via HTTP Protocol Binding about requests made to the Amlyze API. You can find more information about the Cloud Events specs in their GitHub repository. It is also possible to use one of the official SDKs to speed up integration with our system.

​
Event Structure

Events from Amlyze are delivered using Binary Content Mode. This means that identifications about object and event type are passed via HTTP header. Those headers, based on specification, have a ce- prefix. Passing information in such way, allows identifying information prior parsing the body, thus allowing more dynamic handling for the incoming events.

​
Header Mapping

Cloud Event HTTP HeaderCorrelation With Amlyze
ce-idUnique event ID. Unique per event.
ce-sourceEvent Source. RFC 3986 - Uniform Resource Identifier (URI). In most cases returns value from communicationNumber.
ce-specversionCloud Events Specification version. Currently - 1.0.
ce-subjectEvent subject, represents a resource’s (customer, related entity, operation) external id.
ce-timeEvent time.
ce-typeUnique event type.
Here is an example of an event with headers: 
ce-id: 019cd7cf-826c-731c-ba20-76f48d48ac9c
ce-source: cef8654f-9885-4e61-b8e9-132b607ab6a4
ce-specversion: 1.0
ce-subject: dea0bcc0-52d2-4f82-bc46-6f87288939b5
ce-time: 2026-03-10t12:53:45.85z
ce-type: app.amlyze.related_entity.screening.sanctions.pending
content-length: 306
content-type: application/json

{
  "customerExternalId": "78395a1c-272b-4263-ab9a-be5fe24055c5",
  "externalId": "dea0bcc0-52d2-4f82-bc46-6f87288939b5",
  "establishmentDate": "1998-04-07",
  "type": "ORGANIZATION",
  "title": "Sputnik",
  "nationalCode": "554555447884557",
  "relationCode": "OWNER",
  "countryCode": "RU",
  "screeningMatch": true,
  "screeningGuid": "20642e48-8251-47e3-a363-d857343ee171"
}

​
Delivery Confirmation

Your server should respond with a 2xx status to acknowledge receipt of the webhook. All other status codes are treated as an error and their delivery is repeated.