Skip to main content
Checks whether an ID image was taken of the physical card. Choose the checks (pipelines) to run, and each returns a score from 0 to 100.
  • You are billed for the number of checks that returned a score. Checks you did not request or that failed are null in the response and are not billed.
  • If all checks fail, the call returns 502 UPSTREAM_ERROR and is not billed.
  • Only scores are returned. You decide the pass threshold.

Notes

  • Send an image with a margin around the ID. If the ID fills the entire image, scores may not be produced correctly.
  • Score distributions can change when the engine changes. Store engineVersion with the scores.

Billing

The billing unit is pipeline, and count is the number of checks that returned a score, not the number of checks you turned on. Bundle pricing applies to two or more, so credit can differ from unitPrice × count.

Specification

ID-LIVE specification

Check the endpoint, request and response fields with examples, and errors.
For errors that apply to all APIs, see Error Codes.