Request a CID set file from BACEN
curl --request POST \
--url https://api.example.com/api/v1/dict/cids/files \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-ISPB: <x-ispb>' \
--header 'X-Idempotency: <x-idempotency>' \
--data '
{
"keyType": "EMAIL"
}
'package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/v1/dict/cids/files"
payload := strings.NewReader("{\n \"keyType\": \"EMAIL\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Idempotency", "<x-idempotency>")
req.Header.Add("X-ISPB", "<x-ispb>")
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>',
'X-ISPB': '<x-ispb>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({keyType: 'EMAIL'})
};
fetch('https://api.example.com/api/v1/dict/cids/files', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.example.com/api/v1/dict/cids/files"
payload = { "keyType": "EMAIL" }
headers = {
"X-Idempotency": "<x-idempotency>",
"X-ISPB": "<x-ispb>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"id": "4521",
"keyType": "EMAIL",
"participant": "12345678",
"requestTime": "2026-09-29T12:00:00.123Z",
"status": "REQUESTED",
"bacen": {
"correlationId": "a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4",
"lastModified": "2026-06-14T12:00:00Z",
"responseTime": "2026-06-14T12:00:00Z"
}
}{
"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"
}
}Request a CID set file from BACEN
Asks BACEN’s createCidSetFile to build the X-ISPB participant’s full CID set of one key type and returns BACEN’s answer verbatim. Lerian SPI records the request and polls BACEN until the file reaches AVAILABLE, UNAVAILABLE or ERROR, then publishes the dict_cid_set_file fact. Read the request with GET cids/files/ and the file with GET cids/files//content.
POST
/
api
/
v1
/
dict
/
cids
/
files
Request a CID set file from BACEN
curl --request POST \
--url https://api.example.com/api/v1/dict/cids/files \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-ISPB: <x-ispb>' \
--header 'X-Idempotency: <x-idempotency>' \
--data '
{
"keyType": "EMAIL"
}
'package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/v1/dict/cids/files"
payload := strings.NewReader("{\n \"keyType\": \"EMAIL\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Idempotency", "<x-idempotency>")
req.Header.Add("X-ISPB", "<x-ispb>")
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>',
'X-ISPB': '<x-ispb>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({keyType: 'EMAIL'})
};
fetch('https://api.example.com/api/v1/dict/cids/files', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.example.com/api/v1/dict/cids/files"
payload = { "keyType": "EMAIL" }
headers = {
"X-Idempotency": "<x-idempotency>",
"X-ISPB": "<x-ispb>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"id": "4521",
"keyType": "EMAIL",
"participant": "12345678",
"requestTime": "2026-09-29T12:00:00.123Z",
"status": "REQUESTED",
"bacen": {
"correlationId": "a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4",
"lastModified": "2026-06-14T12:00:00Z",
"responseTime": "2026-06-14T12:00:00Z"
}
}{
"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"
}
}Autorizaciones
JWT bearer token issued by the identity provider.
Encabezados
Required key used to prevent replaying the mutation.
ISPB of the participant the call acts for. It must be this deployment's direct participant or an indirect it sponsors; the body never carries it.
Pattern:
^[0-9A-Z]{8}$Ejemplo:
"12345678"
Cuerpo
application/json
Key type whose CID set file BACEN builds.
Opciones disponibles:
CPF, CNPJ, EMAIL, PHONE, EVP Ejemplo:
"EMAIL"
Respuesta
Created
BACEN's id for the file; read it with GET cids/files/{id}.
Ejemplo:
"4521"
Key type of the CID set.
Ejemplo:
"EMAIL"
ISPB whose CID set the file holds.
Ejemplo:
"12345678"
When BACEN received the request, BACEN's wire value.
Ejemplo:
"2026-09-29T12:00:00.123Z"
BACEN's file status, verbatim: REQUESTED, PROCESSING, AVAILABLE, UNAVAILABLE or ERROR.
Ejemplo:
"REQUESTED"
BACEN's operational envelope for this call; omitted when BACEN sent no correlation id.
Show child attributes
Show child attributes
¿Esta página le ayudó?