The onboarding status notification signals the overall status of the seller's registration and is sent after each of the previous notifications. Currently, this status is composed of the combination of two validations: KYC and bank information.

Therefore, after the first notification, the onboarding status will indicate that the process is under analysis; only after the second notification, the status "2" will be returned, assuming that all analysis steps have been approved.

Braspag will send a notification with the notification type parameters, seller identification (SubordinateMerchantId) and information on all statuses.

ℹ️

  • When the onboarding status (Data.OnboardingStatus) shows the value "2", it means that the seller has already passed all validations and is able to transact;
  • When the onboarding status shows the value "3", it means that the registration was not successful in at least one validation and that the master needs to take some action regarding this registration.

Check all possible values ​​for onboarding status in the table below:

Example of onboarding notification sent:

{
    "ChangeType": 23,
    "MasterMerchantId": "96ffb8be-6693-4f9b-bf8e-925b555b3207",
    "Data": {
        "SubordinateMerchantId":"4d76b525-e66d-402e-a318-5fd3ce1af7aa",
        "OnboardingStatus": 2,
        "KycAnalysisInfo": {
            "Status": 2
        },
        "BankAccountValidation": {
            "Status": 3
        }
    }
}
PROPERTYTYPESIZEDESCRIPTION
ChangeTypeNumber-Notification type identifier. For Onboarding status notification, ChangeType is equal to “23”.
MasterMerchantIdGUID36Master ID.
Data.SubordinateMerchantIdGUID36Seller ID.
Data.OnboardingStatusNumber1Onboarding process status. Valid statuses are:
UnderAnalysis = 1;
Approved = 2;
AwaitingMerchantAction = 3;
Unknown = 4;
Banned = 5
Data.KycAnalysisInfo.StatusNumber1KYC analysis status. Valid statuses are:
UnderAnalysis = 1;
Approved = 2;
ApprovedWithRestriction = 3;
Rejected = 4
Data.BankAccountValidation.StatusNumber1Status of the bank account analysis. Valid statuses are:
InternalError = 0;
Created = 1;
Processing = 2;
Success = 3;
Error = 4