> ## Documentation Index > Fetch the complete documentation index at: https://docs.lerian.studio/llms.txt > Use this file to discover all available pages before exploring further. # Send message to BCB > Sends a message to BCB through BC Correio. Requires the X-Idempotency header for safe retries. ## OpenAPI ````yaml /en/openapi/v3-current/bc-correios.yaml post /api/v1/correios/mails/send openapi: 3.1.0 info: description: >- API for Lerian BC Correios, which connects the institution to BC Correio, Banco Central do Brasil's electronic correspondence system. It retrieves and stores the institution's BC Correio mail, sends messages to BACEN departments, and keeps an audit trail. title: Lerian BC Correios API version: 1.0.0 servers: - url: https://bc-correios.sandbox.lerian.net security: - BearerAuth: [] tags: - description: Mail listing, search, read, send, and lifecycle operations. name: Mails - description: Immutable audit-trail query and export. name: Audit - description: 'Per-tenant configuration: BCB credentials, polling, AI, retention.' name: Settings - description: Aggregate mail metrics and category breakdowns. name: Dashboard paths: /api/v1/correios/mails/send: post: tags: - Mails summary: Send message to BCB description: >- Sends a message to BCB through BC Correio. Requires the X-Idempotency header for safe retries. operationId: SendMessage parameters: - description: Idempotency key for safe retries in: header name: X-Idempotency required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/SendMessageRequestBody' required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/SendMessageResponse' description: Created '400': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Bad Request '401': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Unauthorized '404': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Not Found '409': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Conflict '413': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Request Entity Too Large '422': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Unprocessable Entity '429': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Too Many Requests '500': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Internal Server Error '503': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Service Unavailable security: - BearerAuth: [] components: schemas: SendMessageRequestBody: additionalProperties: true properties: body: description: Message body. Non-blank, at most 102400 characters (100 KB). examples: - Prezados, gostaríamos de esclarecer... maxLength: 102400 minLength: 1 type: string destination: description: BCB destination code override (e.g. DEINF). At most 50 characters. examples: - DEINF maxLength: 50 type: string inReplyToMailId: description: >- Optional UUID of a received mail being replied to. Omit the key when not replying: an empty string is not a UUID and is refused. examples: - 550e8400-e29b-41d4-a716-446655440000 format: uuid type: string keywords: description: >- Optional PalavrasChave list: at most 10 entries, each at most 100 characters. examples: - - regulacao - cambio items: maxLength: 100 type: string maxItems: 10 type: - array - 'null' subject: description: Message subject. Non-blank, at most 500 characters. examples: - Consulta sobre Resolução 4.966 maxLength: 500 minLength: 1 type: string type: object SendMessageResponse: additionalProperties: false properties: bcbConfirmationId: examples: - BCB-2026-0311-001234 type: - string - 'null' idempotencyKey: examples: - send-msg-2026-03-30-001 type: string messageId: examples: - a1b2c3d4-e5f6-7890-abcd-ef1234567890 type: string sentAt: examples: - '2026-03-30T14:00:00Z' type: string status: examples: - CONFIRMED type: string required: - messageId - bcbConfirmationId - sentAt - status - idempotencyKey type: object Detail: additionalProperties: false properties: code: description: >- Stable, machine-readable domain error code scoped to the emitting service (format: -NNNN). type: string correlationId: description: Request-scoped correlation identifier echoing X-Request-ID. examples: - req-7a3f9c2e type: string detail: description: >- A human-readable explanation specific to this occurrence of the problem. examples: - Property foo is required but is missing. type: string errors: description: Optional list of individual error details items: $ref: '#/components/schemas/ErrorDetail' type: - array - 'null' instance: description: >- A URI reference that identifies the specific occurrence of the problem. examples: - https://example.com/error-log/abc123 format: uri type: string status: description: HTTP status code examples: - 400 format: int64 type: integer title: description: >- A short, human-readable summary of the problem type. This value should not change between occurrences of the error. examples: - Bad Request type: string type: default: about:blank description: A URI reference to human-readable documentation for the error. examples: - https://example.com/errors/example format: uri type: string upstream: $ref: '#/components/schemas/Upstream' description: >- RFC 9457 extension member: the error a proxied third-party provider reported. Absent unless the emitting service explicitly surfaced one. required: - correlationId type: object ErrorDetail: additionalProperties: false properties: location: description: >- Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id' type: string message: description: Error message text type: string value: description: The value at the given location type: object Upstream: additionalProperties: false properties: code: description: The upstream provider's own error code, verbatim. examples: - E4001 type: string message: description: >- The upstream provider's own error message, verbatim (bounded, never its raw response body). examples: - account not found at provider type: string type: object securitySchemes: BearerAuth: bearerFormat: JWT description: JWT bearer token issued by the identity provider. scheme: bearer type: http ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.