canonical: https://jentic.com/apis/signzy.com/signzy

# Signzy API

Signzy API provides digital identity verification and video KYC (Know Your Customer) services. It supports user authentication, video KYC session management, identity document verification, and real-time verification workflows. The API exposes 5 endpoints secured with bearer authentication.

## For AI agents

Programmatically authenticate user, create a video kyc session. Covers 5 operations with bearer authentication.

## Scope

Does not handle payments, communications, or crm - use for identity and authentication only.

## Capabilities

- Authenticate user
- Create a video KYC session
- Get VKYC session status
- Verify identity document
- Initialize e-signature

## Use cases

### Identity and Authentication Operations

Use the Signzy API to perform identity auth operations programmatically. The API provides 5 endpoints covering core functionality including authenticate user, create a video kyc session, get vkyc session status.

Example prompt: Call POST /login to authenticate user

### Automated Esign Management

Automate esign operations by combining multiple Signzy API endpoints. Agents can create a video kyc session and then get vkyc session status in a single workflow.

Example prompt: Call POST `/vkyc/session` to create a video kyc session, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call Signzy API endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle bearer tokens manually.

Example prompt: Search Jentic for 'authenticate user', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/login` | Authenticate user |
| POST | `/vkyc/session` | Create a video KYC session |
| GET | `/vkyc/session/{sessionId}` | Get VKYC session status |
| POST | `/identity/verify` | Verify identity document |
| POST | `/esign/init` | Initialize e-signature |

## Key resources

- **Esign** — Operations for esign
- **Identity** — Operations for identity
- **Login** — Operations for login
- **Vkyc** — Operations for vkyc

## AI readiness

This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.

- **Score:** 69 / 100
- **Maturity:** AI-Aware
- **Dimensions:**
  - Foundational Compliance: 100 / 100
  - Developer Experience & Jentic Compatibility: 63 / 100
  - AI-Readiness & Agent Experience: 48 / 100
  - Agent Usability: 94 / 100
  - Security: 75 / 100
  - AI Discoverability: 80 / 100
- **View full report:** https://jentic.com/apis/signzy.com/signzy/scorecard
- **How the score is calculated:** https://docs.jentic.com/reference/api-readiness-framework/overview/
- **More about the dimensions:** https://docs.jentic.com/reference/api-readiness-framework/specification/#dimensional-model-overview

### Score it yourself

Every API in the directory is allowlisted, so you can re-score it with no key required.

- **Score your own API:** https://jentic.com/scorecard.md
- **Scoring CLI agent skill:** https://github.com/jentic/jentic-api-scorecard/blob/main/skills/jentic-api-scorecard/SKILL.md

```sh
npx @jentic/api-scorecard-cli score <openapi-url>
```

## Why Jentic

- **Setup:** Wiring Signzy by hand means learning its bearer token auth, logging in for a token, and pointing calls at https://api.signzy.com/api/v3 across its KYC and identity operations. Through Jentic you install once, import Signzy from the API Directory, store the token once, and your agent calls it.
- **Permission scoping:** Signzy takes verification targets in the request body for login, identity verification, and e-sign, so limit the agent to the operations it needs, such as starting a video KYC session or verifying an identity. You choose the operations it may call, so anything you do not add stays unavailable to the agent.
- **Credential handling:** Your Signzy token 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.
- **Discovery method:** Agents search Jentic by intent such as 'start a video KYC session' or 'verify an identity', and Jentic returns the matching Signzy operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Auth0** — Alternative identity auth API
- **Okta** — Alternative identity auth API

## FAQ

### What authentication does the Signzy API use?

The Signzy API uses a Bearer token in the Authorization header. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context.

### Can I authenticate user with the Signzy API?

Yes. Use the POST /login endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the Signzy API?

Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer.

### How do I authenticate user through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'authenticate user'. Jentic returns the matching Signzy API operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the Signzy API have?

The Signzy API exposes 5 endpoints covering esign, identity, login operations.

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

Yes. Because Jentic One is self-hosted by you, your own rules decide which Signzy operations and credentials the agent may use, so you add only the endpoints it needs, such as starting a video KYC session or verifying an identity document, and leave out the rest. If you never add operations like authenticating a user or initializing an e-signature, they stay unavailable to the agent. The Signzy token is injected at execution time under your control, so the agent can call only what you have explicitly allowed.