API Reference
Search…
Webhooks
Use the features of ComplyCube Webhooks to set up real-time notifications.
ComplyCube uses webhooks to notify your application when an event happens in your account. Webhooks are particularly useful for asynchronous events like when a check has concluded.
You can configure webhook endpoints via the API or the Web Portal to be notified about events that happen in your ComplyCube account and related resources.
Upon receiving a webhook notification, you should acknowledge success by responding with an HTTP 20x response within 15 seconds. Otherwise, we will attempt to resend the notification up to 10 times according to an exponential back-off schedule.
The first attempt will be made 60 seconds after the initial attempt; the second attempt will be made 120 seconds later; the third attempt will be made 480 seconds later, and so forth until all 10 attempts are exhausted. After which, the corresponding webhook will be disabled.
You can quickly inspect webhook events with temporary endpoint URLs using free hosted services such as https://webhook.site.

The Webhook object

Attribute
Type
Description
id
string
The unique identifier for the webhook.
description
string
A description of what the webhook is used for.
url
string
The URL of the webhook endpoint - must be HTTPS.
enabled
boolean
Determines if the webhook should be active.
events
array[string]
The list of event types enabled for this webhook. ["*"] indicates that all events will be published.
secret
string
The endpoint’s secret used to generate webhook signatures. Only returned at creation.
createdAt
string
The date and time when the webhook was created.
updatedAt
string
The date and time when the webhook was updated.

Event Types

Event
Description
check.pending
A check has been created and is in pending state.
check.complete
A check has completed with any outcome.
check.complete.clear
A check has completed with clear outcome.
check.complete.attention
A check has completed with attention outcome.
check.monitoring.attention
A monitoring check has completed with attention outcome.
check.failed
A check has failed.
check.updated
A check has been updated.
client.created
A client has been created.
client.updated
A client has been updated.
client.deleted
A client has been deleted.
document.created
A document has been created.
document.updated
A document has been updated.
document.updated.image_uploaded
A document has been updated with a new image.
document.updated.image_deleted
A document has been updated as an image has been deleted.
document.deleted
A document has been deleted.
address.created
An address has been created.
address.updated
An address has been updated.
address.deleted
An address has been deleted.

The Event Object

Attributes
Sample Object
Attribute
Type
Description
id
string
The unique identifier for the event, which a webhook listener can use to bypass notification processing on a webhook notification sent more than once.
type
string
The event type that initiated the event.
resourceType
string
The type of the object contained within the payload, e.g. check object.
payload
object
The key attributes of the object associated with this event. Also, see the payload by resource type table below.
createdAt
string
The date and time when the webhook was created.
1
{
2
"id": "5ed170fe99c81a0007b9a3d3",
3
"type": "check.completed.clear",
4
"resourceType": "check",
5
"payload": {
6
"id": "5ed3918fbf06f30008e552c9",
7
"outcome": "clear",
8
"status": "complete",
9
"createdAt": "2020-01-01T11:14:23.964Z",
10
"updatedAt": "2020-01-01T11:14:23.964Z"
11
},
12
"createdAt": "2020-01-01T11:14:23.964Z"
13
}
Copied!

Payload by resource type

Types
Payload
  • On create: the full object of the corresponding resource.
  • On update: id of the object along with updated fields.
  • On delete: id of the deleted object.
  • On create: the full object of the corresponding resource.
  • On update: id of the object along with updated fields.
  • On other events:
    • id: The unique identifier for the check.
    • status: The status of the check.
    • outcome: The outcome of the check. Only returned when the status is complete.
    • createdAt: The date and time when the check was created.
    • updatedAt: The date and time when the check was updated.