Used to instruct the modification of a previously registered resident individual.
The message allows specific investor registration information to be changed.
Within Modifications, there are specific actions:
SetXyz: if non-null, changes the field value.UnsetXyz: for optional data only. If true, removes the value.AddManyXyz: adds elements to the collection. null is treated as empty (does nothing).RemoveManyXyz: removes elements from the collection. null is treated as empty (does nothing).Example of a successful flow:
| Index | Field | Type | Required | Description | Rules |
|---|---|---|---|---|---|
| 1 | ParticipantRequestInfo | object | YES | Request information | |
| 1.1 | RequestId | string | YES | Unique request identifier assigned by the participant | |
| 1.2 | RequesterParticipantCode | string | YES | Requesting participant code | |
| 1.3 | OriginalMessageTypeCode | string | NO | Original message type in the base-m-cad-???-##-### pattern |
|
| 2 | InvestorIdentification | object | YES | Identification of the investor to be modified | |
| 2.1 | OwnerCode | string | YES | Code of the participant that owns the account | |
| 2.2 | InvestorDocumentCode | string | YES | Investor document identifier | |
| 3 | Modifications | object | YES | Modifications to be applied to the investor | |
| 3.1 | SetFullName | string | NO | Change full name | |
| 3.2 | SetAddress | object | NO | Change address | |
| 3.2.1 | PostalCode | string | YES | Postal code | |
| 3.2.2 | Street | string | YES | Street (street, avenue) | |
| 3.2.3 | Number | string | NO | Number | |
| 3.2.4 | Extra | string | NO | Additional address information (apartment, block, unit, etc.) | |
| 3.2.5 | City | string | YES | City | |
| 3.2.6 | State | string | YES | State abbreviation (SP, RJ, DF, etc.) | |
| 3.3 | SetPhone | string | NO | Change phone number | |
| 3.4 | SetEmailAddress | string | NO | Change email address | |
| 3.5 | SetAnnualIncome | decimal | NO | Change annual income | |
| 3.6 | SetAnnualIncomeReferenceDate | string | NO | Change annual income reference date | |
| 3.7 | SetNetWorth | decimal | NO | Change net worth | |
| 3.8 | SetNetWorthReferenceDate | string | NO | Change net worth reference date | |
| 3.9 | SetIsPoliticallyExposed | bool | NO | Change politically exposed person indicator | |
| 3.10 | SetOccupation | integer | NO | Change occupation | |
| 3.11 | SetPreferredName | string | NO | Change preferred name | |
| 3.12 | SetRegistrationRestriction | integer | NO | Change registration restriction Possible values: RegistrationRestriction |
|
| 3.13 | UnsetRegistrationRestriction | bool | NO | Remove registration restriction |
{
"ParticipantRequestInfo": {
"RequestId": "E22FCABBA8FB41A096F9AF4088FD9B4C",
"RequesterParticipantCode": "33"
},
"InvestorIdentification": {
"OwnerCode": "33",
"InvestorDocumentCode": "12345678909"
},
"Modifications": {
"SetAddress": {
"PostalCode": "30110000",
"Street": "Rua Atualizada",
"Number": "500",
"Extra": "Sala 301",
"City": "Belo Horizonte",
"State": "MG"
},
"SetPhone": "31999998888",
"SetEmailAddress": "novo.email@example.com",
"SetPreferredName": "Maria Oliveira"
}
}