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://jentic.com/install.sh?src=apis&api=%2Fapis%2Fid.me%2Fid-me" | sh

Step 2: Agent machine

# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fid.me%2Fid-me" | 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

List supported affiliation groups (military, first responder, student, teacher, nurse) via /groups

Confirm a user's membership in a specific group through /groups/{groupId}/verify

GET STARTED

Start building with ID.me API

Explore with Jentic One

View OpenAPI Document

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?

What agents get from Jentic-routed access to this vendor.

Setup

Wiring the ID.me API by hand means running its OAuth2 authorize and token exchange and mapping its userinfo and group verification routes yourself. Through Jentic you install once, import the ID.me API from the API Directory, store the OAuth credentials once, and your agent calls it.

Permission scoping

ID.me puts the group id in the URL path (/groups/{groupId}/verify), so a rule can pin your agent to verifying membership for one group. You choose the operations it may call, so reading full user profile info is not included unless you add it.

Credential isolation

Your ID.me OAuth credentials are stored once, encrypted, by your own Jentic One instance and injected at execution time. They never enter the agent's prompt, logs, or context.

Intent-based discovery

Agents search Jentic by intent such as 'verify a user's group affiliation' or 'read a verified user's info', and Jentic returns the matching ID.me operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

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 with Jentic One, the self-hosted execution layer.

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 your Jentic One instance 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. Run Jentic One, the self-hosted execution layer, 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.

Can I limit what my agent is allowed to do with the ID.me API?

Yes. Because you run Jentic One yourself, your own rules decide which ID.me operations the agent may call and which OAuth credentials it may use. Since ID.me puts the group in the URL path at /groups/{groupId}/verify, you can pin the agent to verifying membership for a single group, such as military or student. And because you pick the operations, reading a full user profile through /userinfo is off limits unless you explicitly allow it.

ID.me API

AI ReadinessAI-Aware (B)66/100

See full scorecard

Agent-ready OpenAPI document · curated by JenticIdentity AuthIdentity Verificationoauth25 EndpointsREST

Know of an official OpenAPI document? Contribute it →

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.

Use for: Verify a customer's military status before applying a discount, Run an OAuth 2.0 login that confirms a user's identity, Get a verified user's name and email after they sign in, Check whether a user is a verified first responder

Not supported: Does not handle document scanning, biometric liveness checks, or KYC anti-fraud screening - use for OAuth-based identity verification and group affiliation checks only.

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.

Jentic One on Github View OpenAPI Document

Show dimension breakdown

100

Foundational Compliance

Base layer of spec validity and structural soundness.

Grade: A+Signals: 4

99%

Lint Results

Aggregated quality score from linter diagnostics, weighted by severity.

100%

Resolution Completeness

Percentage of `$ref` references that resolve successfully.

100%

Specification Validity

Checks whether the API description parses successfully and conforms to its declared specification (e.g., OpenAPI).

100%

Structural Integrity

Structural correctness score based on schema issues using logarithmic dampening.

Developer Experience & Jentic Compatibility

Clarity, completeness, and ingestion readiness for developers and tooling.

Grade: B-Signals: 4

Example Density

How richly the API is illustrated with examples.

100%

Example Validity

Percentage of examples that conform to their schemas.

45%

Response Coverage

Percentage of operations with complete response definitions (success, client error, server error).

100%

Tooling Readiness

Health of API ingestion, bundling, and resolution within Jentic pipelines.

AI-Readiness & Agent Experience

Semantic breadth, depth, and agent comprehension for AI systems.

Grade: FSignals: 4

29%

Description Coverage

Coverage of descriptions across API elements.

Error Standardization

Coverage of RFC 9457 Problem Details for error responses.

80%

OperationId Quality

Coverage, uniqueness, and casing consistency of operationIds for AI inference.

50%

Summary Coverage

Coverage of summaries across operations/tags/info.

Agent Usability

Functional utility, complexity comfort, and AI orchestration readiness.

Grade: A+Signals: 1

94%

Complexity Comfort

Agent comfort level based on API operational and structural complexity.

Security

Trust, risk posture, and security compliance.

Grade: A+Signals: 1

90%

Authentication Strength

Average quality of security schemes based on authentication method strength (weakest link for OAuth2).

100

AI Discoverability

Findability, semantic richness, and reasoning readiness.

Grade: A+Signals: 1

100%

Descriptive Richness

Clarity and depth of descriptions across API elements.

Connect the ID.me API to your agent

Capabilities

Start building with ID.me API

Use Cases

Key Endpoints

Why Jentic?

Related APIs

FAQs

ID.me API

Jentic AI Readiness Score

ID.me API

Foundational Compliance

Lint Results

Resolution Completeness

Specification Validity

Structural Integrity

Developer Experience & Jentic Compatibility

Example Density

Example Validity

Response Coverage

Tooling Readiness

AI-Readiness & Agent Experience

Description Coverage

Error Standardization

OperationId Quality

Summary Coverage

Agent Usability

Complexity Comfort

Security

Authentication Strength

AI Discoverability

Descriptive Richness