Feedback API

In order to receive feedback of the quality from your users onboardings, we offer an API to give us feedback after a manual human review.

This feature is available at the /user/feedback API end point.

There will be a set of fixed and mandatory input params such user_id, selfie_media_id, document_id and decision { ok, ko-alice, ko-client }. In addition, this entry point will accept an optional param that could contain any additional feedback from the client (List of strings).

The input argument decision shall be:
  • ok: the onboarding is approved

  • ko-alice: the onboarding is not valid and has to be rejected by Alice (e. g. liveness score of real person under threshold, some document fields are missing…)

  • ko-client: the onboarding is rejected because of a customer logic decision (e. g. underage, expired document…)

The following code snippet is an example of how to reports us feedback. Here, a user’s onboarding is rejected from your side because the quality of the document’s picture is not good enough.

curl --request POST \
    --url https://apis.alicebiometrics.com/onboarding/user/feedback \
    --header 'Authorization: Bearer <BACKEND_TOKEN_WITH_USER_ID>' \
    --header 'Content-Type: multipart/form-data' \
    --form selfie_media_id=<selfie_media_id> \
    --form document_id=<document_id> \
    --form decision=KO-alice \
    --form additional_feedback=DOCUMENT_QUALITY
from alice import Onboarding, Config, Decision

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

onboarding.add_user_feedback(
    user_id="user-id",
    selfie_media_id="selfie-media-id",
    document_id="document-id",
    decision=Decision.KO_ALICE,
    additional_feedback=["DOCUMENT_QUALITY"])
).unwrap_or_throw()

Additional feedback

In this table you will find the possibilities to give us additional feedback.

Feedback

Description

DOCUMENT_BLURRY

Document is too blurry.

DOCUMENT_COPY_TRACES

Document is a paper copy.

DOCUMENT_CUT

Document presents some cut information.

DOCUMENT_DAMAGED

Document is physically damaged (cut, burnt, broken…).

DOCUMENT_EXPIRED

Document has expired date.

DOCUMENT_MISSING_FRONT

Document’s front side not uploaded.

DOCUMENT_MISSING_BACK

Document’s back side not uploaded.

DOCUMENT_NOT_ORIGINAL

Document is not original.

DOCUMENT_NUMBER_ALREADY_EXISTS

Document personal number already exists.

DOCUMENT_PHYSICALLY_CUT

Document is broken or contains a physical cut.

DOCUMENT_QUALITY

Document quality is too low (luminosity, contrast, …).

DOCUMENT_TYPE_NOT_ALLOWED

Document is not allowed by client.

DOCUMENT_SCREEN

Document is displayed on a screen.

DOCUMENT_SPOTLIGHT

Document presents some reflections (flash, sunlight, holograms.. ).

DOCUMENT_WRONG

User is presenting a different kind of document than selected one.

DOCUMENT_WRONG_BIRTH_DATE

Document personal birth data was not read properly.

DOCUMENT_WRONG_COUNTRY

User is presenting a document from another country.

DOCUMENT_WRONG_FRAME

Document is not fully framed on the pictured.

DOCUMENT_WRONG_NAME

Document personal name was not read properly.

DOCUMENT_WRONG_NUMBER

Document id number was not read properly.

SELFIE_BLURRY

Selfie is too blurry.

SELFIE_COPY

Selfie is a paper copy.

SELFIE_QUALITY

Selfie quality is too low (luminosity, contrast, …).

SELFIE_MASK

Selfie is obfuscated using a mask (i.e. masks to hide identity, not surgical mask).

SELFIE_MISSING_FACE

Selfie does not present a face.

SELFIE_NOT_ALIVE

Selfie does not represent a genuine user

SELFIE_SCREEN

Selfie is displayed on a screen.

SELFIE_SPOOFING

Selfie spoofing attempt.

SELFIE_SPOTLIGHT

Selfie presents some reflections (flash, sunlight, holograms …).

SELFIE_OTHER_OBFUSCATION

Other obfuscations such as partial occlusions, strong makeup, etc.

USER_FACE_MISMATCH

Wrong face matching.

USER_ALREADY_EXISTS

User key field is already registered on the system (email, document id, etc.).

USER_COUNTRY_IN_BLACKLIST

Country in client’s blacklist.

USER_SELFIE_IDENTIFIED

User selfie is similar to another selfie already registered on the system.

USER_UNDERAGE

User is underage.