Skip to main content

ProviderBiometricReadingResource

Result of a biometric verification attempt.

idstring<uuid>

Biometric reading identifier. UUID.

typestring

Biometric type that was verified.

Biometric modality used for beneficiary verification.

  • FACE_RECOGNITION: facial biometric match.
  • FINGERPRINT_READING: fingerprint biometric match.
  • FACE_RECOGNITION_OR_FINGERPRINT_READING: either modality is accepted (used in responses).

Possible values: [FACE_RECOGNITION, FINGERPRINT_READING, FACE_RECOGNITION_OR_FINGERPRINT_READING]

confidencenumber

Confidence score returned by the biometric provider. Decimal between 0 and 1.

verification_statusstring

Outcome of the verification. One of VERIFICATION_SUCCESS, VERIFICATION_FAILURE, ERROR.

Outcome of a biometric verification attempt.

  • VERIFICATION_SUCCESS: the reading matched the enrolled biometric.
  • VERIFICATION_FAILURE: the reading did not match the enrolled biometric.
  • ERROR: verification could not be completed. Response contains a diagnostic reason.

Possible values: [VERIFICATION_SUCCESS, VERIFICATION_FAILURE, ERROR]

failure_descriptionstring

Free-text explanation of the failure, when 'verification_status' is not VERIFICATION_SUCCESS.

expires_atstring<date-time>

Timestamp after which this reading can no longer be attached to a downstream operation. ISO 8601.