Skip to main content
POST
Query the assets deposited at the câmara

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Headers

X-Idempotency
string
required

Idempotency key for this state-changing request (required, max 255 characters).

Maximum string length: 255

Body

application/json
CNPJEntRespons1_2
string
required

CNPJ Entidade Responsável 1 ou 2 (CNPJ, [1..1]). The responsible entity this institution acts for.

CodTitlar
string
required

Código Titular (CodTitlar, [1..1]): the holder the answer is scoped to.

DtMovto
string
required

Data Movimento (Data, [1..1]), as YYYY-MM-DD.

FinlddCob
string
required

Finalidade Cobertura (FinlddCob, [1..1]): what the deposited collateral covers.

ISPBLDL
string
required

ISPB LDL: the câmara addressed (ISPB, [1..1]).

TpRet
string
required

Tipo Retorno (TpRet, [1..1]): the shape of answer the câmara returns for this query.

TpTitlar
string
required

Tipo Titular (TpTitlar, [1..1]): the holder the answer is scoped to.

CodProdt
string

Código Produto (CodProdt, [0..1]): narrows the query to one câmara product. A payload field, not the registered product.

CodSubTitlar
string

Código Subtitular (CodSubTitlar, [0..1]).

CtCstdia
string

Conta Custódia (CtSEL, [0..1]): the Selic custody account to narrow the query to.

SubTpAtv
string

SubTipo Ativo (SubTpAtv, [0..1]).

TpAtv
string

Tipo Ativo (TpAtv, [0..1]): narrows the query to one asset class.

TpSubTitlar
string

Tipo Subtitular (TpTitlar, [0..1]).

Response

Accepted

attempts
integer<int64>
required

Queue-put attempts made so far.

codMsg
string
required

The SFN request code this row carries, e.g. LDL1002.

id
string<uuid>
required

Outbound message id.

numCtrlIF
string
required

The control number this institution issued (NumCtrlIF). The câmara echoes it on the answer, which is what correlates the two.

nuop
string
required

The BCMSG operation number of the frame.

request
object
required

The request exactly as it was submitted, projected verbatim.

status
enum<string>
required

Lifecycle state. REFUSED means the câmara received the request and returned its E twin; FAILED means this rail could not deliver it. Both are terminal and they are different facts.

Available options:
SUBMITTED,
DISPATCHED,
ANSWERED,
REFUSED,
FAILED
submittedAt
string<date-time>
required

When the request was recorded.

answer
object

What the câmara answered; omitted until it has answered.

answerAbsent
boolean

True only on an ANSWERED message whose answer body this rail does not hold. The câmara did answer; what it wrote is not here, and the missing answer block is that absence, never an empty answer. Omitted otherwise.

answeredAt
string<date-time>

When the câmara's answer was applied; omitted until it is.

dispatchedAt
string<date-time>

When the frame reached the send queue; omitted until it has.

lastError
string

Why the last queue put failed, or — on REFUSED — the CodErro values the câmara marked, verbatim. Omitted when neither applies.