---
title: "Authenticate:Login"
method: POST
path: "/login/authenticate"
tags: ["Authentication"]
---

# Authenticate:Login

`POST /login/authenticate`

Retrieve a handshake to redirect a user to the Pay platform so that a user can access the Pay platform without entering login credentials. Note that the user needs to have the correct rights to use this feature. You need to authenticate this API with the AT-code as username and the token as password

## Request body

- object
  - `login` object, required
    - `inactivityExpire` integer, required
    - `internalId` string, required
    - `deviceId` string, required
    - `ipAddress` string
    - `userAgent` string, required
  - `account` object, required
    - `licenseCode` string, required
    - `label` string, required
    - `languageId` string, required
    - `logoutRedirectUrl` string, required

## Response `201`

Ok.

- object
  - `session` LoginSession
    - `sessionCode` string
    - `handshake` string
    - `internalId` string
    - `licenseCode` string
    - `redirectUrl` string, nullable

## Other responses

- `400` — Bad request, see response body for more information
- `401` — Unauthorized. Supplied credentials are invalid
- `403` — Forbidden. Supplied credentials have no rights
- `405` — Used HTTP method is not allowed
- `406` — Not acceptable. The supplied content type in the accept parameter in the header is not supported
- `415` — Unsupported media. The supplied content type in the content-type parameter in the header is not supported
- `422` — Unprocessable entity, see response body for more information
- `429` — Rate limit reached.
- `500` — An internal error occurred

---

[API](https://skmtc.dev/pay/apis/pay-transaction-gateway-unit-api.md) · [All operations](https://skmtc.dev/pay/apis/pay-transaction-gateway-unit-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/pay/pay-transaction-gateway-unit-api/revisions/2bc260c7bdfc/schema)