Go to developer

Partner 2FA / Poll enrollment status

Poll enrollment status

GET/v1/identities/enroll/{enrollmentId}/status

Poll until enrollment reaches a terminal state (completed, expired, cancelled).

Authentication

SERVER ONLY

Bearer clientId:clientSecret — Server secret required.

Request

Path parameters

ParameterTypeRequiredDescription
enrollmentIdstringRequired

Response

200 Enrollment state

  • completedAtstringnullable
  • identityIdstringrequired
  • identityStatusstringrequired
  • statusstringrequired

404 Not found

  • detailsobject
  • errorstringrequired
  • messagestringrequired

SDK equivalent

  • TypeScript — @keyra/typescript-sdk: pollEnrollment(enrollmentId) / waitForEnrollment(...)
  • Java — ie.keyra:keyra-java-sdk: pollEnrollment / waitForEnrollment

Examples

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

Response

response.jsonJSON
{
  "identityId": "string",
  "identityStatus": "string",
  "status": "string"
}