Event Object

An Event Object describes an Authentication Event, and serves as a "proof" that the user has successfully authenticated. The field approved tells you whether this event is approved, and the signature can be validated to make sure that this "proof" is generated by Cotter.

{
  "ID": 610152,
  "user_id": "61e51b1b-55cd-4b00-9cc0-4b71fa0eb00f",
  "client_user_id": "",
  "issuer": "abababab-abab-abab-abab-ababab",
  "event": "LOGIN_WITH_DEVICE",
  "ip": "73.15.208.6",
  "location": "Orinda",
  "timestamp": "1591935918",
  "method": "TRUSTED_DEVICE",
  "new": false,
  "approved": true,
  "signature": "BqBQphW2G1QLn5/ZcrcRVJ/S..."
}

Field

Description

ID

The event ID

user_id

Cotter's User ID of the user that requested this authentication event

client_user_id

[DEPRECATED] Your User ID for the user in your server

issuer

Your API_KEY_ID

event

A tag that describes the authentication event.

ip

The user's IP address when requesting authentication

location

The user's location when requesting authentication

timestamp

The UNIX timestamp when the user requested for authentication

method

The authentication method that was used: TRUSTED_DEVICE , PIN , or BIOMETRIC

new

Whether or not this is a new request. This is used for pending requests where the user need to tap on their device to approve the login request.

approved

Whether or not this authentication request was approved

signature

A signature from Cotter that prove that this Event Object is generated by Cotter.

To use this Event Object, you should validate it's authenticity following this guide:

Validating Cotter's Event Response

Last updated