---
canonical_url: "https://docs.composio.dev/toolkits/authyo"
markdown_url: "https://docs.composio.dev/toolkits/authyo.md"
product: "platform"
version: null
last_updated: null
---

# Authyo

Authyo provides passwordless authentication, OTP verification, session management, and transactional notifications through its REST API.

- **Category:** security & identity tools
- **Auth:** API_KEY
- **Composio-managed OAuth available?** N/A
- **Tools:** 5
- **Triggers:** 0
- **Slug:** `AUTHYO`
- **Version:** 00000000_00

## Tools

### Revoke Session

**Slug:** `AUTHYO_REVOKE_SESSION`

Irreversibly revoke an Authyo user session identified by its JWT, typically during logout.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `token` | string | Yes | Authyo session JWT to revoke. It is never returned or included in errors. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Send Order Notification

**Slug:** `AUTHYO_SEND_ORDER_NOTIFICATION`

Send a usage-billed order or payment notification through an Authyo built-in template; requires a configured sender. Delivery output never returns the recipient.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `to` | string | Yes | Recipient email address or international phone number appropriate for the selected channel. |
| `channel` | string ("SMS" | "Email" | "WhatsApp") | Yes | Notification delivery channel. |
| `variables` | object | No | Optional string values used by the selected template. Authyo does not document which values each template requires. |
| `template_type` | string ("order_placed" | "order_confirmed" | "order_shipped" | "order_out_for_delivery" | "order_delivered" | "order_cancelled" | "payment_succeeded" | "payment_failed" | "order_refunded" | "order_updated") | Yes | Built-in Authyo order or payment template to send. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Send OTP

**Slug:** `AUTHYO_SEND_OTP`

Send a usage-billed one-time password to an email address or international phone number using Authyo's configured sender. Delivery output never returns the recipient or OTP.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `to` | string | Yes | Recipient email address, or phone number including country code for SMS, WhatsApp, or voice delivery. |
| `otp` | string | No | Optional caller-supplied OTP. Treat as secret; omit to let Authyo generate one. |
| `origin` | string | No | Originating web URL when Authyo application policy uses origin context. |
| `channel` | string ("SMS" | "Email" | "WhatsApp" | "VoiceCall") | No | Delivery channel; omit to use the channel configured for the Authyo application. |
| `otp_length` | integer | No | Number of digits in the OTP; omit to use the Authyo application default. |
| `expiry_seconds` | integer | No | OTP validity period in seconds; omit to use the Authyo application default. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Verify OTP

**Slug:** `AUTHYO_VERIFY_OTP`

Verify a user-provided OTP for an Authyo mask ID and return the verified user identity without exposing the issued session JWT.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `otp` | string | Yes | One-time password supplied by the user. Authyo requires it in the query string; it is never returned or included in errors. |
| `origin` | string | No | Originating web URL when Authyo application policy uses origin context. |
| `mask_id` | string | Yes | OTP session identifier returned by Send OTP. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Verify Token

**Slug:** `AUTHYO_VERIFY_TOKEN`

Validate an Authyo session JWT and return its associated user identity without returning the JWT.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `token` | string | Yes | Authyo session JWT to validate. It is never returned or included in errors. |
| `origin` | string | No | Originating web URL when Authyo application policy uses origin context. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |