Go to developer

Partner 2FA / Consume verification token

Consume verification token

POST/v1/auth/challenge/{challengeId}/consume

One-time consume of verificationToken. After success, create your application session — KEYRA does not create it.

Authentication

SERVER ONLY

Bearer clientId:clientSecretServer secret required.

Request

Path parameters

ParameterTypeRequiredDescription
challengeIdstringRequired

Request body

Content-Type: application/json · required

  • verificationTokenstringrequired

Response

200 Consumed

  • challengeIdstringrequired
  • consumedbooleanrequired
  • identityIdstringrequirednullable

401 Invalid token

  • detailsobject
  • errorstringrequired
  • messagestringrequired

409 Already consumed

  • detailsobject
  • errorstringrequired
  • messagestringrequired

Errors

ErrorHTTPMeaningFix
invalid_token401Token missing, wrong, or expiredUse the fresh verificationToken from poll Diagnose →
already_consumed409Token already usedStart a new challenge; do not retry consume Diagnose →

SDK equivalent

Examples

Bash
curl -X POST "https://auth.keyra.ie/v1/auth/challenge/chg_xxxxxxxx/consume" \
  -H "Authorization: Bearer CLIENT_ID:CLIENT_SECRET" \
  -H "Content-Type: application/json" \
  -d '{"verificationToken":"vrf_xxxxxxxx"}'

Response

response.jsonJSON
{
  "challengeId": "string",
  "consumed": true,
  "identityId": "string"
}