PEpelm
Auth

Create a Connect token

Create a Connect token using client credentials in order to initiate the Connect flow.

post/auth/connect-token

Request

Headers

Pelm-Client-Idstring required

Your Pelm-Client-Id recieved on registration

Pelm-Secretstring required

Your Pelm-Secret recieved on registration

Request body application/x-www-form-urlencoded

user_idstring 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_idstring

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.

You can find a list of utility_ids here.

Response

Successful operation

connect_tokenstring
expires_instring

number of seconds until connect_token expires (30 min)

Changes

No recorded changes to this operation across all 1 revision of this API.