Webhooks for DVFC (Alpha)

⚠️ Alpha: Please note webhooks are in an early stage of development and are subject to change.

Purpose

Our DVFC Alert webhooks have been created to trigger a webhook whenever an Alert is generated from our verification system. This will enable you to utilise any downstream automation like updates to ongoing verification checks.

Getting Set Up

W2 Webhooks are an important new feature of our Document Verification & Facial Recognition, in order to make use of them you will need to ensure:

You are using W2's DVFC 047 system.
You have informed us of the callback URL you are listening on.

To establish either of these you can reach out to our Support team who can help you get started.

Sample Payload

The W2 webhook consists of an HTTP POST call with an application/JSON payload.

json

{
  "identificationprocess": {
    "result": "FRAUD_SUSPICION_CONFIRMED",
    "reason": "USER_CANCELLATION",
    "identificationtime": "2019-06-06T09:34:10+02:00",
    "type": "APP",
    "sessionId": "00eb2d04-1e98-44eb-a5d8-bbcfc1c536d7"
  },
  "customdata": {
    "custom3": "can set testbot scenarios",
    "custom4": "or store any data strings",
    "custom1": "",
    "custom2": "Custom fields",
    "custom5": "you like."
  },
  "contactdata": {
    "mobilephone": "+441789012345",
    "email": "[email protected]"
  },
  "userdata": {
    "birthday": {
      "status": "CHANGE",
      "value": "1981-10-17",
      "original": "1987-05-23"
    },
    "firstname": {
      "status": "CHANGE",
      "value": "SAMUEL",
      "original": "OLIVIA"
    },
    "address": {
      "zipcode": {
        "status": "MATCH",
        "value": "W1U"
      },
      "country": {
        "status": "MATCH",
        "value": "GB"
      },
      "city": {
        "status": "CHANGE",
        "value": "MUNICH",
        "original": "LONDON"
      },
      "street": {
        "status": "CHANGE",
        "value": "PRINZREGSTR.",
        "original": "BAKER STREET"
      }
    },
    "birthplace": {
      "status": "CHANGE",
      "value": "UTOPIA CITY",
      "original": "LONDON"
    },
    "nationality": {
      "status": "CHANGE",
      "value": "AQ",
      "original": "GB"
    },
    "gender": {
      "status": "CHANGE",
      "value": "MALE",
      "original": "FEMALE"
    },
    "identlanguage": {
      "status": "MATCH",
      "value": "en"
    },
    "lastname": {
      "status": "CHANGE",
      "value": "JOHNSON",
      "original": "JONES"
    }
  },
  "identificationdocument": {
    "country": {
      "status": "NEW",
      "value": "AQ"
    },
    "number": {
      "status": "NEW",
      "value": "LGPJ11235"
    },
    "type": {
      "status": "NEW",
      "value": "IDCARD"
    },
    "validuntil": {
      "status": "NEW",
      "value": "2024-10-16"
    }
  }
}

Field Breakdown

1. Identification Process

Property	Notes
Result	The outcome of the identification verification process. Look below for an explanation of all potential results returned.
Reason	If a fraud attempt is reported, this field will hold the fraud reason that has been detected otherwise it will hold validation reasoning as to why the verification session failed.
Type	The type of process used to carry out identification. (i.e. Phone, Web, etc.)
SessionId	The identifier passed by you when creating an identification.

1.1 Result Types

There are two types of result, the first being preliminary which is the status of the identification before its been reviewed and final type means that the identification process has finished and a result has been returned.

Property	Type	Description
In Progress	Preliminary	Session has been created but no data has been submitted.
Review Pending	Preliminary	The verification session has been finished successfully and the result is now waiting for review.
Check Pending	Preliminary	The verification session is still being checked and could not be checked automatically.
Fraud Suspicion Pending	Preliminary	The verification session has finished but a fraud suspicion arose during the process.
Fraud Suspcion Confirmed	Final	Suspicion that the user tried to commit fraud.
Success	Final	The verification has been performed without problems or changed data.
Sucess Data Changed	Final	The verification has been performed without any problems, but data has been changed compared to what was previously provided.
Cancelled	Final	The verification has been cancelled by the internally due to the incorrectly performed identification by the user.
Expired	Final	Current verification session has expired and needs to be renewed
Unknown	Final	Verification session status returned was not recognised.

1.2 Reasons

Below you will find a table of potential reasons why a verification session may have been failed or cancelled.

Property	Result	Description
ID BLURRY	Cancelled	Document is blurry and mandatory data cannot be read due to the blur.
ID GLARE	Cancelled	Document has glare and mandatory data cannot be read due to the glare.
ID DARKNESS	Cancelled	Pictures of the document are dark and it is not possible to read the mandatory data or verify the authenticity of the document.
ID DATA COVERED	Cancelled	Mandatory data is covered by the user while taking the picture.
ID PERSPECTIVE	Cancelled	Document is positioned at such an angle that mandatory data cannot be read or document cannot be verified.
ID DATA OTHER	Cancelled	Any other reason due to which mandatory data cannot be read.

For the full list of potential reasons Click here

2. Custom Data

Property	Description
Custom1	The Client Reference provided.
Custom2, Custom3, Custom4, Custom5	Fields for any additional information.

3. Contact Data

Property	Description
MobilePhone	The individuals mobile phone number.
Email	The individuals email address.

4. User Data

Property	Description
Birthday	The individuals date of birth.
Firstname	The Forename of the individual.
Address	The individuals address.
Birthplace	The place of birth of the Individual.
Nationality	The individuals legal identification of sovereign state.
Gender	The Gender of the individual.
IdentLanguage	Uppercase two-letter code as defined in ISO 3166.
Lastname	The last name of the individual.

4.1 Address Properties

Property	Description
Zipcode	Unique code used for identifying addresses.
Country	Uppercase two-letter code as defined in ISO 3166.
City	The City of the individual.
Street	The Street of the individual.

5. Identification Document

Property	Description
Country	Uppercase two-letter code as defined in ISO 3166.
Number	The ID number.
Type	The type of ID document used by the user. (i.e. Drivers License, Passport, Residence Permit, etc)
ValidUntil	The date until when the ID is valid in ISO 8601 format. (i.e. YYYY-MM-DD)

Webhooks for DVFC (Alpha) #

Purpose #

Getting Set Up #

Sample Payload #

Field Breakdown #

1. Identification Process #

1.1 Result Types #

1.2 Reasons #

2. Custom Data #

3. Contact Data #

4. User Data #

4.1 Address Properties #

5. Identification Document #