Full Auto webhook | Veriff.com

The Full Auto webhook is required only for the Essential Plan: Full Auto solution which returns insights, extractions data and decision score.

This webhook is used to return the verification data once the Full Auto verification has been processed. The payload is sent to Webhook Full Auto URL, which you need to set up the webhook in the Veriff Customer Portal.

→ See Webhooks Guide > Set up webhooks sub-section for detailed overview of the setup process

Prerequisites

Make sure you have access to the Veriff Customer Portal
1. If you do not, see the Getting Started → Sign up and Log in articles
Set up webhook URL(s) on your side and have them at hand
1. Make sure they match the Webhook URL requirements
2. Make sure your system is able to handle Webhooks receipt, delivery and resending requirements
Secure your communication, check the HMAC Authentication and Endpoint Security article
Make sure your system is able to handle the Backwards compatible changes

5.Proceed to Full Auto webhook setup below

Full Auto webhook setup

Log in to the Veriff Customer Portal
Navigate to the Integrations page via the top menu and open the integration used for Full Auto
On the integration's page, select the Settings tab
Under the title Integration settings you see a list of webhooks
Fill in the Webhook Full Auto URL field
1. Note that because all the data is returned via specific Full Auto webhook, the decision webhook is not used, therefore the Webhook decisions URL input field is not available.

→ See Webhooks Guide > Set up webhooks sub-section for detailed overview of the setup process

Additional notes

These Full Auto sessions do not return session reason or decision codes.

data.verification.decisionScore parameter
This is a numerical value representing how confident the system is that the session is genuine, higher number means that the session is more likely to be genuine.
In the API and webhooks payloads, it is shown as a float in the range of 0–1
In the Veriff Customer Portal, the range is shown as 1–100

Sample request

The example below is a light-weight version of the payload. To see the more details, log in to you Veriff account and see the detailed sample payload article[↗] in Veriff Knowledge Base.

{
  "status": "success",
  "eventType": "fullauto",
  "sessionId": "1234567d-1ab2-34c5-bba7-a23gh58908er",
  "attemptId": "12e3d456-9ea2-7821-12io-aabb4113bgtf",
  "vendorData": null,
  "version": "1.0.0",
  "acceptanceTime": "2023-10-05T17:34:06.882846Z",
  "time": "2023-10-05T17:33:22.449Z",
  "data": {
      "verification": {
          "decisionScore": 0.96,
          "decision": "approved",
          "person": {
              "firstName": {
                  "confidenceCategory": "medium",
                  "value": "ASHOK",
                  "sources": [
                      "MRZ",
                      "VIZ"
                  ]
              },
              ...
          },
          "document":{
              "type": {
                  "value": "id_card"
              },
              "country": {
                  "value": "IN"
              },
              "number": {
                  "confidenceCategory": "high",
                  "value": "123abc456",
                  "sources": [
                      "MRZ",
                      "VIZ"
                  ]
              },
              ...
          },
          "insights":[
              {
                  "label": "xwz",
                  "result": "yes",
                  "category": "abc"
              },
              {
                  ...
              },
          ]
      },
  },
}

Request properties explained

*Required field

status: string* Status of the request, one of success, fail
eventType: string* Full Auto event name, returns fullauto
sessionId: UUID* UUID v4 which identifies the verification session
attemptId: UUID* UUID v4 which identifies an attempt inside the verification session
vendorData: string | null* The unique identifier that you created for your end-user, returned unmodified in webhooks and API calls. null if not specified
endUserId: string | null* The UUID that you created for your end-user, returned unmodified in webhooks and API calls. null if not specified
version: string* Webhook version
acceptanceTime: string* Timestamp of when the session was generated. Combined ISO 8601 date and time in UTC (YYYY-MM-DDTHH:MM:SS.SSS+Timezone Offset|Z, i.e., 2018-04-18T11:02:05.261Z)
time: string* Timestamp of when the event was generated. Combined ISO 8601 date and time in UTC (YYYY-MM-DDTHH:MM:SS.SSS+Timezone Offset|Z, i.e., 2018-04-18T11:02:05.261Z)
data: object* Verification data objects
- verification*: object
  - decisionScore: number | null* A float number, shows how confident the system is that the session is genuine. Higher number indicates higher confidence. The number is rounded up to two decimal places.
  - decision: string* Shows system’s suggestion of what to do with the session, one of approved, declined, resubmission_requested, expired, abandoned
  - person: object* Data extracted from the document about the person. Contains additional objects with specific data that has been extracted
    ...: object | null* Extraction activity name. Log in to Veriff Customer Portal and find the possible extraction activity names in the detailed request properties explanation article[↗] or check the detailed sample payload article[↗] for more info
    confidenceCategory: string | null Shows the confidence value, one of high, medium, low
    value: string | null Data extracted from the document
    sources: array | empty Shows the document data field where the data was extracted from, one of VIZ, MRZ, NFC, BARCODE
  - document: object* Data extracted from the document about the document. Contains additional objects with specific data that has been extracted
    type: object | null
    value: string | null Document type, one of PASSPORT, ID_CARD, RESIDENCE_PERMIT, DRIVERS_LICENSE, VISA
    country: object | null
    value: string | null ISO-2 country code of the document country
    ...: object | null* Extraction activity name. Log in to Veriff Customer Portal and find the possible extraction activity names in the detailed request properties explanation article[↗] or check the detailed sample payload article[↗] for more info
    confidenceCategory: string | null Shows the confidence value, one of high, medium, low
    value: string | null Data extracted from the document
    sources: array | empty Shows the document data field where the data was extracted from, one of VIZ, MRZ, NFC, BARCODE
  - insights: array | null* Array of pieces of metadata that help explain the decision. Note that the actual list of insights visible in the webhook payload depends on your integration
    label: string Name of the insight. Log in to Veriff Customer Portal and find the possible extraction activity names in the detailed request properties explanation article[↗] or check the detailed sample payload article[↗] for more info
    result: string Result of the insight, one of yes, likelyYes, no, notApplicable
    category: string Name of the category the insight belongs to. Log in to Veriff Customer Portal and find the possible extraction activity names in the detailed request properties explanation article[↗] or check the detailed sample payload article[↗] for more info