Reference
API Reference
Wire-level contracts for KEYRA OAuth Verify and Partner 2FA. Guides explain how to implement; this reference answers what KEYRA expects on the wire.
On this page
Technical request and response schemas are derived from OpenAPI specifications under content/api/openapi/, enriched with verified SDK mappings and security notes.
API families
OAuth Verify
Passwordless authorization, token exchange, validation, and userinfo.
Base URL: https://auth.keyra.ie
Auth: Publishable client_id (start/token/validate); Bearer access_token (userinfo)
Partner 2FA
Enrollment, challenges, verification, recovery, and disable for existing logins.
Base URL: https://auth.keyra.ie
Auth: Bearer clientId:clientSecret (server secret)
- POSTStart authentication challenge
/v1/auth/challenge - GETPoll challenge status
/v1/auth/challenge/{challengeId} - POSTConsume verification token
/v1/auth/challenge/{challengeId}/consume - GETGet identity
/v1/identities/{identityId} - POSTDisable 2FA
/v1/identities/{identityId}/disable - POSTGenerate recovery codes
/v1/identities/{identityId}/recovery/codes - POSTInitiate recovery
/v1/identities/{identityId}/recovery/initiate - POSTStart enrollment
/v1/identities/enroll - GETPoll enrollment status
/v1/identities/enroll/{enrollmentId}/status - GETGet enrollment status (GET)
/v1/identities/status - POSTGet enrollment status
/v1/identities/status
How to use this reference
- Start from a quickstart when implementing.
- Use endpoint pages for exact methods, parameters, responses, and errors.
- Prefer SDK methods when listed — they wrap these REST contracts.