Essential Plan

This is a fully automated identity verification service, where the end-user submits images of their ID document and themselves (document + selfie). The solution can be used via native SDKs, web flow (aka web SDKs) and the API.

The Essential Plan solution uses it own separate Full Auto webhook to send insights, extractions and decisionScore about the session.

Decision webhook is not used.

The system analyses the images, verifies the end-user and returns the following info:

• Decision

• Decision score

• Extraction details

• Session insights

All the info about sessions done in Self-Serve: Essential Plan integration is returned via specific Full Auto webhook, which needs to be configured separately in the Veriff Customer Portal. The decision webhook is not used.

The results of the verification can also be viewed in the Veriff Customer Portal to make a decision about the end-user.

Because all this detailed info is returned, Full Auto sessions do not return reason codes.

Prerequisites

• You have an integration set up with Veriff

• You have configured the Full Auto webhook to get responses from Veriff (see the Webhooks section for info)

• You have created the endUserId / vendorData parameter for your end-user and are ready to send it

• If using the API, it is highly recommended to send the session and device data for better fraud detection

Flow overview

The flow is a bit different, depending on the method you are using to verify your end-users with Veriff.

Use via SDK

1. Generate a verification session using the API keys and the baseURL of your integration (see the API Documentation and API Reference[↗] how to find these)

2. Capture end-user’s document and selfie images with Veriff’s SDKs

   1. Send the end-user through the verification flow to capture the images (using the preferred Veriff SDK)

   2. You need the session URL generated in step 1 to use the SDKs (found in response payload as verification.url)

3. Session will be submitted automatically once the end-user takes and submits necessary images

4. Receive the results from Veriff via Full Auto webhook

Use via API

1. Generate a verification session using the API keys and the baseURL of your integration (see the API Documentation and API Reference[↗] how to find these)

   1. Ensure you send the endUserId / vendorData parameter

   2. Veriff strongly recommends you collect and send additional  session/device data via POST sessions/{sessionid}/collected-data[↗] for improved fraud detection

2. Use your image-capturing method, or prepare previously collected end-user document and selfie images

3. Upload end-user's media via POST /sessions/{sessionId}/media[↗]

4. Specify the image.context as appropriate for the image (see the context types (table) for more info)

5. Patch the session status to submitted using the PATCH /sessions/{sessionId}[↗]

6. 1. Check the decision data and/or session related info from the Full Auto webhook and/or query the data from the GET sessions/{sessionId}/decision/fullauto endpoint

Find decision and/or session related info

You can get the data from three sources:

• Receive the full auto webhook

• Query the results via GET sessions/{sessionId}/decision/fullauto

• View the session in Veriff Customer Portal

Webhook payload

→ See the Full Auto webhook documentation

API call

You can use the GET sessions/{sessionId}/decision/fullauto endpoint, which contains the same data as the decision webhook, but also additional details.

Make sure to add the mandatory query parameter version=1.0.0 to the API URL:

GET sessions/{sessionId}/decision/fullauto?version=1.0.0.

Response: high-level overview

This section gives a very high-level overview of the API response body. The response body is very similar to the Full Auto webhook payload: the endpoint response matches the data.verification object of the webhook payload.

Log in to the Veriff Customer Portal to see the Full Auto webhook sample payload here: Full Auto Webhook [↗].

API response properties explained

• 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, abandoned, expired

• person: object Data extracted from the document about the person. Contains additional objects with specific data that has been extracted

• document: object Data extracted from the document about the document. Contains additional objects with specific data that has been extracted

• insights: array | null Array of pieces of metadata that help explain the decision

{
    "decisionScore": 0.96,
    "decision": "approved",
    "person": {
      ...
    },
    "document":{
      ...
    },
    "insights":[
      {
         ...
      },
    ]
}

Veriff Customer Portal

You can find the verification session related info, including the decision, in the Veriff Customer Portal, under the Verifications tab.

→ See Review verification in Veriff Customer Portal about how to view the session info in the Veriff Customer portal

Article versioning