Used as the standard response to registration requests handled by the Base Clearing House.
The message indicates whether the request was processed successfully or rejected due to validation errors, business-rule violations, or an unexpected technical failure.
This message is used as the response for all registration flows involving the creation or modification of registration entities.
R1: The Errors field is empty when ResponseCode = 200.
R2: The Errors field contains at least one element when ResponseCode != 200.
| Index | Field | Type | Required | Description | Rules |
|---|---|---|---|---|---|
| 1 | Correlation | object | YES | Correlation information for the message being answered | |
| 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 | ResponseCode | integer | YES | Request result code Possible values: RegistrationResponseCode |
|
| 3 | Errors | array | NO | List of errors found during processing | R1, R2 |
| 3.1 | ErrorCode | string | YES | Error code | |
| 3.2 | ErrorMessage | string | NO | Brief error description | |
| 3.3 | ElementPath | string | NO | Path of the field related to the error, when applicable | |
| 3.4 | ElementContent | string | NO | Content received in the field related to the error, when applicable |
{
"Correlation": {
"RequestId": "E22FCABBA8FB41A096F9AF4088FD9B4C",
"RequesterParticipantCode": "713",
"OriginalMessageTypeCode": "base-m-cad-acc-01-001"
},
"ResponseCode": 200,
"Errors": []
}
{
"Correlation": {
"RequestId": "E22FCABBA8FB41A096F9AF4088FD9B4C",
"RequesterParticipantCode": "713",
"OriginalMessageTypeCode": "base-m-cad-acc-01-001"
},
"ResponseCode": 400,
"Errors": [
{
"ErrorCode": "CAD0020",
"ErrorMessage": "Invalid CPF",
"ElementPath": "InvestorInformation.NewInvestor.ResidentNaturalPerson.Cpf",
"ElementContent": "Batata"
},
{
"ErrorCode": "CAD0021",
"ErrorMessage": "Invalid Email",
"ElementPath": "InvestorInformation.NewInvestor.ResidentNaturalPerson.EmailAddress",
"ElementContent": "jose.silva@example@123"
}
]
}