Creating a Customer

Creating a Customer on Bayou is accomplished through a single POST to the /customers endpoint.

When creating a customer, no data fields are required to be filled. While optional, there are several common parameters used when creating a customer:

• external_id: can be used to provide your database's unique identifier for a customer. With this approach no Bayou specific unique identifier needs to be stored in your database. This field must be unique.
• email: the customer's email address
• utility: Here you provide the Bayou api_code of the customer's utility. Speculoos Power, Bayou's fake utility can be used for testing. You can find the api_code for each supported utility on our utility support page or via the utility support api.

After creating a customer, there are two ways to have the customer connect their utility account. Both of which can be generated by using the /customers/{id} API request..

📘

Note: both the link and token expire and need to be regenerated after 10 days

1. onboarding_link: This link is unique to the created customer and can be shared with them to connect their account.
2. onboarding_token: the onboarding token for a specific customer that can be used within Bayou's embedded component