Skip to main content
PUT
Record the B3 registration of a loan application

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Path Parameters

id
string<uuid>
required

Loan application identifier.

Body

application/json
instrumentCode
string
required

The instrument code (Código IF) B3 assigned when the client registered the contract: 1 to 14 letters and digits, stored exactly as sent.

Pattern: ^[A-Za-z0-9]{1,14}$
Example:

"CCB0000ABCD12"

ccbNumber
string

The client's number for the contract's CCB, with no leading or trailing space and no control character. Optional.

Maximum string length: 64
Pattern: ^[^\s\x00-\x1F\x7F](?:[^\x00-\x1F\x7F]*[^\s\x00-\x1F\x7F])?$
Example:

"TRN-000123"

registrationDate
string<date>

The civil day B3 registered the contract (YYYY-MM-DD), from the approval day to today in Brasília. Optional.

Example:

"2026-10-08"

Response

OK

instrumentCode
string
required

The B3 instrument code (Código IF), as the client sent it.

loanApplicationId
string
required

Loan application identifier (uuid).

recordedAt
string
required

When the Lender recorded it (RFC3339, UTC).

ccbNumber
string

The client's number for the contract's CCB. Absent when not informed.

registrationDate
string

The civil day B3 registered the contract (YYYY-MM-DD). Absent when not informed.