Login to generate JWT token

POST

https://{{env}}-lb.simplifipay.com/v1/auth/login/{companyName}

The Login endpoint allows you to login to the SimpliFi platform using the provided
credentials. If you don't have the credentials already, you can request them through
this link. The endpoint returns an access token to be
used in making further API calls. Following are the properties of this endpoint.

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request POST 'https://uat-lb.simplifipay.com/v1/auth/login/' \
--header 'requestUuid;' \
--data-urlencode 'client_id=' \
--data-urlencode 'client_secret=' \
--data-urlencode 'grant_type='

Response Example

{
    "access_token": "string",
    "expires_in": "string",
    "token_type": "string"
}

Request

Path Params

companyName

string

required

This is an internal identifier of your company in the SimpliFi platform. We will
generate the company name for you and share it. If you don't have it already,
you can request it through this link.

Header Params

requestUuid

string

required

A unique id is required to be passed as part of the header whenever a SimpliFi API is called from your
system. This would help us in debugging in case of a discrepancy in the expected behavior of the API.

Example:

00d366f2-a6e9-4714-b172-02c4e58c29d8

Body Params application/x-www-form-urlencoded

client_id

string

required

The values of this enumeration identify your channel for calling the endpoint.
Example: If you want to generate the access token to call subsequent APIs from
your back-end system then use the value simplifi-api-client. Allowed values
are: simplifi-ios-client, simplifi-android-client, and simplifi-api-client.

client_secret

string

required

This is a secret identification pattern assigned to you by the SimpliFi platform.
For each allowed value of “client_id” there is a respective client secret value
shared with you before the start of the integration. Pass the respective value here.
If you don't have it already, you can request it through this link.

grant_type

string

required

You need to pass this value to log in through the Client Secret shared by SimpliFi.
Allowed value is client_credentials. If you don't already have these credentials,
you can request them through this link.

Responses

🟢200OK

application/json

On successful operation JWT token is returned

Body

access_token

string

required

This is the system-generated access token to be used for subsequent calls of the
same session. It is to be sent as an authorization header along with the
system-generated token type.

expires_in

string

optional

This is the expiry date/time that defines the validity of the access token.
Note (one needs to re-login before this expiration time).

token_type

string

optional

This field contains the token type which is coupled with access token to form
an authorization header. Accepted value is bearer.

Modified at 2025-06-27 12:44:57

Auth

Card Program