Enduser Authentication

LinkCy offer you to embed financial services to your own customers (both Consumer and Corporate). So, as a Partner, you will act on behalf of your Customers. Indeed, financial instruments such as cards, accounts, funds, belongs to your Endusers, not to you.

To perform this, we need to be sur that actions directly comes from your Enduser, not you or someone pretending to be you.

Log In

Once credentials are configured, Endusers (either Consumer or Corporate) can login using the "Log into the application". Following information have to be provided :

consumerPhone
required
string^[0-9]{2,17}$

The complete consumer's phone, including country code. Must not contain +.

partnerName
required
string
password
required
string

For Corporates :

accountOwnerPhone
required
string^[0-9]{2,17}$

The complete account owner's phone, including country code. Must not contain +.

password
required
string
partnerName
required
string

If login is OK, Response from API cointains "token" (the JWT) and a "refreshToken"

OK

Response Schema: application/json
Any of:
token
required
string
refreshToken
required
string
endUserId
string <uuid>

If you are logging in as consumer or corporate, return the end-user ID.

application/json
{
  • "token": "string",
  • "refreshToken": "string",
  • "endUserId": "120e9d1f-8444-4b91-85e8-5b208615a3e5"
}

User can then use this JWT token for the other API requests.
JWT token has to be send in the Header as an "Authorization bearer". lke below :

Copy
Copied
Authorization: Bearer <YOUR_JWT_HERE>

Refresh Authentication Token.

The JWT Token expires after a defined time since creation. By decoding the JWT you will know the time remaining for the token validity

Once it is expired, User has to use the "Refresh login token" and provide the refreshToken which was received along the previous JWT Token.

refreshToken
required
string

The API will respond with a new JWT Token to use from now on to be authenticated.

token
required
string
refreshToken
required
string
endUserId
string <uuid>

If you are logging in as consumer or corporate, return the end-user ID.

Otherwise, Enduser can still Log In again to get a new JWT Token.