canonical: https://jentic.com/apis/swaggerhub.flaviamarco/api-servio-de-movimentao-beneficiarios

# Flaviamarco Beneficiary Movement Service API

An API for managing beneficiary movements and transfers. The API exposes 3 endpoints secured with oauth2 authentication.

## For AI agents

Programmatically access Beneficiary Movement Service API resources. Covers 3 operations.

## Scope

Does not handle payments, communications, or crm - use for beneficiary management only.

## Capabilities

- Access Beneficiary Movement Service API resources via REST API
- Manage beneficiary movement data programmatically
- Integrate Beneficiary Movement Service API into automated workflows
- Query and filter Beneficiary Movement Service API records by parameters
- Monitor Beneficiary Movement Service API operational status and events

## Use cases

### Beneficiary Movement Operations

Use the Beneficiary Movement Service API to manage beneficiary movements programmatically. The API provides 3 endpoints for beneficiary operations.

Example prompt: Execute a primary operation against the Beneficiary Movement Service API

### Data Retrieval and Monitoring

Query Beneficiary Movement Service API resources on a schedule to track changes, generate alerts, or feed downstream dashboards.

Example prompt: Poll the primary Beneficiary Movement Service API endpoint, compare response to last known state, and alert if changed

### AI Agent Integration via Jentic

AI agents discover and call Beneficiary Movement Service API endpoints through Jentic without managing credentials directly.

Example prompt: Search Jentic for 'beneficiary movement service API', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/beneficiarios` | postBeneficiarios |
| PATCH | `/beneficiarios/{carteirinha}` | patchBeneficiarios |
| DELETE | `/beneficiarios/{carteirinha}` | deleteBeneficiarios |

## Key resources

- **Beneficiaries** — Operations for beneficiaries

## Why Jentic

- **Setup:** Wiring the Beneficiary Movement Service API by hand means running Unimed's OAuth 2.0 client credentials exchange, picking among the sandbox and homologation gateway hosts, and refreshing the token yourself. Through Jentic you install once, import Beneficiary Movement Service API from the API Directory, store the client credentials once, and your agent calls it.
- **Permission scoping:** This API puts the beneficiary card number in the URL path (`/beneficiarios/{carteirinha}`), so a rule can pin your agent to one beneficiary. You choose the operations it may call, so state-changing ones like updating or removing a beneficiary are not included unless you add them.
- **Credential handling:** Your Unimed 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 'enroll a new beneficiary' or 'update a beneficiary record', and Jentic returns the matching Beneficiary Movement Service API 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 Beneficiary Movement Service API use?

The Beneficiary Movement Service API uses oauth2 authentication. 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.

### What are the rate limits for the Beneficiary Movement Service 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 use beneficiary movement service API through Jentic?

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

### How many endpoints does the Beneficiary Movement Service API have?

The Beneficiary Movement Service API exposes 3 endpoints covering beneficiary movement operations.

### Does the Beneficiary Movement Service API support pagination?

Pagination support depends on the specific endpoint. Check the endpoint parameters for page, limit, or offset fields. Through Jentic, the operation schema exposes all available parameters so agents can paginate automatically.