Link customer's utility account

Create a link to a customer's utility account

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Companies can use this endpoint to link and access a customer's utility account data. When invoked, a background job is initiated. To query the status of the job, a company can query the /jobs/link-account/{jobId} endpoint.

Body Params
string
required

Utility Provider Account username

string
required

Utility Provider Account password

string
required

Utility Account Provider name

string

Customer firstName fallback

string

Customer lastName fallback

boolean
Defaults to true

This parameter controls whether an email verification receipt is sent to the customer. Defaults to true

Responses

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json