# Clara API

**Canonical:** https://apis.io/apis/clara-cc/clara-cc-api/  
**Provider:** Clara — https://apis.io/providers/clara-cc/  
**Base URL:** https://public-api.mx.clara.com  
**Documentation:** https://developers.clara.team/v1/webhooks

Clara API is published by [Clara](https://apis.io/providers/clara-cc/) on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 6 JSON Schema definitions. The published artifact set on APIs.io includes an OpenAPI specification and 6 JSON Schemas.

Clara API as documented publicly: 28 operations. Contract generated from the documentation by API Evangelist (2026-10-22); not the provider's own document.

## Operations (28)

| Method | Path | Summary |
|---|---|---|
| GET | `/api-test/v3/transactions` | GET /api-test/v3/transactions |
| POST | `/api-test/v3/webhooks/events` | Submit an event with POST /api-test/v3/webhooks/events (scope write:subscribers, Content‑Type: application/json). |
| POST | `/api-test/v3/webhooks/subscriptions` | Create a sandbox subscription with POST /api-test/v3/webhooks/subscriptions (same body as production; environment is SANDBOX). |
| POST | `/api/v1/subscribers` | POST /api/v1/subscribers with an events array |
| GET | `/api/v1/vcn` | Retrieve VCN templates and related identifiers. |
| POST | `/api/v1/vcn/card` | Create a new Virtual Card Number (VCN). |
| PUT | `/api/v1/vcn/card/{id}` | Update an existing VCN. |
| POST | `/api/v1/vcn/card/{id}/cancel` | Cancel a VCN that has not been used. |
| POST | `/api/v2/cards/{uuid}/configurations` | Create or update card configuration settings. |
| POST | `/api/v2/payments` | Create a boleto payment (Brazil only). |
| GET | `/api/v3/accounts-payable` | List Pix payments with optional filters and sorting. |
| POST | `/api/v3/accounts-payable/pix` | Create a Pix payment asynchronously. |
| DELETE | `/api/v3/accounts-payable/pix/{externalid}` | Cancel a scheduled Pix payment. |
| GET | `/api/v3/accounts-payable/{externalid}` | Poll the status of a Pix payment. |
| GET | `/api/v3/billing-statements` | List billing statements. |
| GET | `/api/v3/billing-statements/{uuid}/transactions` | Get transactions for a specific billing statement. |
| GET | `/api/v3/cards` | List cards with optional filters. |
| POST | `/api/v3/cards` | Create a new card (virtual or physical). |
| PATCH | `/api/v3/cards/{uuid}/lock` | Lock a card using a lock code. |
| GET | `/api/v3/digital-accounts` | List digital account transactions (Brazil only). |
| GET | `/api/v3/digital-accounts/balance` | Retrieve digital account balances (Brazil only). |
| GET | `/api/v3/transactions` | GET https://public-api.mx.clara.com/api/v3/transactions – retrieve transactions (production endpoint). |
| GET | `/api/v3/transactions/{uuid}/documents` | Retrieve pre‑signed S3 download links for transaction documents. |
| GET | `/api/v3/transactions/{uuid}/extracted-documents` | Retrieve structured fiscal data extracted from transaction documents. |
| GET | `/api/v3/users` | Retrieve users with optional filters. |
| POST | `/api/v3/webhooks/subscriptions` | POST /api/v3/webhooks/subscriptions with entity + statuses |
| POST | `/api/v3/webhooks/{entity}/resend` | Resend stored webhook events for a given entity. |
| POST | `/oauth/token` | Obtain a JWT Bearer token from the token endpoint. |

## Machine-readable artifacts (8)

- **OpenAPI** — https://artifacts.apis.io/clara-cc/openapi/_ae-authored/clara-cc-openapi-generated.yml
- **JSONSchema** — https://artifacts.apis.io/clara-cc/json-schema/clara-cc-post-api-v1-vcn-card-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/clara-cc/json-schema/clara-cc-post-api-v3-cards-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/clara-cc/json-schema/clara-cc-post-api-test-v3-webhooks-events-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/clara-cc/json-schema/clara-cc-post-api-v2-cards-uuid-configurations-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/clara-cc/json-schema/clara-cc-post-api-test-v3-webhooks-events-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/clara-cc/json-schema/clara-cc-get-api-v3-accounts-payable-response-schema.json
- **APIsJSON** — https://artifacts.apis.io/clara-cc/apis.yml

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/clara-cc/clara-cc-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/clara-cc/.