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

# Sivo API

Sivo provides debt-as-a-service. The API allows companies to access debt funding and lend money to their users at scale, covering lending (loans, debt lines, yield accounts), banking (beneficiaries, payments, transactions), and reporting. The API exposes 24 endpoints secured with bearer authentication.

## For AI agents

Programmatically create business borrower, create consumer borrower. Covers 24 operations with bearer authentication.

## Scope

Does not handle communications, crm, or developer tools - use for payments only.

## Capabilities

- Create business borrower
- Report on loan
- List debt lines
- Get debt line by ID
- Draw from a debt line

## Use cases

### Payments Operations

Use the Sivo API to perform payments operations programmatically. The API provides 24 endpoints covering core functionality including create business borrower, create consumer borrower, create a loan.

Example prompt: Call POST /borrowers/businesses to create business borrower

### Automated Borrowers Management

Automate borrowers operations by combining multiple Sivo API endpoints. Agents can create consumer borrower and then create a loan in a single workflow.

Example prompt: Call POST /borrowers/consumers to create consumer borrower, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call Sivo 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 'create business borrower', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | /borrowers/businesses | Create business borrower |
| POST | /borrowers/consumers | Create consumer borrower |
| POST | /loans | Create a loan |
| POST | /reports | Report on loan |
| GET | /lending/debt-lines | List debt lines |
| GET | /lending/debt-lines/{id} | Get debt line by ID |
| POST | /lending/debt-lines/{id}/draw | Draw from a debt line |
| POST | /lending/debt-lines/{id}/pay | Pay debt line principal |

## Key resources

- **Borrowers** — Manage borrowers (business and consumer)
- **Loans** — Create and report on loans
- **Debt Lines** — Manage debt lines - draw and pay
- **Yield Accounts** — Manage yield accounts
- **Banking Beneficiaries** — Manage banking beneficiaries

## Why Jentic

- **Setup:** Wiring the Sivo API by hand means setting up its Cognito-issued bearer token, targeting the dev.sivo.com host, and carrying the token across every borrower, loan, and debt-line call yourself. Through Jentic you install once, import Sivo from the API Directory, store the token once, and your agent calls it.
- **Permission scoping:** Sivo puts the debt-line id in the URL path (/lending/debt-lines/{id}), so a rule can pin your agent to one debt line: it can read that line and nothing else. You choose the operations it may call, so money-moving ones like drawing or paying against a debt line are not included unless you add them.
- **Credential handling:** Your Sivo 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 'create a business borrower' or 'list debt lines', and Jentic returns the matching Sivo operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Stripe** — Alternative payments API
- **Adyen** — Alternative payments API
- **Square** — Complementary payments API
- **Paypal** — Complementary payments API

## FAQ

### What authentication does the Sivo API use?

The Sivo 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 create business borrower with the Sivo API?

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

### What are the rate limits for the Sivo 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 create business borrower through Jentic?

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

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

The Sivo API exposes 24 endpoints covering borrowers, loans, debt lines operations.

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

Yes. Jentic One is self-hosted, so your own rules decide which Sivo operations and credentials the agent can use. Because Sivo carries the debt-line id in the URL path (/lending/debt-lines/{id}), a rule can pin the agent to a single debt line and let it only read that line. You also choose the exact operations it may call, so money-moving actions like drawing from or paying against a debt line stay off unless you explicitly add them.
