The Registration module operates over a set of registration entities, each representing a fundamental element of the internal protocol.
Some of them will be shared or mentioned in the integration:
An Institution is identified by its CNPJ.
A Participant is identified by its operational code.
In most cases, ONE Participant is associated with ONE institution.
But there are cases where the same CNPJ operates under different Operational Codes.
Therefore, they are distinct entities.
The same Participant may have more than one "Participant profile".
That is, the sentence "Participant 99 is PNP and MC" is correct, and in the system this is represented by ONE Participant.
They hold obligations and rights. They are identified by their code.
It is correct to say that, within a Participant, there is only one account with a given code.
That is, the key "Participant Code + Account Code" is unique.
They can be classified as "definitive" or "transitory", depending on their type.
("Normal", "Error" and "Operational Error" are definitive. The others are transitory.)
Every account is under, exclusively, one Participant. (Owner)
There are accounts to which an Investor is associated. (Holder)
A scenario in which there is no associated investor is when the account is owned by the Participant itself - example: Capture Account.
It is a "person", holder of an account. Regardless of being a Natural Person or a Legal Person.
(There are more types)
It is identified by a document, called the "primary document".
Each investor type corresponds to a primary document.
E.g.: For Resident Natural Persons, the primary document is the CPF.
It is correct to say that, within a Participant, there is only one investor with a given primary document.
That is, the key "Participant Code + Primary Document" is unique.
However, the same "investor under a Participant" may have more than one account in that Participant. There is no restriction in this regard.
There may also be an Investor with a document X under a Participant A and another Investor with the same document X under another Participant B.
Links are established between accounts.
There is always an origin account and a target account.
A link does not have a "unique identifier" such as a code or the like.
However, it can be uniquely identified by a set of information:
| Date | Version | Reason | Change Description |
|---|---|---|---|
| 03/09/2026 | 1.0 | - | Initial version |
| Message | Name | Description | Sent by Base? | Sent by Participant? |
|---|---|---|---|---|
| base-m-cad-res-01-001 | RegistrationInstructionResponse | Response to the request (covers all flows) | ✅ | |
| base-m-cad-acc-01-001 | PositionAccountCreationInstruction | Account creation request | ✅ | |
| base-m-cad-acc-02-001 | PositionAccountModificationInstruction | Account modification request | ✅ | |
| base-m-cad-lnk-01-001 | PositionAccountLinkCreationInstruction | Link creation request | ✅ | |
| base-m-cad-lnk-02-001 | PositionAccountLinkModificationInstruction | Link modification request | ✅ | |
| base-m-cad-inv-01-001 | ResidentNaturalPersonModificationInstruction | Resident natural person modification request | ✅ | |
| base-m-cad-inv-02-001 | NonResidentNaturalPersonModificationInstruction | Non-resident natural person modification request | ✅ | |
| base-m-cad-inv-03-001 | NationalInvestmentFundModificationInstruction | National investment fund modification request | ✅ | |
| base-m-cad-inv-04-001 | NationalLegalPersonModificationInstruction | National legal person modification request | ✅ | |
| base-m-cad-inv-05-001 | ForeignLegalPersonModificationInstruction | Foreign legal person modification request | ✅ | |
| base-m-cad-acc-03-001 | PositionAccountSnapshot | Information about an Account | ✅ | |
| base-m-cad-lnk-03-001 | PositionAccountLinkSnapshot | Information about a Link | ✅ |
| File | Contained message | Name | Description | Sent by Base? | Sent by Participant? |
|---|---|---|---|---|---|
| base-f-cad-acc-03-001 | base-m-cad-acc-03-001 | PositionAccountsReport | Accounts Report | ✅ | |
| base-f-cad-lnk-03-001 | base-m-cad-lnk-03-001 | PositionAccountLinksReport | Links Report | ✅ |