Webhook Events | Parallel Developer Documentation

Parallel Developer Documentation Next 🚧

Version: Next 🚧

The body of every webhook POST request

The body of every webhook POST request will be a JSON object with the following properties:

Attribute	Type	Description
`event`	`String`	The specific event this payload is associated with. See below for each supported event type.
`entity`	`Object`	The entity this event is related to. The `entity` object will contain two keys: - `id`: The ID of the specific individual or business record this event is associated with. - `type`: The type of entity this payload is associated with. Either `individual` or `business`.
`scope`	`String`	What scope this event is related to. Note: Case Management Record Events will have a `scope` of `null`.

Example Payload

{
  "entity": {
    "id": "VXNlcjox",
    "type": "individual"
  },
  "event": "data_update",
  "scope": "accreditation_status"
}

Accreditation Status Events

scope: accreditation_status

The accreditation events are triggered in the following cases:

When a new accreditation application is submitted
When there is a change in status of an accreditation application based on the outcome of an application review (i.e., when the accreditation application has been approved or rejected)
When an accreditation application is cancelled
When a previous accreditation expires
For any access revocation requests triggered by the subject or the partner
If an individual or business says that they cannot meet the requirements for accreditation and cannot submit an application. See the indicated_unaccredited_at field on the Individual Record Details and Business Record Details objects returned by the Records API.

Event	Description
`data_update`	Indicates that there is a change in an entity's accreditation status
`access_revocation_scheduled`	Indicates that access revocation has been scheduled and API access will expire after a period of time. You can use the Case Management API to get the access expiration details such as expiration date.

Example Payload

{
  "entity": {
    "id": "VXNlcjox",
    "type": "individual"
  },
  "event": "data_update",
  "scope": "accreditation_status"
}

Identity Events

These identity events are triggered for any new identity data submitted by the subject. Additionally, an event is triggered for any access revocation requests.

scope: identity

Event	Description
`data_update`	Indicates that a new identity information has been submitted for the entity
`access_revocation_scheduled`	Indicates that access revocation to ongoing user/business updates has been scheduled. You can use the Case Management API to get the access expiration details such as expiration date.

Example Payload

{
  "entity": {
    "id": "VXNlcjox",
    "type": "individual"
  },
  "event": "data_update",
  "scope": "identity"
}

Risk Monitoring Events

Risk monitoring events are triggered based on updates due to any new or updated risk matches.

scope: identity

Event	Description
`adverse_media_risk_monitor_match`	The entity appears as a possible match in monitored media sources linking it to serious crime (e.g. fraud, money laundering, terrorism, etc.)
`currently_sanctioned_risk_monitor_match`	The entity appears as a possible match in any monitored sanctions datasets
`disqualified_director_risk_monitor_match`	The entity appears as a possible match in any monitored disqualified directors datasets
`financial_regulator_risk_monitor_match`	The entity appears as a possible match in any monitored financial regulator datasets
`insolvent_risk_monitor_match`	The entity appears as a possible match in any monitored insolvency datasets
`law_enforcement_risk_monitor_match`	The entity appears as a possible match in any monitored law enforcement datasets
`pep_risk_monitor_match`	The entity is possibly considered a Politically Exposed Person
`risk_monitor_match_resolved`	A specific risk match has been resolved.
`risk_monitoring_screen_complete`	Risk monitoring screening has been setup and the initial screen has completed for the record's current data entry. Records will be monitored for future risk monitor matches from this point onwards. This event may be triggered again for the same record if there are future updates to certain pieces of information in the record (e.g. first name, last name, business name).

Example Payload

{
  "entity": {
    "id": "VXNlcjox",
    "type": "individual"
  },
  "event": "risk_monitor_match_resolved",
  "scope": "identity"
}

Case Management Record Events

Case Management events are triggered based on specific updates to a Case Management Record.

scope: null

Event	Description
`record_status_change`	The record's status has changed. For example, if the status of the record is changed from `open` to `approved`.
`record_archived`	The record has been archived.
`record_unarchived`	The record has been unarchived.

Example Payload

{
  "entity": {
    "id": "VXNlcjox",
    "type": "individual"
  },
  "event": "record_status_change",
  "scope": null
}