Pular para o conteúdo principal
POST
Request a CID set file from BACEN

Autorizações

Authorization
string
header
obrigatório

JWT bearer token issued by the identity provider.

Cabeçalhos

X-Idempotency
string
obrigatório

Required key used to prevent replaying the mutation.

X-ISPB
string
obrigatório

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}$
Exemplo:

"12345678"

Corpo

application/json
keyType
enum<string>
obrigatório

Key type whose CID set file BACEN builds.

Opções disponíveis:
CPF,
CNPJ,
EMAIL,
PHONE,
EVP
Exemplo:

"EMAIL"

Resposta

Created

id
string
obrigatório

BACEN's id for the file; read it with GET cids/files/{id}.

Exemplo:

"4521"

keyType
string
obrigatório

Key type of the CID set.

Exemplo:

"EMAIL"

participant
string
obrigatório

ISPB whose CID set the file holds.

Exemplo:

"12345678"

requestTime
string
obrigatório

When BACEN received the request, BACEN's wire value.

Exemplo:

"2026-09-29T12:00:00.123Z"

status
string
obrigatório

BACEN's file status, verbatim: REQUESTED, PROCESSING, AVAILABLE, UNAVAILABLE or ERROR.

Exemplo:

"REQUESTED"

bacen
object

BACEN's operational envelope for this call; omitted when BACEN sent no correlation id.