Go to developer

Partner 2FA / Get enrollment status

Get enrollment status

POST/v1/identities/status

Returns whether a partner user is enrolled for KEYRA Partner 2FA. Call this before enrollment or authentication.

Authentication

SERVER ONLY

Bearer clientId:clientSecret — Server secret required. Never call from browser code.

Request

Request body

Content-Type: application/json · required

  • externalUserIdstringrequired
  • projectIdstring (uuid)required

Response

200 Status

  • enrolledbooleanrequired
  • enrolledAtstringnullable
  • factorsobject[]required
    • typestringrequired
    • verifiedAtstringnullable
  • identityIdstringrequirednullable
  • statusstringrequired

Errors

ErrorHTTPMeaningFix
invalid_request400projectId or externalUserId invalidSend a UUID projectId and a non-empty externalUserId ≤ 128 chars Diagnose →

SDK equivalent

Examples

Bash
curl -X POST "https://auth.keyra.ie/v1/identities/status" \
  -H "Authorization: Bearer CLIENT_ID:CLIENT_SECRET" \
  -H "Content-Type: application/json" \
  -d '{"projectId":"11111111-1111-1111-1111-111111111111","externalUserId":"user_12345"}'

Response

response.jsonJSON
{
  "enrolled": true,
  "identityId": "idn_xxxxxxxx",
  "status": "active",
  "factors": [
    {
      "type": "phone_otp",
      "verifiedAt": "2026-01-15T10:00:00.000Z"
    }
  ],
  "enrolledAt": "2026-01-15T10:00:00.000Z"
}