Begin Signup MFA

POST

/api/v1/signup/mfa/begin

curl --request POST \
  --url https://api.spartanauth.com/api/v1/signup/mfa/begin \
  --header 'Content-Type: application/json' \
  --data '{ "sectorID": "example", "email": "example", "transactionId": "example" }'

Sends an email OTP to begin MFA enrollment for a user in a sector that requires MFA at signup. Public endpoint, but it requires a recent transactionID proving the user has already completed the password step and returns a generic success response to avoid leaking account state.

Request Body

SignupMFABegin — sends an OTP to the new user’s email to begin MFA enrollment. Available for MFA-required sectors. transaction_id must be a valid transaction that has the password-challenge success bit set — this proves the caller either (a) just created the account (returned from CreateUser) or (b) passed PasswordChallenge.

Media type application/json

SignupMFABegin — sends an OTP to the new user’s email to begin MFA enrollment. Available for MFA-required sectors. transaction_id must be a valid transaction that has the password-challenge success bit set — this proves the caller either (a) just created the account (returned from CreateUser) or (b) passed PasswordChallenge.

object

sectorID

string

email

string

transactionId

required: proof of completed password challenge

string

Example ^generated

{
  "sectorID": "example",
  "email": "example",
  "transactionId": "example"
}

Responses

200

A successful response.

Media type application/json

object

Example ^generated

{}

default

An unexpected error response.

Media type application/json

object

code

integer format: int32

message

string

details

Array<object>

object

@type

string

key

additional properties

Example ^generated

{
  "code": 1,
  "message": "example",
  "details": [
    {
      "@type": "example"
    }
  ]
}