Event informing that a specific customer must share their credentials again

This webhook is sent when a customer must share their credentials in the onboarding form again. The reason field can be either:

  • credentials_are_invalid: The email or password have become invalid and the customer must enter them again.
  • mfa_factor_has_expired: The MFA code received has expired and the customer must share a new MFA factor code.
{
    "event": "customer_must_reauthenticate",
    "object": {
        "id": 12345,
        "external_id": "MSCOTT123",
        "reason": "credentials_are_invalid",
        "onboarding_token": "ABCDEF0123456_ABCDEF0123456_ABCDEF0123456",
        "onboarding_link": "https://bayou.energy/companies/12345/sign_up?key=ABCDEF0123456"
    }
}

This webhook can be tested with a fake customer (using Bayou's fake utility) - see details here: https://docs.bayou.energy/docs/speculoos