Skip to main content

Webhook Details

Account Verified as Worker​

This webhook is triggered when a Branch user is verified as a worker on an organization's roster.

Example​

{
    "event": "ACCOUNT_VERIFIED_AS_WORKER",
    "client_type": "ORGANIZATION",
    "client_id": int,
    "data": {
        "employee_id": String,
        "account_number": String,
        "routing_number": String
    }
}
 
 

Account Review​

This webhook is triggered when a user has been flagged for manual review.

Example​

{
    "event": "ACCOUNT_REVIEW",
    "client_type": "ORGANIZATION",
    "client_id": int,
    "data": { 
         "employee_id": String,
         "onboarding_link": String
     }
}
 
 

Wallet Created​

This event will be sent when the user passes KYC and a wallet is created. The wallet will be in the 'UNACTIVATED' state

Example​

{
    "event": "WALLET_CREATED",
    "client_type": "ORGANIZATION",
    "client_id": int,
    "data": {
        "employee_id": String,
        "account_number": String,
        "routing_number": String,
        "onboarding_link": String
    }
}
 
 

Wallet Claimed​

This event is fired when a user downloads the application and claims a pre-initialized account

Example​

{
    "event": "WALLET_CLAIMED",
    "client_type": "ORGANIZATION",
    "client_id": int,
    "data": {
        "employee_id": String,
    }
}
 
 

Wallet Activated​

When a worker's identity is verified a wallet is created, but is not usable until the user passes additional KYC checks. When those KYC checks pass, this event is triggered.

Example​

{
    "event": "WALLET_ACTIVATED",
    "client_type": "ORGANIZATION",
    "client_id": int,
    "data": {
        "employee_id": String,
        "account_number": String,
        "routing_number": String,
        "onboarding_link": String,
        "is_claimed": Boolean
    }
}

is_claimed = false: Initial onboarding after passing KYC checks.

is_claimed = true: Reopening of a previously opened and claimed wallet.

 
 

Wallet Deactivated​

Anytime a worker's wallet gets deactivated, this event is triggered.

This could be due to Branch confirming the user as a fraud user, or the user requesting that their account be closed.

Example​

{
    "event": "WALLET_DEACTIVATED",
    "client_type": "ORGANIZATION",
    "client_id": int,
    "data": {
        "employee_id": String,
        "account_number": String,
        "routing_number": String,
        "reason_code": String,
        "reason": String,
        "is_claimed": Boolean
    }
}

is_claimed = false: The wallet was not opened after failed Branch fraud checks.

is_claimed = true: A wallet that was opened and claimed is now being deactivated.

 
 

Wallet Closed​

Triggered when a wallet is closed. The worker is reset and can onboard again.

Example​

{
    "event": "WALLET_CLOSED",
    "client_type": "ORGANIZATION",
    "client_id": int,
    "data": {
        "employee_id": String,
        "account_number": String,
        "routing_number": String
    }
}
 
 

Card Activated​

Triggered when a user activates their card.

Example​

{
    "event": "CARD_ACTIVATED",
    "client_type": "ORGANIZATION",
    "client_id": int,
    "data": {
        "employee_id": String,
        "marqeta_card_token": String,
        "card_product": String,
        "card_type": [PHYSICAL, VIRTUAL, UNKNOWN],
        "time_emitted": String
    }
}

Card Deactivated​

Triggered when a user deactivates their card.

Example​

{
    "event": "CARD_DEACTIVATED",
    "client_type": "ORGANIZATION",
    "client_id": int,
    "data": {
        "employee_id": String,
        "marqeta_card_token": String,
        "card_product": String,
        "card_type": [PHYSICAL, VIRTUAL, UNKNOWN],
        "reason_code": String,
        "time_emitted": String
    }
}
 
 

KYC Fallback Failed​

Triggered when KYC fallback ID upload verification has failed. This means that the user is not payable through Branch.

Example​

{
   "event": "KYC_FALLBACK_FAILED",
   "client_type": "ORGANIZATION",
   "client_id": int,
   "data": {
       "employee_id": String
   }
}