Send message to BCB
curl --request POST \
--url https://bc-correios.sandbox.lerian.net/api/v1/correios/mails/send \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-Idempotency: <x-idempotency>' \
--data '
{
"body": "Prezados, gostaríamos de esclarecer...",
"destination": "DEINF",
"inReplyToMailId": "550e8400-e29b-41d4-a716-446655440000",
"keywords": [
"regulacao",
"cambio"
],
"subject": "Consulta sobre Resolução 4.966"
}
'package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://bc-correios.sandbox.lerian.net/api/v1/correios/mails/send"
payload := strings.NewReader("{\n \"body\": \"Prezados, gostaríamos de esclarecer...\",\n \"destination\": \"DEINF\",\n \"inReplyToMailId\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"keywords\": [\n \"regulacao\",\n \"cambio\"\n ],\n \"subject\": \"Consulta sobre Resolução 4.966\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Idempotency", "<x-idempotency>")
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}const options = {
method: 'POST',
headers: {
'X-Idempotency': '<x-idempotency>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
body: JSON.stringify('Prezados, gostaríamos de esclarecer...'),
destination: 'DEINF',
inReplyToMailId: '550e8400-e29b-41d4-a716-446655440000',
keywords: ['regulacao', 'cambio'],
subject: 'Consulta sobre Resolução 4.966'
})
};
fetch('https://bc-correios.sandbox.lerian.net/api/v1/correios/mails/send', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://bc-correios.sandbox.lerian.net/api/v1/correios/mails/send"
payload = {
"body": "Prezados, gostaríamos de esclarecer...",
"destination": "DEINF",
"inReplyToMailId": "550e8400-e29b-41d4-a716-446655440000",
"keywords": ["regulacao", "cambio"],
"subject": "Consulta sobre Resolução 4.966"
}
headers = {
"X-Idempotency": "<x-idempotency>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"bcbConfirmationId": "BCB-2026-0311-001234",
"idempotencyKey": "send-msg-2026-03-30-001",
"messageId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"sentAt": "2026-03-30T14:00:00Z",
"status": "CONFIRMED"
}{
"correlationId": "req-7a3f9c2e",
"code": "<string>",
"detail": "Property foo is required but is missing.",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example",
"upstream": {
"code": "E4001",
"message": "account not found at provider"
}
}{
"correlationId": "req-7a3f9c2e",
"code": "<string>",
"detail": "Property foo is required but is missing.",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example",
"upstream": {
"code": "E4001",
"message": "account not found at provider"
}
}{
"correlationId": "req-7a3f9c2e",
"code": "<string>",
"detail": "Property foo is required but is missing.",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example",
"upstream": {
"code": "E4001",
"message": "account not found at provider"
}
}{
"correlationId": "req-7a3f9c2e",
"code": "<string>",
"detail": "Property foo is required but is missing.",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example",
"upstream": {
"code": "E4001",
"message": "account not found at provider"
}
}{
"correlationId": "req-7a3f9c2e",
"code": "<string>",
"detail": "Property foo is required but is missing.",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example",
"upstream": {
"code": "E4001",
"message": "account not found at provider"
}
}{
"correlationId": "req-7a3f9c2e",
"code": "<string>",
"detail": "Property foo is required but is missing.",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example",
"upstream": {
"code": "E4001",
"message": "account not found at provider"
}
}{
"correlationId": "req-7a3f9c2e",
"code": "<string>",
"detail": "Property foo is required but is missing.",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example",
"upstream": {
"code": "E4001",
"message": "account not found at provider"
}
}{
"correlationId": "req-7a3f9c2e",
"code": "<string>",
"detail": "Property foo is required but is missing.",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example",
"upstream": {
"code": "E4001",
"message": "account not found at provider"
}
}{
"correlationId": "req-7a3f9c2e",
"code": "<string>",
"detail": "Property foo is required but is missing.",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example",
"upstream": {
"code": "E4001",
"message": "account not found at provider"
}
}Send message to BCB
Sends a message to BCB through BC Correio. Requires the X-Idempotency header for safe retries.
POST
/
api
/
v1
/
correios
/
mails
/
send
Send message to BCB
curl --request POST \
--url https://bc-correios.sandbox.lerian.net/api/v1/correios/mails/send \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-Idempotency: <x-idempotency>' \
--data '
{
"body": "Prezados, gostaríamos de esclarecer...",
"destination": "DEINF",
"inReplyToMailId": "550e8400-e29b-41d4-a716-446655440000",
"keywords": [
"regulacao",
"cambio"
],
"subject": "Consulta sobre Resolução 4.966"
}
'package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://bc-correios.sandbox.lerian.net/api/v1/correios/mails/send"
payload := strings.NewReader("{\n \"body\": \"Prezados, gostaríamos de esclarecer...\",\n \"destination\": \"DEINF\",\n \"inReplyToMailId\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"keywords\": [\n \"regulacao\",\n \"cambio\"\n ],\n \"subject\": \"Consulta sobre Resolução 4.966\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Idempotency", "<x-idempotency>")
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}const options = {
method: 'POST',
headers: {
'X-Idempotency': '<x-idempotency>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
body: JSON.stringify('Prezados, gostaríamos de esclarecer...'),
destination: 'DEINF',
inReplyToMailId: '550e8400-e29b-41d4-a716-446655440000',
keywords: ['regulacao', 'cambio'],
subject: 'Consulta sobre Resolução 4.966'
})
};
fetch('https://bc-correios.sandbox.lerian.net/api/v1/correios/mails/send', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://bc-correios.sandbox.lerian.net/api/v1/correios/mails/send"
payload = {
"body": "Prezados, gostaríamos de esclarecer...",
"destination": "DEINF",
"inReplyToMailId": "550e8400-e29b-41d4-a716-446655440000",
"keywords": ["regulacao", "cambio"],
"subject": "Consulta sobre Resolução 4.966"
}
headers = {
"X-Idempotency": "<x-idempotency>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"bcbConfirmationId": "BCB-2026-0311-001234",
"idempotencyKey": "send-msg-2026-03-30-001",
"messageId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"sentAt": "2026-03-30T14:00:00Z",
"status": "CONFIRMED"
}{
"correlationId": "req-7a3f9c2e",
"code": "<string>",
"detail": "Property foo is required but is missing.",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example",
"upstream": {
"code": "E4001",
"message": "account not found at provider"
}
}{
"correlationId": "req-7a3f9c2e",
"code": "<string>",
"detail": "Property foo is required but is missing.",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example",
"upstream": {
"code": "E4001",
"message": "account not found at provider"
}
}{
"correlationId": "req-7a3f9c2e",
"code": "<string>",
"detail": "Property foo is required but is missing.",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example",
"upstream": {
"code": "E4001",
"message": "account not found at provider"
}
}{
"correlationId": "req-7a3f9c2e",
"code": "<string>",
"detail": "Property foo is required but is missing.",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example",
"upstream": {
"code": "E4001",
"message": "account not found at provider"
}
}{
"correlationId": "req-7a3f9c2e",
"code": "<string>",
"detail": "Property foo is required but is missing.",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example",
"upstream": {
"code": "E4001",
"message": "account not found at provider"
}
}{
"correlationId": "req-7a3f9c2e",
"code": "<string>",
"detail": "Property foo is required but is missing.",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example",
"upstream": {
"code": "E4001",
"message": "account not found at provider"
}
}{
"correlationId": "req-7a3f9c2e",
"code": "<string>",
"detail": "Property foo is required but is missing.",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example",
"upstream": {
"code": "E4001",
"message": "account not found at provider"
}
}{
"correlationId": "req-7a3f9c2e",
"code": "<string>",
"detail": "Property foo is required but is missing.",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example",
"upstream": {
"code": "E4001",
"message": "account not found at provider"
}
}{
"correlationId": "req-7a3f9c2e",
"code": "<string>",
"detail": "Property foo is required but is missing.",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example",
"upstream": {
"code": "E4001",
"message": "account not found at provider"
}
}Authorizations
JWT bearer token issued by the identity provider.
Headers
Idempotency key for safe retries
Body
application/json
Message body. Non-blank, at most 102400 characters (100 KB).
Required string length:
1 - 102400Example:
"Prezados, gostaríamos de esclarecer..."
BCB destination code override (e.g. DEINF). At most 50 characters.
Maximum string length:
50Example:
"DEINF"
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.
Example:
"550e8400-e29b-41d4-a716-446655440000"
Optional PalavrasChave list: at most 10 entries, each at most 100 characters.
Maximum array length:
10Maximum string length:
100Example:
["regulacao", "cambio"]
Message subject. Non-blank, at most 500 characters.
Required string length:
1 - 500Example:
"Consulta sobre Resolução 4.966"
Response
Created
Was this page helpful?

