canonical: https://jentic.com/apis/alloy.co/alloy

# Alloy API

The Alloy API runs identity and fraud decisioning for onboarding people and businesses. It creates and updates person and business entities, runs them through configured evaluations and journeys, and returns the decision outcomes along with the inputs each workflow expects. It also manages lists, entity feedback, and journey applications. Responses are JSON, so an agent can submit an applicant, read the verification result, and act on it without building its own decision engine.

## For AI agents

Create person and business entities, run identity and fraud evaluations and journeys, and read decision outcomes.

## Scope

Runs identity and business decisions through Alloy's entities, evaluations, and journeys; it does not configure the underlying workflows, data sources, or rules, which are set up in the Alloy dashboard.

## Capabilities

- Create and update person and business entities
- Run entities through evaluations and journey applications
- Read evaluation outcomes and the inputs each workflow requires
- Manage lists of entities and their metadata
- Record and retrieve entity feedback
- Merge duplicate entities

## Use cases

### Verify an applicant during onboarding

Signing up a new customer often needs an identity check before the account can proceed. The Alloy API creates a person entity and runs it through the configured evaluation, returning a decision the application can act on. The response records the outcome so onboarding can approve, deny, or route the applicant for review.

Example prompt: Create a person entity and run it through the identity evaluation, then read the decision.

### Onboard and verify a business

Bringing on a business customer requires checking the entity and its principals. The Alloy API creates a business entity and evaluates it, so an application can confirm a company against Alloy's configured data sources. The evaluation outcome tells the caller whether the business passed, failed, or needs manual review.

Example prompt: Create a business entity and evaluate it, then return the verification outcome.

### Run a multi-step journey application

A verification flow may chain several checks into one journey. The Alloy API starts a journey application for an applicant and reports its status, letting an application drive a multi-step decision without recreating the logic. Journey parameters describe the inputs each step expects.

Example prompt: Create a journey application for an applicant and read its status and outcome.

### Agent-driven identity checks

An AI agent can verify an applicant for a user without a developer wiring each call. Through Jentic the agent matches an intent such as 'verify this new customer' to the Alloy operation that creates and evaluates the entity, runs it, and reads the decision. The credential stays in the user's Jentic One instance and never reaches the agent's prompt.

Example prompt: Create the entity, run the configured evaluation, and return the decision outcome.

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/entities/persons` | Create a person entity. |
| POST | `/entities/businesses` | Create a business entity. |
| GET | `/entities/{entity_token}` | Retrieve information about an entity. |
| POST | `/journeys/{journey_token}/applications` | Start a journey application for an applicant. |
| GET | `/evaluations/{evaluation_token}` | View an evaluation and its outcome. |
| GET | `/parameters` | List the required and optional inputs for a request. |

## Key resources

- **Entities** — Create, retrieve, and update person and business records.
- **Evaluations** — Run entities through decisions and read their outcomes.
- **Journeys** — Drive multi-step journey applications for applicants.
- **Lists** — Group entities and manage list metadata.

## Why Jentic

- **Setup:** Wiring Alloy yourself means managing a Basic or OAuth2 credential, mapping applicants to the right evaluation or journey, and reading decision outcomes. With Jentic you install once, import Alloy from the API Directory, and store the credential a single time.
- **Permission scoping:** Jentic lets you grant your agent only the operations it needs, such as creating entities and reading evaluations without entity merges or list changes, and enforces that on every call.
- **Credential handling:** Your Alloy credential is stored once, encrypted, by your own Jentic One instance. It is injected when a call runs and never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents find Alloy through Jentic's intent search, matching a request like 'verify this new applicant' to the right operation without hardcoded endpoints.

## Related APIs

- **Onfido** — Document and biometric identity verification.
- **Sift** — Machine-learning fraud detection and risk scoring.
- **Plaid** — Bank account linking and identity data.

## FAQ

### What can an AI agent do with the Alloy API through Jentic?

An agent can create person and business entities, run them through evaluations and journeys, and read the decision outcomes. Through Jentic the agent matches an intent to the right operation and runs it with your credential injected at execution time.

### How do I authenticate with the Alloy API?

Alloy supports HTTP Basic authentication and an OAuth2 client-credentials bearer token obtained from the token endpoint. You store the credential once in your Jentic One instance, and it is added to each call at run time rather than exposed to the agent.

### Does Alloy verify both people and businesses?

Yes. The API has separate operations to create and evaluate person entities and business entities, so an application can run identity checks for individuals and company checks for organizations. Each evaluation returns an outcome the caller can act on.

### Does the Alloy API document rate limits?

The OpenAPI specification does not state rate limits; request allowances depend on your Alloy agreement. Check the current limits for your account in Alloy's documentation and dashboard.

### Can I restrict what my agent is allowed to do with the Alloy API?

Yes. Jentic lets you allow only the operations your agent needs, for example creating entities and reading evaluations while withholding entity merges and list changes. Your Jentic One instance enforces that boundary on every call and keeps the credential outside the agent's context.
