Okay LogoOkay Logo

Lean and simple

With the Okay api and a tenant you can get your secure authentications up and running in no time.

post

Start authentication transaction

Starts new authentication transaction of specified type

Parameters
Name
Description
Type
Required
body
false
Consumes
application/json
Produces
application/json
    {
       "tenantId": {
          "type": "integer",
          "format": "int64"
       },
       "signature": {
          "type": "string"
       },
       "userExternalId": {
          "type": "string"
       },
       "type": {
          "type": "string",
          "enum": [
             "AUTH_OK",
             "AUTH_PIN",
             "AUTH_PIN_TAN",
             "AUTH_PIN_PROTECTORIA_OK",
             "AUTH_BIOMETRIC_OK",
             "GET_PAYMENT_CARD",
             "ENROLLMENT",
             "ENROLLMENT_PROTECTORIA_OK",
             "UNKNOWN"
          ]
       },
       "authParams": {
          "type": "object",
          "properties": {
             "guiText": {
                "type": "string"
             },
             "guiHeader": {
                "type": "string"
             }
          }
       }
    }
post

Check authentication transaction status

Checks status of a specified transaction

Parameters
Name
Description
Type
Required
body
false
Consumes
application/json
Produces
application/json
    {
       "tenantId": {
          "type": "integer",
          "format": "int64"
       },
       "signature": {
          "type": "string"
       },
       "sessionExternalId": {
          "type": "string"
       }
    }
post

Link new user to tenant

Generates unique linking code for user. Generated linking code is valid for an hour.

Parameters
Name
Description
Type
Required
body
false
Consumes
application/json
Produces
application/json
    {
       "tenantId": {
          "type": "integer",
          "format": "int64"
       },
       "signature": {
          "type": "string"
       },
       "userExternalId": {
          "type": "string"
       }
    }