1. Docs
  2. API Reference
  3. OAuth hosted login: email a one-time MFA code

OAuth hosted login: email a one-time MFA code

POST/oauth/mfa/email-otp/send

Step 1 of the hosted email-OTP MFA factor: emails a one-time code to the identity's verified address for the active challenge_token, then re-renders the challenge page in its "code sent" state with the OAuth parameters replayed. Stays on the "email me a code" view with an error if the send fails. Throttled to 3 requests per minute.

Request body

application/json

challenge_tokenstring Required
client_idstring Required
redirect_uristring Required
response_typestring Required
scopestring Required
statestring Optional
code_challengestring Required
code_challenge_methodstring Required

Responses

200
Request
curl -X POST "https://auth.canopy-io.com/oauth/mfa/email-otp/send" \
  -H "Content-Type: application/json" \
  -d '{
    "challenge_token": "string",
    "client_id": "string",
    "redirect_uri": "string",
    "response_type": "string",
    "scope": "string",
    "state": "string",
    "code_challenge": "string",
    "code_challenge_method": "string"
  }'
Response
HTTP/1.1 200

(empty body)
 Related endpoints Was this page helpful?

Tell us how we can improve this guide.

Canopy