Customers authenticating their utility accounts

To programmatically determine when your customer has authenticated their utility account using Bayou's form or embedded component, use the customer_has_filled_credentials webhook.

{  
    "event": "customer_has_filled_credentials",  
    "object": {  
        "customer_id": 12345,  
        "customer_external_id": "MSCOTT123",  
        "utility": "con_edison",  
        "utility_data_velocity": "instant",  
        "has_filled_credentials": true,  
        "has_filled_credentials_on": "2022-07-01T14:05:00Z"  
    }  
}

The attribute "has_filled_credentials" being set to true denotes the customer authentication. For customers that require multi-factor authentication (MFA) this will only be true if the customer has completed the MFA challenge.

The "utility_data_velocity" attribute indicates whether the data received for this customer will be instant.