---
title: "Create a Connect URL"
method: POST
path: "/auth/connect_url"
tags: ["Auth"]
---

# Create a Connect URL

`POST /auth/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](ref:createconnecttoken), you need to provide either a `client_user_id` or a`utility 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.](https://docs.arcadia.com/docs/connect-guide) 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.

## Headers

- `Arcadia-Version` string, required

## Request body

- object
  - `client_user_id` string — The unique identifier for your user. This parameter is required for users entering the Connect flow for the first time. Note either `client_user_id` or `utility_credential_id` must be supplied to the endpoint for all requests.
  - `utility_credential_id` integer — The id associated with the utility credential to be updated. This parameter is required for users entering Connect to update or repair an existing utility credential. Note that you must supply either `client_user_id` or `utility_credential_id` to the endpoint.
  - `variant` string — The variant of Connect that the user will be sent through. Variant will default to 'connect'. To provide a user with the tariff-selection variant instead, pass `tariff` as the variant

## Response `200`

Success

- ConnectUrlResponse
  - `connect_url` string, required — The url to be used for initializing standalone Connect.

## Other responses

- `401` — Unauthorized.
- `404` — Not Found
- `422` — Unprocessable Entity

---

[API](https://skmtc.dev/arcadia/apis/arcadia-api-reference.md) · [All operations](https://skmtc.dev/arcadia/apis/arcadia-api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/arcadia/arcadia-api-reference/revisions/468f1c903722/schema)
