canonical: https://jentic.com/apis/sandbox.linkcy.cloud/sandbox-linkcy-cloud

# Sandbox Linkcy Linkcy Api

Overview This is the partner API from [linkcy](https://linkcy.io/). Here you can find our API documentation. LinkCy API allows you to create fully embedded banking products for your own company or consumers. This API is backed by all mandatory requirements by financial authorities. To process, information provided into the API must be accurate. Authentication You can obtain a LinkCy Authorization . The API exposes 102 endpoints secured with bearer authentication.

## For AI agents

Programmatically update a rule from card, create a default card profile rule. Covers 102 operations with bearer authentication.

## Scope

Does not handle payments, communications, or crm - use for finance and accounting only.

## Capabilities

- Update a rule from card
- Create a default card profile rule
- Verify phone verification code
- Send phone verification code by sms
- Monitor Linkcy API operational status and events

## Use cases

### Finance and Accounting Operations

Use the Linkcy API to perform finance operations programmatically. The API provides 102 endpoints covering core functionality including update a rule from card, create a default card profile rule, verify phone verification code.

Example prompt: Call PUT `/api/partner/cards/{cardId}/rules` to update a rule from card

### Automated Card Management

Automate card operations by combining multiple Linkcy API endpoints. Agents can create a default card profile rule and then verify phone verification code in a single workflow.

Example prompt: Call PUT `/api/partner/card-profiles/{cardProfileId}/rules` to create a default card profile rule, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call Linkcy 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 'update a rule from card', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| PUT | `/api/partner/cards/{cardId}/rules` | Update a rule from card |
| PUT | `/api/partner/card-profiles/{cardProfileId}/rules` | Create a default card profile rule |
| POST | `/api/partner/verifications/phone/verify` | Verify phone verification code |
| POST | `/api/partner/verifications/phone/send` | Send phone verification code by sms |
| POST | `/api/partner/verifications/email/send` | Send an email verification link by email |
| POST | `/api/partner/verifications/address` | Verify the address of an end-user |
| POST | `/api/partner/transactions` | Create a transaction to a beneficiary |
| GET | `/api/partner/transactions` | List transactions |

## Key resources

- **Card** — Operations related to Card
- **KYB** — Operations related to KYB
- **Ledger** — Operations related to Ledger
- **Sandbox** — Operations related to Sandbox
- **KYC** — Operations related to KYC

## Why Jentic

- **Setup:** Wiring the Linkcy API by hand means learning its bearer auth, mapping its card, verification, and transaction endpoints on the sandbox host, and handling paging and retries yourself. Through Jentic you install once, import Linkcy from the API Directory, store the bearer token once, and your agent calls it.
- **Permission scoping:** Linkcy puts the card and profile ids in the URL path (`/api/partner/cards/{cardId}/rules`, `/api/partner/card-profiles/{cardProfileId}/rules`), so a rule can pin your agent to specific cards or profiles: it can read or update the ones you allow and nothing else. You choose the operations it may call, so actions like creating transactions are not included unless you add them.
- **Credential handling:** Your Linkcy bearer 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 'update a card rule' or 'send a phone verification', and Jentic returns the matching Linkcy operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Plaid** — Alternative finance API
- **Xero** — Alternative finance API

## FAQ

### What authentication does the Linkcy API use?

The Linkcy 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 update a rule from card with the Linkcy API?

Yes. Use the PUT `/api/partner/cards/{cardId}/rules` endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the Linkcy 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 update a rule from card through Jentic?

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

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

The Linkcy API exposes 102 endpoints covering card, kyb, ledger operations.

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

Yes. Because you run Jentic One yourself, your own rules decide which Linkcy operations and credentials the agent may use. Since Linkcy puts card and profile IDs in the URL path (for example `/api/partner/cards/{cardId}/rules` and `/api/partner/card-profiles/{cardProfileId}/rules`), you can pin the agent to specific cards or profiles and let it read or update only those. You also choose which operations it may call, so higher-risk actions such as creating transactions at `/api/partner/transactions` are excluded unless you add them.