Partner 2FA / Consume verification token
/v1/auth/challenge/{challengeId}/consumeOne-time consume of verificationToken. After success, create your application session — KEYRA does not create it.
Bearer clientId:clientSecret — Server secret required.
| Parameter | Type | Required | Description |
|---|---|---|---|
challengeId | string | Required |
Content-Type: application/json · required
verificationTokenstringrequired200 Consumed
challengeIdstringrequiredconsumedbooleanrequiredidentityIdstringrequirednullable401 Invalid token
detailsobjecterrorstringrequiredmessagestringrequired409 Already consumed
detailsobjecterrorstringrequiredmessagestringrequired| Error | HTTP | Meaning | Fix |
|---|---|---|---|
invalid_token | 401 | Token missing, wrong, or expired | Use the fresh verificationToken from poll Diagnose → |
already_consumed | 409 | Token already used | Start a new challenge; do not retry consume Diagnose → |
@keyra/typescript-sdk: consumeChallenge(challengeId, verificationToken)ie.keyra:keyra-java-sdk: consumeChallenge(...)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
{
"challengeId": "string",
"consumed": true,
"identityId": "string"
}