canonical: https://jentic.com/apis/limbo.work/limbo

# Limbo Work 00.1 Recuperação Partner Addition CDT

The Limbo employee credit API lets a partner run the acquisition flow for an employee credit offer: it checks whether a consumer is eligible, simulates an offer from a desired amount, installment count, employer CNPJ, and an insurance choice, and confirms the resulting proposal. Calls carry the consumer_id in a header and can be flagged as test calls with the is_test header, and access is granted through an OAuth2 client credentials token.

## For AI agents

Check a consumer's eligibility for employee credit, simulate an offer by amount and installments, and confirm the proposal.

## Scope

Does not disburse funds, collect installments, or run credit bureau reports. Use for the employee credit eligibility, simulation, and proposal confirmation flow only.

## Capabilities

- Check whether a consumer is eligible for employee credit using their consumer_id
- Simulate a credit offer from a desired amount, installment count, employer CNPJ, and insurance choice
- Confirm a credit proposal for a simulated solicitation
- Run any step of the flow as a test call with the is_test header
- Exchange a client_id and client_secret for a bearer token

## Use cases

### Agent-guided employee credit application through Jentic

An AI agent assisting an employee can check eligibility, run a simulation with the amount and number of installments the employee asks for, and confirm the proposal once they accept it. Through Jentic the agent finds the eligibility, simulation, and confirmation operations by intent and loads their schemas, while the OAuth2 client credentials stay out of its context.

Example prompt: Check eligibility for consumer_id 26252690, simulate an offer with desiredAmount 5000, desiredInstallment 12, the employer cnpj, and withInsurance true, then confirm the proposal by passing the same solicitation id in the solicitation_id header.

### Offer comparison with and without insurance

The simulation step takes a withInsurance flag, so a partner can run the same amount and installment count twice and show the employee both offers side by side before they commit to a proposal.

Example prompt: Run two simulations for desiredAmount 3000 and desiredInstallment 10, one with withInsurance true and one with withInsurance false, and report both results.

### Integration testing in test mode

Each acquisition call accepts an is_test header, which lets a partner exercise eligibility, simulation, and confirmation while building the integration, then drop the flag for live consumers.

Example prompt: Call the eligibility check with is_test set to true and consumer_id 12345 and confirm the call succeeds before switching to live consumers.

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/oauth2/token` | Get a client credentials token |
| GET | `/v1/employee-credit/eligibility` | Check consumer eligibility |
| POST | `/v1/employee-credit/simulation` | Simulate a credit offer |
| POST | `/v1/employee-credit/confirmation` | Confirm a credit proposal |

## Key resources

- **Eligibility** — Whether a consumer qualifies for employee credit
- **Simulation** — A credit offer computed from amount, installments, employer CNPJ, and insurance choice
- **Proposal confirmation** — Confirmation of the proposal for a solicitation
- **Token** — OAuth2 client credentials token exchange

## 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:** 0 / 100
- **Maturity:** Non-Ready
- **Dimensions:**
  - Foundational Compliance: 100 / 100
  - Developer Experience & Jentic Compatibility: 73 / 100
  - AI-Readiness & Agent Experience: 28 / 100
  - Agent Usability: 94 / 100
  - Security: 60 / 100
  - AI Discoverability: 0 / 100
- **View full report:** https://jentic.com/apis/limbo.work/limbo/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 Limbo by hand means running the OAuth2 client credentials exchange, attaching the bearer token, and setting the consumer_id and is_test headers on each acquisition call. Through Jentic you install once, import Limbo from the API Directory, store the client credentials once, and your agent calls it.
- **Permission scoping:** Limbo carries the consumer and solicitation in headers and the request body, not the URL path, so rules bound which operations your agent may call, not which consumer. You choose the operations it may call, so proposal confirmation is not included unless you add it.
- **Credential handling:** Your Limbo client credentials are stored once, encrypted, by your own Jentic One instance and injected at execution time. They never enter the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'check credit eligibility' or 'simulate a loan offer', and Jentic returns the matching Limbo operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **BeSmartee API** — Mortgage loan origination and pricing
- **CPFHub API** — Brazilian CPF identity lookup
- **Clicksign Envelope API** — Brazilian e-signature envelopes

## FAQ

### What authentication does the Limbo employee credit API use?

Per its OpenAPI spec the API uses HTTP bearer authentication. You get the token from the token operation by posting your client_id and client_secret with grant_type client_credentials, then send it in the Authorization header. Acquisition calls also carry a consumer_id header. Through Jentic the client credentials are stored encrypted by your own Jentic One instance and injected at request time.

### Is there a Limbo MCP server?

You don't need an MCP server to give your agent the Limbo employee credit API. Jentic connects it directly from the API Directory: import it, store your credential once, and your agent calls the eligibility, simulation, and confirmation operations on demand.

### Can I simulate a credit offer with the Limbo API?

Yes. The simulation operation takes cnpj, desiredAmount, desiredInstallment, solicitationId, and withInsurance in the body, with the consumer_id in a header, and returns the simulated offer for that consumer.

### What are the rate limits for the Limbo employee credit API?

The OpenAPI spec does not specify rate limits. Check with Limbo at https://limbo.work for the limits on your partner account.

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

Yes. For example, allow only the eligibility check and the simulation operations, so the agent can tell an employee what they qualify for and what an offer looks like, but cannot confirm a proposal on their behalf. Every call it makes is logged.

### How do I check employee credit eligibility with the Limbo API through Jentic?

Search Jentic for 'check employee credit eligibility', load the eligibility operation, and pass the consumer_id header, adding is_test while you build. Jentic fetches and injects the bearer token at call time. To run it on your own infrastructure, install Jentic One from its GitHub repo.