IdRamp Identity Verification API - Overview (1.0)

Copy

• Copy for LLM

  Copy page as Markdown for LLMs
• View as Markdown

  Open this page as Markdown
• Open in ChatGPT

  Get insights from ChatGPT
• Open in Claude

  Get insights from Claude

Key Capabilities

• Start Verification (POST /api/v1/verification): Create a new verification session for a user, specifying the IdRamp Identity Verifier configuration to use. Returns a session identifier and a provider URL where the verification flow begins.

• Get Verification Status (GET /api/v1/verification/{identityVerifierId}/status/{verificationId}): Retrieve the current state of a verification session (started, completed). Useful for polling the session progress without fetching detailed results.

• Get Verification Result (GET /api/v1/verification/{identityVerifierId}/{verificationId}): Fetch the full verification outcome once a session completes, including status (success, fail, canceled), provider user ID, and verified user traits such as name, email, phone, and document information.

• Match Utility (POST /api/v1/verification/match): Evaluate custom rules to compare and match data across two records (e.g., source vs. target). Supports logical and fuzzy matching (e.g., equality, Levenshtein ratio) with detailed per-rule results.

Authentication

All endpoints require an API key sent in the request header:

Typical Flow

1. Client calls Start Verification to create a session and obtain the provider launch URL.
2. End-user completes verification via the provider interface.
3. Client waits for user to be redirected back to returnUrl specified at Start signalling completion. Alternatively, the Client polls Get Status until completion.
4. Once completed, client calls Get Result to retrieve verified attributes.
5. Optionally, client uses Match Utility to compare verified data with existing records.