POST
/
auth
/
connect-token
curl --request POST \
     --url https://api.pelm.com/auth/connect-token \
     --header 'accept: application/json' \
     --header 'content-type: application/x-www-form-urlencoded'

{
  "connect_token": "CONNECT_TOKEN",
  "expires_in": 1800
}

​
Form data

user_id
string
required

ID specified by you to identify the user. This allows you to refer to the User using an ID you already have, precluding the need to save a new user_id generated by Pelm.

Typically, clients will set their own db user_id as this value.

utility_slug
string
required

Include this optional parameter if you already know which utility your user uses. If included, the user will skip the Utility Selection Screen. If omitted, the user will need to select their utility.

utility_id
string
required

Deprecated. Please use utility_slug instead.

Note: An error will be returned if both utility_slug and utility_id are passed.

You can find a list of both utility_ids and utility_slugs here.

​
Headers

Pelm-Client-Id
string
required

Pelm-Client-Id given on registration

Pelm-Secret
string
required

Pelm-Secret given on registration

​
Response

connect_token
string
expires_in
string

Number of seconds until the connect_token expires (30 min)

Create Access TokenGet User