Report

A report collects all the information extracted for a user during the onboarding process. It is accessible through the following endpoint.

curl --request GET \
--url https://apis.alicebiometrics.com/onboarding/user/report \
--header 'Authorization: Bearer <BACKEND_TOKEN_WITH_USER_ID>' \
--header 'Content-Type: multipart/form-data'
from alice import Config, Onboarding

config = Config(api_key=api_key)
onboarding = Onboarding.from_config(config)

report = onboarding.create_report(
    user_id=user_id, verbose=True
).unwrap_or_throw()

Example

Here is an example of a report for an onboarding consisting in selfie, spanish ID and passport.

Selfie

ID ESP

Passport

selfie

id_front id_back

passport

Warning

Please bear in mind that the selfie is not from a real person. That is why the face_liveness score is low.

Structure

A user’s report is given as a JSON. The following sub-sections detail the corresponding JSON schemas to help a better understanding of the report.

A report collects all the information extracted for a user during the onboarding process

type

object

properties

  • created_at

Report creation time in ISO 8601 format

type

string

format

date-time

  • documents

It collects all user documents

type

array

items

Document Report

  • events

It collects all user events

type

array

items

User Event

  • id

Unique report identifier (UUID v4 standard)

type

string

maxLength

36

minLength

36

  • other_trusted_documents

It collects all user Other Trusted Document. An OTD is a PDF containing a proof of residence, a payroll, a proof of address…

type

array

items

OTD Report

  • selfies

It collects all user selfies

type

array

items

Selfie Report

  • summary

User summary

allOf

Report Summary

  • user_id

Unique user identifier (UUID v4 standard)

type

string

maxLength

36

minLength

36

  • version

Report version

type

integer

const

1

Report summary

Report Summary

It summarizes the main user information of the onboarding process

type

object

properties

  • checks

Summary/User-level checks

type

array

default

items

Check

  • devices

Devices operated by the user

type

array

default

items

Device

  • external_user_data

External UserData

  • face_liveness

Analysis to detect if the user’s active selfie is from a real person. The recommended threshold is 50.

type

number

maximum

100

minimum

0

  • face_matching

All available face matchings between user’s seflies and docs

type

array

default

items

Face Matching

  • user_data

Best read user-intrinsic info across all docs

type

array

default

items

Document Field

External UserData

It collects the given data at user creation time

type

object

properties

  • email

type

string

  • first_name

type

string

  • last_name

type

string

Selfie reports

Selfie Report

A selfie report collects all the information extracted for a selfie during the onboarding process

type

object

properties

  • checks

Selfie-level checks

type

array

default

items

Check

  • created_at

Selfie creation time in ISO 8601 format

type

string

format

date-time

  • id

Unique selfie identifier (UUID v4 standard)

type

string

maxLength

36

minLength

36

  • liveness

Analysis to detect if the selfie is from a real person. The recommended threshold is 50.

type

number

maximum

100

minimum

0

  • media

Selfie media resources

type

object

additionalProperties

Href

  • number_of_faces

Number of faces appearing in the selfie

type

number

  • voided

Whether the selfie has been voided or not

type

boolean

Document reports

Document Report

A document report collects all the information extracted for a document during the onboarding process

type

object

properties

  • checks

Document-level checks

type

array

default

items

Check

  • created_at

Document creation time in ISO 8601 format

type

string

format

date-time

  • id

Unique document identifier (UUID v4 standard)

type

string

maxLength

36

minLength

36

  • meta

Document Report Meta

  • sides

default

back

null

front

null

internal

null

allOf

Document Sides Detail Report

  • summary_fields

Best-read document info from all its sides

type

array

default

items

Document Field

Document Report Meta

It collects document metadata

type

object

properties

  • completed

True if all document sides are captured

type

boolean

  • issuing_country

Document issuing country in ISO 3166-1 alpha-3 format

type

string

  • type

Document Type

  • voided

Whether the doc has been voided or not

type

boolean

Document Sides Detail Report

type

object

properties

  • back

Document Side Report

  • front

Document Side Report

  • internal

Document Side Report

Document Side Report

It collects document metadata

type

object

properties

  • fields

Document info extracted from side

type

array

default

items

Document Field

  • media

Document side media resources

type

object

additionalProperties

Href

  • meta

Document Side Report Meta

  • side

Side

Document Side Report Meta

It collects document side metadata

type

object

properties

  • manual

True if the capture was taken in manual mode

type

boolean

  • template

Document version used to extract the info

type

string

Side

An enumeration.

enum

front, back, internal

Document Type

An enumeration.

enum

idcard, driverlicense, residencepermit, passport, healthinsurancecard

OTD reports

OTD Report

An OTD report collects all the information of a previously added OTD

type

object

properties

  • created_at

OTD creation time in ISO 8601 format

type

string

format

date-time

  • id

Unique OTD identifier (UUID v4 standard)

type

string

maxLength

36

minLength

36

  • media

type

object

properties

  • pdf

Href

  • meta

OTD Report Meta

OTD Report Meta

It collects OTD metadata

type

object

properties

  • category

External identifier (e.g: Proof of residence)

type

string

  • voided

Whether the OTD has been voided or not

type

boolean

User events

User Event

It collects events info

type

object

properties

  • attributes

type

object

  • device

Device on which the event occurred

allOf

Device

  • id

Unique event identifier (UUID v4 standard)

type

string

format

uuid

  • occurred_on

Event time in ISO 8601 format

type

string

format

date-time

  • type

Event type

type

string

Common structures

Face Matching

It analyses whether the document’s face and selfie are from the same person

type

object

properties

  • meta

Face Matching Meta

  • score

Face matching score. The recommended threshold is 50.

type

number

maximum

100

minimum

0

Face Matching Meta

Face matching metadata

type

object

properties

  • created_at

Face match creation time in ISO 8601 format

type

string

format

date-time

  • document_id

Unique document identifier (UUID v4 standard)

type

string

maxLength

36

minLength

36

  • selfie_id

Unique selfie identifier (UUID v4 standard)

type

string

maxLength

36

minLength

36

  • side

Document side

allOf

Side

Document Field

It collects the extracted OCR info

type

object

properties

  • checks

type

array

default

items

Check

  • name

type

string

  • score

type

integer

  • value

type

string

Check

It examines if a certain condition is met

type

object

properties

  • detail

Brief check description

type

string

  • key

Unique check identifier

type

string

  • value

this is the value of the check

type

number / null

maximum

100

minimum

0

See Checks

Device

It collects info about a device

type

object

properties

  • agent

Alice SDK

type

string

  • agent_version

Alice SDK version

type

string

  • ip

type

string

  • model

type

string

  • platform

type

string

  • platform_version

type

string

Href

It collects info about a media resource

type

object

properties

  • extension

Media extension

type

string / null

default

null

  • href

HTML-like href link

type

string

  • objects

Identified regions

type

object / null

default

null

additionalProperties

Bounding Box

Bounding Box

A bounding box is the smallest rectangle with vertical and horizontal sides that completely surrounds an object

type

object

properties

  • height

Rectangle height

type

integer

  • width

Rectangle width

type

integer

  • x

Top left corner x coordinate

type

integer

  • y

Top left corner y coordinate

type

integer