Partner 2FA API

Basics#

Base URL

https://auth.keyra.ie

Authentication

Bearer clientId:clientSecret (server secret)

Content-Type

application/json

Spec version

1.0.0 · partner-2fa-v1.yaml

Typical flow#

Endpoints#

11 published operations. Open an endpoint for parameters, responses, and examples.

• POST/v1/auth/challenge
  Start authentication challengeCreate login challenge
• GET/v1/auth/challenge/{challengeId}
  Poll challenge statusPoll challenge status
• POST/v1/auth/challenge/{challengeId}/consume
  Consume verification tokenConsume verification token (one-time)
• GET/v1/identities/{identityId}
  Get identityGet identity
• POST/v1/identities/{identityId}/disable
  Disable 2FADisable 2FA (revokes identity)
• POST/v1/identities/{identityId}/recovery/codes
  Generate recovery codesGenerate recovery codes (rotates previous)
• POST/v1/identities/{identityId}/recovery/initiate
  Initiate recoveryInitiate recovery session
• POST/v1/identities/enroll
  Start enrollmentStart enrollment (returns QR URL)
• GET/v1/identities/enroll/{enrollmentId}/status
  Poll enrollment statusPoll enrollment status
• GET/v1/identities/status
  Get enrollment status (GET)Get 2FA enrollment status (GET)
• POST/v1/identities/status
  Get enrollment statusGet 2FA enrollment status