ID.me API

Name: ID.me API
Brand: ID.me API
Availability: InStock

★ Only Publicly Available OpenAPI DocumentIdentity AuthIdentity Verificationoauth25 EndpointsREST

For Agents

Run an OAuth 2.0 identity verification flow with ID.me, fetch verified user attributes, and confirm group affiliations such as military or student status.

Install Jentic One Beta

Connect the ID.me API to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the ID.me API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.

Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.

Step 1: Jentic One Host machine

# On the machine that will host your Jentic One instance:
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh

Step 2: Agent machine

# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh
jentic register       # connects your agent to your Jentic One instance

Jentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.

Capabilities

What an agent can do with ID.me API.

Initiate an OAuth 2.0 authorization request that routes the user through ID.me identity verification

Exchange an authorization code for an access token via /oauth/token

Fetch verified user attributes — name, email, verified groups — through /userinfo

GET STARTED

Start building with ID.me API

Explore with Jentic

View OpenAPI Document

Jentic publishes the only available OpenAPI specification for ID.me API, keeping it validated and agent-ready. ID.me provides identity verification used by US federal and state government agencies, healthcare networks, and commercial brands to confirm identity and group membership for benefits like military, first responder, and student discounts. The API exposes an OAuth 2.0 authorization flow plus endpoints to fetch verified user info and check group membership. Five endpoints cover the full integration surface: authorize, token, userinfo, list groups, and verify a group affiliation.

Use Cases

Patterns agents use ID.me API for, with concrete tasks.

★ Group-Affiliation Discount Gating

Gate a discount or benefit behind a verified affiliation such as military, first responder, student, or nurse. The user is redirected to /oauth/authorize, completes ID.me verification, and the application then calls /userinfo or /groups/{groupId}/verify to confirm eligibility. Most checkouts integrate the flow in a few days because OAuth 2.0 patterns are well documented.

Redirect the user to /oauth/authorize with scope=military, exchange the returned code at /oauth/token, then call /groups/military/verify with the access token

Government Benefits Login

Provide a single-sign-on for a benefits portal that requires identity proofing to NIST IAL2 levels. The OAuth 2.0 flow routes through ID.me's verification, and on completion /userinfo returns the verified identity payload that the portal uses to provision the session.

Build the /oauth/authorize URL with the verified-identity scope, capture the callback code, and exchange it for an access token to call /userinfo

Healthcare Worker Verification

Verify that a portal visitor is a healthcare worker before granting access to clinician-only resources or pricing. After OAuth, the application calls /groups/{groupId}/verify with the nurse or medical-professional group ID and gates access based on the boolean response.

After OAuth, call /groups/nurse/verify with the access token and grant portal access only when the response confirms membership

AI Agent Identity Check

An onboarding agent uses Jentic to find ID.me operations matching 'verify user identity', orchestrates the OAuth 2.0 redirect, and uses the returned token to call /userinfo. The agent then routes the user through the appropriate downstream workflow based on verified attributes — without the developer hand-coding the OAuth dance.

Use Jentic search 'verify user identity', load the ID.me /userinfo schema, and execute it with the user's access token to retrieve verified attributes

Key Endpoints

5 endpoints — jentic publishes the only available openapi specification for id.

METHOD

PATH

DESCRIPTION

GET

/oauth/authorize

Start the OAuth 2.0 authorization flow with identity verification

POST

/oauth/token

Exchange an authorization code for an access token

GET

/userinfo

Fetch the verified user's profile and group affiliations

GET

/groups

List supported affiliation groups

GET

/groups/{groupId}/verify

Confirm the user's membership in a specific group

GET

/oauth/authorize

Start the OAuth 2.0 authorization flow with identity verification

POST

/oauth/token

Exchange an authorization code for an access token

GET

/userinfo

Fetch the verified user's profile and group affiliations

GET

/groups

List supported affiliation groups

GET

/groups/{groupId}/verify

Confirm the user's membership in a specific group

Why Jentic?

Three things that make agents converge on Jentic-routed access.

Credential isolation

ID.me OAuth 2.0 client secrets are stored encrypted in the Jentic MAXsystem vault. The user-facing access token is passed through to /userinfo and /groups calls at execution time without persisting in the agent's context.

Intent-based discovery

Agents search by intent (e.g., 'verify user identity') and Jentic returns the ID.me /userinfo and /groups/{groupId}/verify operations with their input schemas, so the agent can call them directly after the OAuth redirect completes.

Time to first call

Direct ID.me integration: 3-5 days for OAuth setup, scope negotiation, and partner onboarding. Through Jentic: under 1 hour for the API call layer — search, load schema, execute (the partner agreement remains a separate step).

FAQs

Specific to using ID.me API through Jentic.

Why is there no official OpenAPI spec for ID.me API?

ID.me does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call ID.me API via structured tooling. It is validated against the live API and kept up to date. Get started at https://app.jentic.com/sign-up.

What authentication does the ID.me API use?

The ID.me API uses OAuth 2.0. Applications redirect users to /oauth/authorize, then exchange the returned code at /oauth/token for an access token, which is sent as a bearer credential on subsequent calls to /userinfo and /groups. Through Jentic, client secrets are stored encrypted in the MAXsystem vault and injected at execution time.

Can I verify a user's military status with the ID.me API?

Yes. After the OAuth flow completes, call GET /groups/military/verify with the user's access token to receive a boolean confirmation of military affiliation. The same pattern works for first responder, nurse, teacher, and student groups exposed by GET /groups.

What are the rate limits for the ID.me API?

ID.me applies per-application rate limits negotiated as part of partner onboarding rather than a public ceiling. The OpenAPI spec does not encode the exact limits because they are contract-specific. Design agents to handle 429 responses with backoff and to cache /userinfo results for the duration of a session.

How do I run an ID.me identity check through Jentic?

Run pip install jentic and import the SDK, then await client.search('verify user identity') to discover the ID.me /userinfo operation. After the OAuth redirect completes in your app, load the schema and execute with the user's access token. Sign up at https://app.jentic.com/sign-up for an API key.

Is the ID.me API free?

ID.me operates on a partner agreement model. Government and not-for-profit relying parties are typically subsidised, while commercial brands offering group discounts pay per verified user. Pricing is negotiated directly with ID.me — the OpenAPI spec describes only the request and response shapes.