Request Format | Parallel Developer Documentation

Parallel Developer Documentation Legacy – v1.x

This is documentation for Parallel Developer Documentation Legacy – v1.x, which is no longer actively maintained.

For up-to-date documentation, see the latest version (Current – v2.x).

Version: Legacy – v1.x

Webhook POST Request Structure

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

event - String - See below for each supported event type
entity - Object - Contains id and type keys. See Profile API for context and information.
scope - String - See the list of scopes for possible values.
connecting_business_id - String - (provided only for the identity scope webhook calls) This is the ID of a business which granted access to its information via OAuth2.

Webhooks for each scope have their own set of possible values for the event property of the JSON body.

Accreditation Status

The accreditation events are triggered in the following cases:

When there is a change in status of an accreditation application based on the outcome of an application review. I.e. the accreditation application has been approved or rejected.
- Note: Accreditation applications that have been previously approved based on an income assertion type will automatically be re-certified when the previous accreditation expires.
When an accreditation application is cancelled.
For any access revocation requests triggered by the subject or the partner.

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.

Here's an example body for an accreditation data_update event:

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

Identity

There are two types of events for the identity scope webhooks: the general data_update event for completed identity information submissions, and risk monitor match events each of which have their own event name:

Event	Description
`data_update`	Indicates that a new identity information has been submitted for the entity
`access_revocation_scheduled`	Indicates that access revocation has been scheduled and API access will expire after a period of time.
`adverse_media_risk_monitor_match`	The entity appears as a possible match in monitored media sources.
`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.

Here's an example body for an identity currently_sanctioned_risk_monitor_match event:

{
  "entity": {
    "id": "VXNlcjox",
    "type": "individual"
  },
  "event": "currently_sanctioned_risk_monitor_match",
  "scope": "identity",
  "connecting_business_id": "QnVzaW5lc3M6NTAw"
}