Get Verification Status

Overview

get_verification_status checks the status of the current user's identity verification, most recently started via initiate_identity_verification. Use this to confirm whether the user has reached IAL2 before attempting an IAL2 connection with create_connection.

Returns

A dictionary with a verification_status key (nullable — null if no verification has ever been started for this user). When present:

  • id, resource_type
  • status — the verification status code.
  • status_date, last_performed — when the status was last set / verification last ran.
  • validation_process — list of {text, coding: [{code, display, system}]} describing the validation method(s) used.
  • error_codeSERVER_ERROR or PERSON_MATCH_ERROR, if verification failed (nullable).
  • target_location — list of strings (nullable).
  • next_scheduled — date of the next scheduled verification attempt, if any (nullable).
  • failure_action{text, coding: [...]} describing what to do next on failure (nullable).

Notes

Read-only.


Did this page help you?