Lookup Object

(Lookup step)

In order to perform the lookup, uqudo API uses data that is retrieved from the reading step (NFC chip) or, if not available, the optical scanning. The data that come from the NFC chip should be always correct. Data that come from the optical scanning could potentially have OCR errors.

AttributeDescription

status

SUCCESS or FAILED

statusCode

Available if status is FAILED:

  • INVALID_INPUT (e.g. a required field was not properly OCRd)

  • ID_NOT_FOUND (ID was not found in the Government database. Could be related to the same problem mentioned for the INVALID_INPUT or because the ID was actually not found)

  • UNEXPECTED_ERROR

  • SERVICE_UNAVAILABLE (Government database service was not available)

statusMessage

Status message if any. Can be null

data

Available only if status is SUCCESS. See below the details per document type

Last updated