Create Customer Login

Start a Delegation session for a Customer and obtain the login id and code

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Start a Delegation Accounts session for a Customer.

You first generate an access_id for the Customer's session on your side, then call this endpoint. Lirium returns a login id and code that you use to open the Lirium WebApp for that Customer. From then on, Lirium authenticates every request to your Delegation Endpoints with a JWT whose iss is the access_id you provided.

Request

POST /customers/{customer_id}/logins

Path Parameters

ParameterTypeRequiredDescription
customer_idstringYesID of the Customer starting the session.

Body

{
  "access_id": "5f3c1a2b9d7e4c8a"
}
FieldTypeRequiredDescription
access_idstringYesThe session identifier you generated and linked to this Customer. Lirium sends it back as the JWT iss when calling your endpoints.

Example Response

{
  "id": "a1b2c3d4e5f6",
  "code": "123456"
}

Response Fields

FieldTypeRequiredDescription
idstringYesLogin identifier. Pass it as the i query parameter in the WebApp URL.
codestringYesOne-time login code. Pass it as the c query parameter in the WebApp URL.

Open the WebApp

Redirect the Customer (or open a webview) to the Lirium WebApp, replacing id and code with the values from the response:

https://{partner}.app.lirium.com?i={id}&c={code}
Path Params
string
required

ID of the Customer.

Body Params
string
required

The session identifier you generated and linked to this Customer.

Responses

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