Partner Authentication

Partner receives credentials from LinkCy when you open a Sandbox account. This credentials are only available for sandbox. Other credentials will be displayed before going live.

Log In

Once credentials have been received, partner can login using the "Log into the application" endpoint.
Following information have to be provided :

username
required
string
partnerName
required
string
password
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"
}

Partner can then use this JWT token for the other API requests.

If you do not include your bearer token when you perform API request or you include an invalid token, LinkCy will respond with a 401 - Unauthorized HTTP error.

JWT token has to be send in the Header as an "Authorization bearer" as 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, Partner has to use the "Refresh login token" and provide the refreshToken which was received along the previous JWT Token.

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

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, Partner can still Log In again to get a new JWT Token.