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 |
---|---|---|
|
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 |
||
|
Report creation time in ISO 8601 format |
|
type |
string |
|
format |
date-time |
|
|
It collects all user documents |
|
type |
array |
|
items |
||
|
It collects all user events |
|
type |
array |
|
items |
||
|
Unique report identifier (UUID v4 standard) |
|
type |
string |
|
maxLength |
36 |
|
minLength |
36 |
|
|
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 |
||
|
It collects all user selfies |
|
type |
array |
|
items |
||
|
User summary |
|
allOf |
||
|
Unique user identifier (UUID v4 standard) |
|
type |
string |
|
maxLength |
36 |
|
minLength |
36 |
|
|
Report version |
|
type |
integer |
|
const |
1 |
Report summary¶
Report Summary¶
It summarizes the main user information of the onboarding process |
||
type |
object |
|
properties |
||
|
Summary/User-level checks |
|
type |
array |
|
default |
||
items |
||
|
Devices operated by the user |
|
type |
array |
|
default |
||
items |
||
|
||
|
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 |
|
|
All available face matchings between user’s seflies and docs |
|
type |
array |
|
default |
||
items |
||
|
Best read user-intrinsic info across all docs |
|
type |
array |
|
default |
||
items |
External UserData¶
It collects the given data at user creation time |
||
type |
object |
|
properties |
||
|
type |
string |
|
type |
string |
|
type |
string |
Selfie reports¶
Selfie Report¶
A selfie report collects all the information extracted for a selfie during the onboarding process |
||
type |
object |
|
properties |
||
|
Selfie-level checks |
|
type |
array |
|
default |
||
items |
||
|
Selfie creation time in ISO 8601 format |
|
type |
string |
|
format |
date-time |
|
|
Unique selfie identifier (UUID v4 standard) |
|
type |
string |
|
maxLength |
36 |
|
minLength |
36 |
|
|
Analysis to detect if the selfie is from a real person. The recommended threshold is 50. |
|
type |
number |
|
maximum |
100 |
|
minimum |
0 |
|
|
Selfie media resources |
|
type |
object |
|
additionalProperties |
||
|
Number of faces appearing in the selfie |
|
type |
number |
|
|
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 |
|||
|
Document-level checks |
||
type |
array |
||
default |
|||
items |
|||
|
Document creation time in ISO 8601 format |
||
type |
string |
||
format |
date-time |
||
|
Unique document identifier (UUID v4 standard) |
||
type |
string |
||
maxLength |
36 |
||
minLength |
36 |
||
|
|||
|
default |
back |
null |
front |
null |
||
internal |
null |
||
allOf |
|||
|
Best-read document info from all its sides |
||
type |
array |
||
default |
|||
items |
Document Report Meta¶
It collects document metadata |
||
type |
object |
|
properties |
||
|
True if all document sides are captured |
|
type |
boolean |
|
|
Document issuing country in ISO 3166-1 alpha-3 format |
|
type |
string |
|
|
||
|
Whether the doc has been voided or not |
|
type |
boolean |
Document Sides Detail Report¶
type |
object |
properties |
|
|
|
|
|
|
Document Side Report¶
It collects document metadata |
||
type |
object |
|
properties |
||
|
Document info extracted from side |
|
type |
array |
|
default |
||
items |
||
|
Document side media resources |
|
type |
object |
|
additionalProperties |
||
|
||
|
Document Side Report Meta¶
It collects document side metadata |
||
type |
object |
|
properties |
||
|
True if the capture was taken in manual mode |
|
type |
boolean |
|
|
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 |
||
|
OTD creation time in ISO 8601 format |
|
type |
string |
|
format |
date-time |
|
|
Unique OTD identifier (UUID v4 standard) |
|
type |
string |
|
maxLength |
36 |
|
minLength |
36 |
|
|
type |
object |
properties |
||
|
||
|
OTD Report Meta¶
It collects OTD metadata |
||
type |
object |
|
properties |
||
|
External identifier (e.g: Proof of residence) |
|
type |
string |
|
|
Whether the OTD has been voided or not |
|
type |
boolean |
User events¶
User Event¶
It collects events info |
||
type |
object |
|
properties |
||
|
type |
object |
|
Device on which the event occurred |
|
allOf |
||
|
Unique event identifier (UUID v4 standard) |
|
type |
string |
|
format |
uuid |
|
|
Event time in ISO 8601 format |
|
type |
string |
|
format |
date-time |
|
|
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 |
||
|
||
|
Face matching score. The recommended threshold is 50. |
|
type |
number |
|
maximum |
100 |
|
minimum |
0 |
Face Matching Meta¶
Face matching metadata |
||
type |
object |
|
properties |
||
|
Face match creation time in ISO 8601 format |
|
type |
string |
|
format |
date-time |
|
|
Unique document identifier (UUID v4 standard) |
|
type |
string |
|
maxLength |
36 |
|
minLength |
36 |
|
|
Unique selfie identifier (UUID v4 standard) |
|
type |
string |
|
maxLength |
36 |
|
minLength |
36 |
|
|
Document side |
|
allOf |
Document Field¶
It collects the extracted OCR info |
||
type |
object |
|
properties |
||
|
type |
array |
default |
||
items |
||
|
type |
string |
|
type |
integer |
|
type |
string |
Check¶
It examines if a certain condition is met |
||
type |
object |
|
properties |
||
|
Brief check description |
|
type |
string |
|
|
Unique check identifier |
|
type |
string |
|
|
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 |
||
|
Alice SDK |
|
type |
string |
|
|
Alice SDK version |
|
type |
string |
|
|
type |
string |
|
type |
string |
|
type |
string |
|
type |
string |
Href¶
It collects info about a media resource |
||
type |
object |
|
properties |
||
|
Media extension |
|
type |
string / null |
|
default |
null |
|
|
HTML-like href link |
|
type |
string |
|
|
Identified regions |
|
type |
object / null |
|
default |
null |
|
additionalProperties |
Bounding Box¶
A bounding box is the smallest rectangle with vertical and horizontal sides that completely surrounds an object |
||
type |
object |
|
properties |
||
|
Rectangle height |
|
type |
integer |
|
|
Rectangle width |
|
type |
integer |
|
|
Top left corner x coordinate |
|
type |
integer |
|
|
Top left corner y coordinate |
|
type |
integer |