Report V0 (deprecated)¶

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

Selfie	ID ESP	Passport

Warning

Please bear in mind that the selfie is not from a real person. That is why the 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 date in ISO 8601 format
	type	string
	format	date-time
document_reports	It details the result of each document by their sides. Indexed by document_id
	type	object
	additionalProperties	Document sides report
selfie_reports	Collects all user selfies indexed by selfie_id
	type	object
	additionalProperties	Selfie summary
user_summary	It summarizes the result of the onboarding process at a high level
	type	object
	User summary

User summary¶

This is the main section to look at when integrating the report.
type	object
properties
authorized	Whether the user has been authorized for login or not
	type	boolean
	default	False
created_at	User creation date in ISO 8601 format
	type	string
	default	0001-01-01T00:00:00Z
	format	date-time
documents	User documents
	type	object
	Documents summary
fields	Summary of the user-intrinsic info from both user creation and docs
	type	object
	User summary fields
selfie	User active selfie
	type	object
	Selfie summary
user_id	User identifier (32-length UUID v4 standard)
	type	string

User summary fields¶

Summary of the user-intrinsic info from both user creation and docs
type	object
properties
address	Best-read address from all user’s docs
	Field
birth_date	Best-read birthdate from all user’s docs (YYYY-MM-DD format)
	Field
email	Email address given at user creation time
	Field
first_name	Best-read first name from all user’s docs
	Field
last_name	Best-read last name from all user’s docs
	Field
nationality	User’s nation in ISO 3166-1 alpha-3 format
	Field
registration_first_name	First name given at user creation time
	Field
registration_last_name	Last name given at user creation time
	Field
sex	M, F or < for male, female or unspecified
	Field

Documents summary¶

Summary of the user documents
type	object
properties
status	Summary of all documents metadata (alerts and infos)
	default	alert
		info
	Documents summary status
summary	Summary of each document indexed by document_id
	type	object
	additionalProperties	Document summary
uploaded_documents	Array of document_ids
	type	array
	items	type	string

Documents summary status¶

Summary of document metadata (alerts and infos)
type	object
properties
alert	type	array
	items	Alert
	uniqueItems	True
info	type	array
	items	Info
	uniqueItems	True

Document summary¶

It summarizes the info of a document
type	object
properties
completed	True if all document sides are captured
	type	boolean
	default	False
created_at	Document creation date in ISO 8601 format
	type	string
	format	date-time
face_validation	It analyses whether the document’s face and selfie are from the same person
	Face validation
fields	Best-read document info from all it sides
	type	object
	additionalProperties	Field
issuing_country	Document issuing country in ISO 3166-1 alpha-3 format
	type	string
status	default	alert
		info
	Document summary status
type	Document type
	type	string
	enum	idcard, driverlicense, residencepermit, passport
voided	Whether the doc has been voided or not
	type	boolean
	default	False

Document summary status¶

Summary of a document metadata (alerts and infos)
type	object
properties
alert	type	array
	items	Alert
	uniqueItems	True
info	type	array
	items	Info
	uniqueItems	True

Document reports¶

Document sides report¶

Document report sides
type	object
properties
back	type	object
	Document side report
front	type	object
	Document side report
internal	type	object
	Document side report

Document side report¶

Document side report
type	object
properties
authenticity	BETA: document forensics measures
	type	object
	additionalProperties	type	string
face_bounding_box	Face coordinates for media_id if applicable
	type	object
	Bounding box
fields	Document info extracted from side
	type	object
	additionalProperties	Field
manual_capture	True if the capture was taken in manual mode
	type	boolean
	default	False
media_id	Document image identifier (32-length UUID v4 standard)
	type	string
template	Document version used to extract the info
	type	string
thumbnail_id	Lighter version of media_id image (32-length UUID v4 standard)
	type	string
whole_media_id	Full document image identifier (32-length UUID v4 standard)
	type	string

Selfie reports¶

Selfie summary¶

It summarizes the info of a selfie
type	object
properties
created_at	Selfie creation date in ISO 8601 format
	type	string
	default	0001-01-01T00:00:00Z
	format	date-time
face_bounding_box	Face coordinates for media_selfie_id
	type	object
	Bounding box
liveness	Analysis to detect if the selfie is from a real person
	type	object
	Liveness summary
media_avatar_id	Selfie avatar identifier (32-length UUID v4 standard)
	type	string
media_id	Selfie video identifier (32-length UUID v4 standard)
	type	string
media_selfie_id	Selfie best-frame identifier (32-length UUID v4 standard)
	type	string
voided	Whether the selfie is voided or not
	type	boolean
	default	False

Common structures¶

Liveness summary¶

Analysis to detect if the selfie is from a real person
type	object
properties
score	The higher the score the more likely is that the selfie is from a real person. Recommended th = 0.5
	type	number
	maximum	1
	minimum	0

Face validation¶

It analyses whether the document’s face and selfie are from the same person
type	object
properties
score	The higher the score the more likely is that the selfie and doc face are from the same person. Recommended th = 0.7
	type	number
	maximum	1
	minimum	0

Bounding box¶

Coordinates defining a box
type	object
properties
height	Box height
	type	integer
width	Box width
	type	integer
x	Top left corner
	type	integer
y	Top left corner
	type	integer

Field¶

It collects the extracted OCR info
type	object
properties
status	Field metadata
	Field status
value	Field raw value
	type	string

Field status¶

Field metadata
type	object
properties
alert	Field warnings
	type	array
	items	Alert
	uniqueItems	True
info	Field checks
	type	array
	items	Info
	uniqueItems	True
score	Reading confidence score. Recommended th = 0.8
	type	number
	maximum	1
	minimum	0

Alert¶

Warnings about a user, doc or field
type	object
properties
code	type	integer
message	type	string

See Alert codes

Info¶

Checks about a user, doc or field
type	object
properties
code	type	integer
message	type	string

See Info codes

Info and alert codes¶

There are different types of messages to manage information, alerts or error codes within Alice Onboarding.

Info codes¶

Messages with useful information, generally positive, about how the process of reading or generation of that field has taken place.

Note

Info messages have codes above 2000

Field-level info¶

These info messages could appear at a Field

Code	Message	Comments
2100	Valid date format	Applicable to fields ending with `_date`
2101	Date is within valid range	Applicable to fields ending with `_date`
2102	Over 18 years old	Only applicable to `birth_date` field
2300	Name is entirely contained in MRZ
2301	Field is checked	Field is validated by a checksum
2302	Name words number matches with MRZ

Alert codes¶

Warnings that potentially require some action or supervision such as alerts of incorrect formats, dates that do not meet criteria, etc.

Note

Alerts have codes above 4000

User-level alerts¶

These alerts could appear at Documents summary status

Code	Message
4000	No documents available
4201	At least one document is missing its face validation

Doc-level alerts¶

These alerts could appear at a Document summary status

Code	Message	Comments
4300	Mismatch between read and selected document	Unexpected document
4301	There are inconsistent fields in the document	At least 3 doc fields differ between front and back sides
4302	Expired document
4303	There are unchecked fields in the document	At least 1 field does not pass its checksum
4304	The document’s MRZ/PDF417/QR is unchecked	The MRZ/PDF417/QR does not pass its checksum
4305	Compromised document	Specimen or sample of a document

Field-level alerts¶

These alerts could appear at a Field

Code	Message	Comments
4001	Unchecked field	The field does not pass its checksum
4002	Inconsistent field	The same field has a different value in other side or doc
4003	Incomplete name	First/last name length does not match MRZ name
4004	Unexpected field	The field’s value is unexpected
4100	Incorrect date format	Applicable to fields ending with `_date`
4101	Date out of range	Applicable to fields ending with `_date`
4102	Expired date	Only applicable to `expiration_date` field
4103	Under 18 years old	Only applicable to `birth_date` field