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()

Report versions

We currently offer 2 versions of the user report:

  1. Report V0 (deprecated)

  2. Report V1

You can switch between the different versions by using the Alice-Report-Version header.

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' \
--header 'Alice-Report-Version: <0,1>'
from alice import Config, Onboarding

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

report = onboarding.create_report(
    user_id=user_id,
    report_version=<ReportVersion.V0, ReportVersion.V1>
).unwrap_or_throw()

The default version is 0.

Fields by document type

These are all the fields per document type. Please bear in mind that some of them are very specific for a certain document.

{
 "passport": [
    "birth_date",
    "country",
    "document_type",
    "expiration_date",
    "first_name",
    "last_name",
    "mrz",
    "nationality",
    "optional_data",
    "passport_number",
    "sex"
    ]
}
{
  "idcard": [
     "address",
     "birth_date",
     "birth_place",
     "city",
     "comune",
     "country",
     "cpf",
     "curp",
     "document_number",
     "document_type",
     "expiration_date",
     "first_name",
     "full_name",
     "id_number",
     "issue_date",
     "issuing_authority",
     "last_name",
     "locality",
     "mrz",
     "nationality",
     "occupation",
     "optional_data",
     "optional_data_2",
     "pdf417",
     "personal_code",
     "personal_number",
     "province",
     "qr",
     "record_number",
     "registration_year",
     "section",
     "serial_number",
     "series",
     "sex",
     "state"
    ]
}
{
 "driverlicense": [
    "a1_first_issue_date",
    "a2_first_issue_date",
    "a_first_issue_date",
    "address",
    "am_first_issue_date",
    "b1_first_issue_date",
    "b_first_issue_date",
    "be_first_issue_date",
    "birth_date",
    "birth_place",
    "city",
    "control_number",
    "country",
    "cpf",
    "document_number",
    "document_type",
    "expiration_date",
    "first_issue_date",
    "first_name",
    "full_name",
    "id_number",
    "issue_date",
    "issuing_authority",
    "last_name",
    "license_categories",
    "license_number",
    "mrz",
    "nationality",
    "optional_data",
    "optional_data_2",
    "pdf417",
    "personal_number",
    "province",
    "qr",
    "reference_number",
    "registration_number",
    "rfc",
    "sex"
    ]
}
{
 "residencepermit": [
    "address",
    "birth_date",
    "birth_place",
    "city",
    "country",
    "document_number",
    "expiration_date",
    "first_name",
    "full_name",
    "id_number",
    "issue_date",
    "issuing_authority",
    "last_name",
    "mrz",
    "nationality",
    "optional_data",
    "optional_data_2",
    "personal_number",
    "province",
    "sex",
    "stamp"
    ]
}