HomeGuidesAPI Reference
Log In

Create a Connect URL

You can also send your users through the Connect flow by linking them to a unique Connect URL (provided by this endpoint).

Just like the Connect Token, you need to provide either a client_user_id or autility credential_id to get a URL that will initialize Connect in ‘create mode’ or ‘update mode’ respectively. See this page for a guide on the difference between those two modes. This endpoint will provide a URL in a response.
Once you have the URL, provide it to the given user for them to complete Connect and give you access to their utility data. The URL will expire after 5 days.
If you would like to provide your user with the [Connect tariff selection mode] (https://docs.arcadia.com/docs/connect-tariff-selection-mode) instead, pass tariff as the variant parameter.

Click Try It! to start a request and see the response here!