Skip to content

Fields per document

If you have doubts about which fields are read for each document, you can use the document properties endpoint to check them.

curl --request POST \
--url https://apis.alicebiometrics.com/onboarding/user/document/properties \
--header 'Authorization: Bearer <USER_TOKEN>' \
--header 'Content-Type: multipart/form-data' \
--form type=<DOCUMENT_TYPE> \
--form issuing_country=<ISSUING_COUNTRY>
from alice import Config, Onboarding

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

document_properties = onboarding.document_properties(
    user_id=user_id,
    type="<DOCUMENT_TYPE>",
    issuing_country="<ISSUING_COUNTRY>"
).unwrap()

For example, for the Spanish ID the response is the following: