Install Jentic One Beta

Connect the Authy API to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Authy 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%2Fauthy.com%2Fauthy" | 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%2Fauthy.com%2Fauthy" | 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 Authy API.

Verify a TOTP code submitted by a user via GET /protected/json/verify/{token}/{authy_id}

Send a one-time password by SMS via GET /protected/json/sms/{authy_id}

Send a one-time password by voice call via GET /protected/json/call/{authy_id}

Run standalone phone verification flows via /protected/json/phones/verification/start and /check

GET STARTED

Start building with Authy API

Explore with Jentic One

View OpenAPI Document

Use Cases

Patterns agents use Authy API for, with concrete tasks.

★ SMS-based two-factor authentication

Add a second factor to an existing login by sending an SMS code after the password check. Register the user once with POST /protected/json/users/new (which returns an authy_id), then on each login call GET /protected/json/sms/{authy_id} to send a fresh code and GET /protected/json/verify/{token}/{authy_id} to validate the code the user entered. Total integration is typically a day or two for a single login surface.

Register the user with their phone number, then on login call /sms/{authy_id} and verify the user-supplied token at /verify/{token}/{authy_id}

OneTouch push approval for sensitive actions

Replace SMS with a richer in-app push approval for high-value actions like wire transfers or password changes. POST /onetouch/json/users/{authy_id}/approval_requests sends a notification to the user's Authy app with a custom message and metadata; GET /onetouch/json/approval_requests/{uuid} polls until the user approves or denies. Push approval avoids SMS interception risks and gives the user full context about what they are approving.

POST /onetouch/json/users/{authy_id}/approval_requests with a message and details, then poll /approval_requests/{uuid} until status is approved or denied

Standalone phone-number verification

Verify that a user owns the phone number they entered during signup, without enrolling them in full 2FA. POST /protected/json/phones/verification/start sends a code by SMS or voice and GET /protected/json/phones/verification/check validates the code. This is a simpler flow than full Authy registration and is useful for account recovery or KYC-light steps.

POST /protected/json/phones/verification/start with phone_number and country_code, then GET /protected/json/phones/verification/check with the code the user entered

Agent-driven step-up authentication

An AI agent performing a sensitive action on behalf of a user can request a step-up via OneTouch before proceeding. The agent calls POST /onetouch/json/users/{authy_id}/approval_requests, surfaces the details to the user via push, and only continues when the approval status flips to approved. Through Jentic the X-Authy-API-Key is held in the credential vault, so the agent never sees the raw API key.

Send a OneTouch approval request describing the action, then poll the approval until the user accepts or rejects before continuing

Key Endpoints

12 endpoints — jentic publishes the only available openapi specification for authy api, keeping it validated and agent-ready.

METHOD

PATH

DESCRIPTION

POST

/protected/json/users/new

GET

/protected/json/verify/{token}/{authy_id}

Verify a TOTP token

GET

/protected/json/sms/{authy_id}

Send an SMS OTP

GET

/protected/json/call/{authy_id}

Send a voice OTP

POST

/onetouch/json/users/{authy_id}/approval_requests

Trigger a OneTouch approval

GET

/onetouch/json/approval_requests/{uuid}

Poll a OneTouch approval status

POST

/protected/json/phones/verification/start

Start a phone verification flow

POST

/protected/json/users/new

GET

/protected/json/verify/{token}/{authy_id}

Verify a TOTP token

GET

/protected/json/sms/{authy_id}

Send an SMS OTP

GET

/protected/json/call/{authy_id}

Send a voice OTP

POST

/onetouch/json/users/{authy_id}/approval_requests

Trigger a OneTouch approval

GET

/onetouch/json/approval_requests/{uuid}

Poll a OneTouch approval status

POST

/protected/json/phones/verification/start

Start a phone verification flow

Why Jentic?

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

Setup

Wiring the Authy API by hand means managing the X-Authy-API-Key header, registering users, and coordinating OTP delivery, phone verification, and push approvals yourself. Through Jentic you install once, import the Authy API from the API Directory, store the key once, and your agent calls it.

Permission scoping

Authy puts the user id in the URL path (/protected/json/sms/{authy_id}), so a rule can pin your agent to one enrolled user: it can send that user an SMS or voice OTP and check approvals and nothing else. You choose the operations it may call, so registering new users at /protected/json/users/new is not included unless you add it.

Credential isolation

Your Authy X-Authy-API-Key is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.

Intent-based discovery

Agents search Jentic by intent such as 'send an SMS 2FA code' or 'trigger a push approval', and Jentic returns the matching Authy operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

FAQs

Specific to using Authy API through Jentic.

Why is there no official OpenAPI spec for Authy API?

Twilio does not publish an OpenAPI specification for Authy. Jentic generates and maintains this spec so that AI agents and developers can call Authy 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 Authy API use?

Authy uses an API key sent in the X-Authy-API-Key header on every request. The key is issued per Authy application in the Twilio console. Through Jentic the API key is stored in the credential vault and injected at call time, so agents never see the raw key value.

Is the Authy API still supported?

Twilio deprecated the Authy API in November 2022 in favour of Twilio Verify. Existing Authy applications continue to function, but new integrations should target Twilio Verify. This spec is most useful for maintaining or migrating existing Authy deployments.

How do I send a 2FA SMS code with the Authy API?

After registering the user with POST /protected/json/users/new and storing the returned authy_id, call GET /protected/json/sms/{authy_id} to deliver a fresh OTP. Validate the user's submitted code with GET /protected/json/verify/{token}/{authy_id} where {token} is the code.

How do I trigger a OneTouch push approval through Jentic?

Search Jentic for 'send a push approval request', load the POST /onetouch/json/users/{authy_id}/approval_requests operation, and execute it with the user's authy_id, a message, and a details object. Poll /onetouch/json/approval_requests/{uuid} for the result. Get started with Jentic One, the self-hosted execution layer.

What are the rate limits for the Authy API?

Authy applies per-account quotas managed in the Twilio console rather than the OpenAPI spec. SMS and voice OTP throughput is throttled by carrier limits as well; if you hit a 429, back off exponentially and review the application's quota in the Twilio dashboard.

Can I limit what my agent is allowed to do with the Authy API?

Yes. Because you run Jentic One yourself, your own rules decide which Authy operations and credentials the agent may use. Authy puts the user id in the URL path, such as /protected/json/sms/{authy_id}, so you can pin the agent to one enrolled user and let it send that user an SMS or voice OTP and check OneTouch approvals and nothing else. Registering new users at /protected/json/users/new is excluded unless you explicitly add it, and the X-Authy-API-Key stays with your instance rather than the agent.

Authy API

Name: Authy API
Brand: Authy API
Availability: InStock

Agent-ready OpenAPI document · curated by JenticIdentity AuthAuthenticationapiKey12 EndpointsREST

Know of an official OpenAPI document? Contribute it →

For Agents

Register a user for two-factor authentication, send an SMS or voice OTP, verify a TOTP token, and trigger a OneTouch push approval. Useful for maintaining existing Authy 2FA integrations.

Use for: Enroll a user for two-factor authentication, Send an SMS one-time password to a user, Verify a TOTP code from an authenticator app, Trigger a OneTouch push approval on a user's phone

Not supported: Does not handle primary password login, user directories, or fraud scoring - use for two-factor authentication, OTP delivery, and phone verification only.

Jentic publishes the only available OpenAPI specification for Authy API, keeping it validated and agent-ready. Authy is Twilio's two-factor authentication API, providing TOTP enrolment, SMS and voice OTP delivery, phone number verification, and OneTouch push approvals. It is intended for applications that need to add a second factor on top of an existing username-and-password login. Note that Authy has been deprecated by Twilio since November 2022 in favour of Twilio Verify; new integrations should use Twilio Verify, but this spec remains useful for maintaining existing Authy deployments.

Jentic One on Github View OpenAPI Document

Connect the Authy API to your agent

Capabilities

Start building with Authy API

Use Cases

Key Endpoints

Why Jentic?

Related APIs

FAQs

Authy API