IDWise API
Agent-ready OpenAPI document · curated by JenticIdentity AuthIdentity Verificationbasic13 EndpointsREST
Know of an official OpenAPI document? Contribute it →
For Agents
Run KYC and identity verification journeys with document checks, facial biometrics, proof of address, and AML screening through IDWise's hosted flow.
Use for: I want to verify a customer's identity with document and selfie checks, Start a new KYC journey for an applicant, Generate a hosted verification link to email to the user, Retrieve the verification result for a completed journey
Not supported: Does not handle payment processing, credit checks, or full case management - use for KYC document, biometric, and AML verification only.
Jentic publishes the only available OpenAPI specification for IDWise API, keeping it validated and agent-ready. IDWise provides identity verification including document authentication, facial biometrics, proof of address, and AML screening. Agents can start a verification journey, process individual journey steps, complete the journey, retrieve verification results and summaries, generate hosted verification links, and submit manual review decisions. The API also exposes audit logs and supports regional endpoints for the UAE and a QA environment.
Install Jentic One Beta
Connect the IDWise API to your agent
Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the IDWise 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.
1
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%2Fidwise.com%2Fidwise" | sh2
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%2Fidwise.com%2Fidwise" | sh
jentic register # connects your agent to your Jentic One instanceJentic 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 IDWise API.
Start a verification journey for a new applicant via POST /v2/start-journey
Process individual verification steps such as document upload and selfie capture
Generate hosted verification links to send to end users via /v2/verification-links
Retrieve verification results and journey summaries by journey ID
Submit manual review decisions on borderline verification outcomes
Pull audit logs for compliance and dispute investigations
Use Cases
Patterns agents use IDWise API for, with concrete tasks.
★ Customer KYC Onboarding
Run document and biometric KYC during onboarding for fintech, crypto, and gaming platforms. The agent calls POST /v2/start-journey to create the journey, sends a hosted verification link to the user, then polls GET /v2/get/{JOURNEY_ID} for the structured result including extracted document fields, face match score, and liveness verdict. Typical completion in minutes, with manual review fallback for ambiguous cases.
Start a journey for applicant 'user-1024', generate a hosted link, then poll /v2/get/{JOURNEY_ID} until the journey status is COMPLETED.
AML Screening with Proof of Address
Combine identity verification with AML watchlist screening and proof-of-address checks for regulated industries. IDWise runs sanctions, PEP, and adverse-media screening alongside the document check, then returns a consolidated verdict the agent can use to auto-approve, escalate, or reject the applicant.
Retrieve the journey summary via GET /v2/summary/{journey_id} and route to manual review if AML hits are present.
Manual Review Workflow
When automated checks return a borderline result, an agent or compliance officer submits a manual review decision via POST /v2/manual-review/{JOURNEY_ID}. This use case covers the queue management and decision-recording side of identity verification, with full audit trail through GET /audit-logs.
Submit a manual review decision of 'APPROVED' on a flagged journey and pull the audit log entry to confirm it was recorded.
AI Agent KYC Orchestration
An AI agent in a banking or crypto onboarding flow runs end-to-end KYC: it triggers IDWise, monitors the journey, parses the verdict, and writes the decision back to the customer record. Through Jentic, the agent discovers the right operations from a single search query without reading IDWise's docs.
Use Jentic to call POST /v2/start-journey for an applicant, wait for completion, and surface the verdict in chat.
Key Endpoints
13 endpoints — jentic publishes the only available openapi specification for idwise api, keeping it validated and agent-ready.
METHOD
PATH
DESCRIPTION
POST
/v2/start-journey
Start a new identity verification journey
POST
/v2/process-journey-step
Process an individual journey step
POST
/v2/complete-journey
Mark a journey complete
GET
/v2/get/{JOURNEY_ID}
Retrieve verification results
GET
/v2/summary/{JOURNEY_ID}
Get journey summary
POST
/v2/verification-links
Create a hosted verification link
POST
/v2/manual-review/{JOURNEY_ID}
Submit a manual review decision
GET
/audit-logs
Retrieve verification audit logs
POST
/v2/start-journey
Start a new identity verification journey
POST
/v2/process-journey-step
Process an individual journey step
POST
/v2/complete-journey
Mark a journey complete
GET
/v2/get/{JOURNEY_ID}
Retrieve verification results
GET
/v2/summary/{JOURNEY_ID}
Get journey summary
POST
/v2/verification-links
Create a hosted verification link
POST
/v2/manual-review/{JOURNEY_ID}
Submit a manual review decision
GET
/audit-logs
Retrieve verification audit logs
Why Jentic?
What agents get from Jentic-routed access to this vendor.
Setup
Wiring IDWise by hand means encoding its Basic auth, picking the right host between the default and the UAE region endpoint, and threading the multi-step journey lifecycle yourself. Through Jentic you install once, import the IDWise API from the API Directory, store the credentials once, and your agent calls it.
Permission scoping
IDWise puts the journey id in the URL path (/v2/get/{JOURNEY_ID}, /v2/summary/{JOURNEY_ID}), so a rule can pin your agent to reading and reviewing a specific journey. You choose the operations it may call, so starting or manually reviewing journeys is not included unless you add it.
Credential isolation
Your IDWise Basic auth username and password 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 customer's identity' or 'get a journey summary', and Jentic returns the matching IDWise journey operation with its input schema so the agent calls the right endpoint without browsing the reference docs.
Related APIs
Alternatives and complements available in the Jentic catalogue.
Complementary
Stripe API
Stripe handles payments after the user passes IDWise KYC.
Combine Stripe with IDWise in fintech onboarding: verify the user with IDWise, then create a Stripe customer and payment method.
FAQs
Specific to using IDWise API through Jentic.
Why is there no official OpenAPI spec for IDWise API?
IDWise does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call IDWise 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 IDWise API use?
IDWise uses HTTP Basic authentication. Through Jentic, the credentials are held in the vault and injected at execution time, so the agent never receives the raw username and password.
Can I run AML screening with the IDWise API?
Yes. The verification journey returned via GET /v2/get/{JOURNEY_ID} includes AML screening output alongside document and biometric checks, configurable per applicant.
How do I generate a hosted verification link for a user?
Call POST /v2/verification-links with the journey configuration. IDWise returns a URL you send to the end user; their results flow back into the journey, retrievable by GET /v2/summary/{JOURNEY_ID}.
What are the rate limits for the IDWise API?
The OpenAPI spec does not declare explicit rate limits. IDWise enforces account-tier throttles agreed in the contract; handle 429 responses with exponential backoff.
How do I run a KYC journey through Jentic?
Run pip install jentic, then search 'verify a customer's identity', load the schema for POST /v2/start-journey, and execute with the applicant details. Poll GET /v2/get/{JOURNEY_ID} for the verdict.
Can I limit what my agent is allowed to do with the IDWise API?
Yes. Jentic One is self-hosted by you, so your own rules decide which IDWise operations and credentials the agent may use. Because IDWise puts the journey id in the URL path, such as GET /v2/get/{JOURNEY_ID} and GET /v2/summary/{JOURNEY_ID}, you can pin the agent to reading and reviewing a specific journey. You choose the operations it may call, so write actions like POST /v2/start-journey or POST /v2/manual-review/{JOURNEY_ID} are excluded unless you add them.
GET STARTED