Jump to Content
Branch Developer Docs
GuidesAPI ReferenceChangelog
Log InBranch Developer Docs
Guides
Log In
GuidesAPI ReferenceChangelog

Get Started

  • Developer Overview
  • Branch Environments
  • API Versioning
  • Rate Limits
  • Manage Secret Keys

Verify Workers

  • Authenticate Workers
  • Application Security
  • Worker and Employee Compatibility

Worker Payment Methods

  • Payment Method Configurations
  • Branch Direct Web Portal
  • One-Click Branch Wallet
    • Know Your Customer
    • Essential Account Wallet Creation
  • Change Payment Methods
    • Display Payment Profile
    • Change Payment Profile
  • White-Label Debit Card Widget
    • Add a Debit Card
    • Update a Debit Card
    • Display Last 4 Card PAN
    • Display Disbursement History

Pay Workers

  • Activate Worker Payments
  • Create a Disbursement
    • Disbursement Invoices
    • Testing Disbursements to Branch Direct
  • Send ACH Payments
  • Early Earned Wage Access
    • View Worker Advances
    • Deduct Worker Advances in Payroll Remittance
  • Transaction Data Report Files

Webhooks

  • Webhook Implementation
  • Webhook Retries
  • Webhook Reference
    • Account Verified as Worker
    • Account Review
    • Advance Adjustment
    • Advance Claimed
    • Card Activated
    • Card Deactivated
    • Invoice Created
    • Invoice Overdue
    • Invoice Transfer Initiated
    • KYC Fallback Failed
    • KYC Declined
    • Payment Profile Activated
    • Payment Profile Deactivated
    • Wallet Created
    • Wallet Claimed
    • Wallet Activated
    • Wallet Deactivated
    • Wallet Closed

KYC Declined

This webhook is triggered when a worker's KYC is declined.

Event

KYC_DECLINED

Data

employee_id - Int
Unique ID for the worker

reason - String
The reason KYC was declined

Example

"data": {
  "employee_id": "123",
  "reason": "Document invalid"
}               

Updated 27 days ago


  • Table of Contents
    • Event
    • Data
    • Example