Skip to content

Restricted pilot. The API reference is generated from the running API. Successful matches return manual_review until attack detection is validated.

Common integration mistakes

The problems that cost the most, and how to avoid them.

  • Putting the API key in the mobile app. Use the capture token.
  • Treating a 200 response as a pass. Read decision.
  • Waiting for approved during the pilot. It never comes. Handle manual_review.
  • Treating every manual_review as a match. Only reason restricted_mode means one.
  • Treating identity.match as the result. A matching face on a flagged capture is exactly what an attack looks like.
  • Treating similarity as a percentage or probability. It's neither.
  • Reusing a capture session for a retry. Create a new one.
  • Auto-disciplining on a rejection. Give people a human path.
  • Enrolling people who haven't been authorized. Your organization must exclude them.
  • Skipping webhook signature checks.
NextSupport and FAQ