Endpoints for enrolling and verifying a minor's fingerprints so they can later consent with their own print.
Enrol a minor's fingerprint (first capture)
Captures a minor's fingerprint at a finger position for the first time. The call is asynchronous: it returns 202 with a job_id, not an outcome. The print is stored but not yet usable for consent - a later verification confirms it.
The outcome is delivered to the facility's registered callback endpoint when the capture resolves - the same endpoint that already receives claim notifications, so it inherits its authentication, signing and retries. next_action is await_callback; there is nothing to poll. Enrollment is per finger, so repeat this for each finger position the child needs.
beneficiary_code, workstation_id, device_id, agent_id and position are all required. A request missing any of them is rejected with 400 naming the field, rather than being dispatched and failing at the workstation.
Because the outcome is only ever delivered by callback, a facility with no registered callback endpoint is refused with 422 before anything is dispatched - register one first.
Related documentation: Minors Biometrics Enrollment
Enrol a minor's fingerprint (first capture) › Request Body
agent_idRequired. ID number of the biometrics agent signed into the workstation's hardware server application. Recorded against the capture for audit. Example is dummy data.
beneficiary_codeRequired. The minor's beneficiary Client Registry code, including the dependant suffix. Dependants are distinguished only by the trailing index, so send exactly the code of the child whose finger is on the scanner. Example is dummy data.
device_idRequired. Serial number of the capture device on the workstation, read from the local agent's device list.
positionRequired. The finger position being enrolled, from 1 to 10. Enrollment is per finger, so a beneficiary is enrolled one position at a time.
workstation_idRequired. Identifier of the workstation that performs the capture, obtained from the hardware server application running on the authorizing device.
deadline_secondsAdvanced. Seconds the capture window stays open before the attempt is abandoned. Leave it unset unless you have a reason to widen or narrow the window; the platform default suits a normal point-of-care capture.
Enrol a minor's fingerprint (first capture) › Responses
Accepted - enrollment capture dispatched to the workstation. The outcome arrives at the registered callback endpoint
job_idReference for this capture request. The completion callback carries the same value, so use it to tie the callback back to the request that produced it.
next_actionAlways await_callback. The verdict is pushed to the facility's registered callback endpoint when the capture resolves; there is nothing to poll.
statusAcknowledgement state of the dispatched capture. dispatched means it reached the workstation and the finger has not been read yet. The result is not here; it arrives on the callback.
Verify a minor's enrolled fingerprint (second capture)
Captures a minor's fingerprint at a finger position a second time and matches it against the print already enrolled there. A successful verification confirms the finger and makes it usable for consent. The call is asynchronous: it returns 202 with a job_id, not an outcome.
The outcome is delivered to the facility's registered callback endpoint when the capture resolves - the same endpoint that already receives claim notifications, so it inherits its authentication, signing and retries. next_action is await_callback; there is nothing to poll.
The verification callback reports whether the finger was confirmed and, when it was not, how many attempts remain and whether the finger must be re-enrolled. A finger has a small number of verification attempts within a short window; once they are spent the finger is retired and must be enrolled again.
beneficiary_code, workstation_id, device_id, agent_id and position are all required, and position must be one already enrolled. As with enrollment, a facility with no registered callback endpoint is refused with 422 before anything is dispatched.
Related documentation: Minors Biometrics Enrollment
Verify a minor's enrolled fingerprint (second capture) › Request Body
agent_idRequired. ID number of the biometrics agent signed into the workstation's hardware server application. Recorded against the capture for audit. Example is dummy data.
beneficiary_codeRequired. The minor's beneficiary Client Registry code, including the dependant suffix. Send exactly the code of the child whose finger is on the scanner. Example is dummy data.
device_idRequired. Serial number of the capture device on the workstation, read from the local agent's device list.
positionRequired. The finger position being verified, from 1 to 10. It must be a position that was already enrolled; verifying confirms that enrolled print.
workstation_idRequired. Identifier of the workstation that performs the capture, obtained from the hardware server application running on the authorizing device.
deadline_secondsAdvanced. Seconds the capture window stays open before the attempt is abandoned. Leave it unset unless you have a reason to widen or narrow the window; the platform default suits a normal point-of-care capture.
Verify a minor's enrolled fingerprint (second capture) › Responses
Accepted - verification capture dispatched to the workstation. The outcome arrives at the registered callback endpoint
job_idReference for this capture request. The completion callback carries the same value, so use it to tie the callback back to the request that produced it.
next_actionAlways await_callback. The verdict is pushed to the facility's registered callback endpoint when the capture resolves; there is nothing to poll.
statusAcknowledgement state of the dispatched capture. dispatched means it reached the workstation and the finger has not been read yet. The result is not here; it arrives on the callback.
Get a beneficiary's fingerprint enrollment status
Returns the finger positions a beneficiary has enrolled, separating those already verified from those still awaiting confirmation. Use it to track enrollment progress, resume a paused enrollment, and - once a child is enrolled - confirm they have usable prints before requesting a match. Read-only: it performs no device capture and does not contact a workstation.
A beneficiary with no stored prints returns total 0 and an empty enrollment_status.
Related documentation: Minors Biometrics Enrollment
query Parameters
beneficiary_codeThe beneficiary's Client Registry code, including the dependant suffix when the beneficiary is a dependant. Example is dummy data.
Get a beneficiary's fingerprint enrollment status › Responses
OK - Fingerprint enrollment status of the beneficiary
enrollment_statusOverall enrollment state: fully_enrolled when every expected finger is stored and verified, partially_enrolled when some are still outstanding, and an empty string when the beneficiary has no stored prints.
non_verifiedFinger positions that are stored but still awaiting confirmation. Resume the enrollment on these positions; they cannot satisfy a match request yet.
totalTotal number of finger positions stored for the beneficiary, verified and non-verified combined.
verifiedFinger positions that are stored and confirmed. Any of these can satisfy a match request; pass one of them as position to target a specific finger.