API Reference

Create a Connect token

post
https://api.pelm.com/auth/connect-token

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

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Form Data
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.

string

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.

Headers
string
required

Your Pelm-Client-Id recieved on registration

string
required

Your Pelm-Secret recieved on registration

Responses

Updated almost 4 years ago

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

Updated almost 4 years ago