Plaid logo
Docs
ALL DOCS

Identity Verification

  • Introduction to Identity Verification
  • Webhooks
  • Link callbacks
  • Testing in Sandbox
  • Hybrid input validation
  • Generating metrics
Plaid logo
Docs
Close search modal
Ask Bill!
Ask Bill!
Hi! I'm Bill! You can ask me all about the Plaid API. Try asking questions like:
  • What's the difference between Plaid Identity and IDV?
  • Why is /transactions/sync/ better than /get?
  • How do I set up Link on the web?
Note: Bill isn't perfect. He's just a robot platypus that reads our docs for fun. You should treat his answers with the same healthy skepticism you might treat any other answer on the internet. This chat may be logged for quality and training purposes. Please don't send Bill any PII -- he's scared of intimacy. All chats with Bill are subject to Plaid's Privacy Policy.
Plaid.com
Log in
Get API Keys
Open nav

Generating metrics

Generating metrics for Identity Verification

You can view the status of any Identity Verification session in the Dashboard. To obtain aggregated data such as the percentage of sessions that were completed or the percentage that passed verification vs. were rejected, you will need to use the API to generate the data.

Conversion and success rates

The conversion rate is defined as the percentage of sessions begun that were completed, regardless of whether the user passed or failed verification.

The success rate is defined as the percentage of completed sessions that resulted in the user passing verification.

Calculating success rates

The most comprehensive way to measure overall success rates is to use /identity_verification/get, since it includes backend-only sessions, sessions generated using shareable links, and manual overrides after the session is completed.

If the status is success, the verification succeeded.

If the status is failed or pending review, the verification did not succeed.

The success rate is the number of sessions with the success status divided by the total of all sessions with the success, failed, or pending review status.

Sessions with a status other than success, failed, or pending review should be discarded for the purpose of calculating overall success rates, since they represent sessions that were not completed.

Calculating conversion rates

If you want to measure the conversion rate, you can use the onEvent callback. A session is started if you receive the IDENTITY_VERIFICATION_START_STEP event. It was completed if you receive either the IDENTITY_VERIFICATION_PASS_SESSION or IDENTITY_VERIFICATION_FAIL_SESSION event, and it was successful only if you receive the IDENTITY_VERIFICATION_PASS_SESSION. To correlate different events with the same Link session, use the link_session_id. For more details, see Link callbacks.

For Identity Verification, onEvent callback information is not available via the /link/token/get endpoint.

Alternatively, you can calculate conversion using /identity_verification/get. The conversion rate is the number of sessions with a status of success, failed, or pending review divided by the total number of unique identity verification IDs. Because this metric includes sessions where the result was manually overridden, as well as backend-only sessions, it will provide different results from Link-based conversion metrics, especially if you use a combination of backend-based sessions and Link-based sessions. Whether it makes more sense to report on overall conversion or Link-based conversion will depend on your use case.

Was this helpful?
Developer community
GitHub
GitHub
Stack Overflow
Stack Overflow
YouTube
YouTube
Discord
Discord