Go to developer

Partner 2FA / Get enrollment status (GET)

Get enrollment status (GET)

GET/v1/identities/status

Same handler as POST /v1/identities/status. Prefer POST for SDK parity.

Authentication

SERVER ONLY

Bearer clientId:clientSecret — Server secret required.

Request

Query parameters

ParameterTypeRequiredDescription
externalUserIdstringRequired
projectIdstringRequired

Response

200 Status

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

Examples

Bash
curl -X GET "https://auth.keyra.ie/v1/identities/status" \
  -H "Authorization: Bearer CLIENT_ID:CLIENT_SECRET"

Response

response.jsonJSON
{
  "enrolled": true,
  "factors": [
    {
      "type": "string"
    }
  ],
  "identityId": "string",
  "status": "string"
}