Go to developer

Partner 2FA / Initiate recovery

Initiate recovery

POST/v1/identities/{identityId}/recovery/initiate

Starts a recovery session for an identity that lost device access.

Authentication

SERVER ONLY

Bearer clientId:clientSecret — Server secret required.

Request

Path parameters

ParameterTypeRequiredDescription
identityIdstringRequired

Response

201 Recovery session created

  • expiresInintegerrequired
  • recoverySessionIdstringrequired
  • recoveryUrlstringrequired

404 Not found

  • detailsobject
  • errorstringrequired
  • messagestringrequired

SDK equivalent

  • TypeScript — @keyra/typescript-sdk: recoverIdentity(externalUserId)

Examples

Bash
curl -X POST "https://auth.keyra.ie/v1/identities/idn_xxxxxxxx/recovery/initiate" \
  -H "Authorization: Bearer CLIENT_ID:CLIENT_SECRET"

Response

response.jsonJSON
{
  "expiresIn": 0,
  "recoverySessionId": "string",
  "recoveryUrl": "string"
}