API referenceMfa

Confirm the code and switch it on

Prove the app works, then turn the factor on. Returns recovery codes. They are shown once and stored hashed, so a member who does not keep them and then loses their phone needs support to intervene — which is why the response is the only place they appear and why the screen showing them has to say so.

POST
/api/b/v1/mfa/activate

Prove the app works, then turn the factor on.

Returns recovery codes. They are shown once and stored hashed, so a member who does not keep them and then loses their phone needs support to intervene — which is why the response is the only place they appear and why the screen showing them has to say so.

Authorization

OAuth2PasswordBearer
AuthorizationBearer <token>

In: header

admin_access_token?string|null

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

curl -X POST "https://example.com/api/b/v1/mfa/activate" \  -H "Content-Type: application/json" \  -d '{    "code": "123456"  }'
{  "recovery_codes": [    "string"  ]}