Start an SMS enrolment
POST
Starts enrolling the logged-in user in MFA by SMS, and sends a code to the phone number. For users only. The
first enrolment needs no password or mfa_token; later ones need both.
apiKeyheader
AuthorizationBasic <token>HTTP Basic authentication with your API key or the id of a token as the username and an empty password.
application/json- body
password?stringThe password of the user. Needed when the user already has MFA.
mfa_token?stringA code from a method the user already has. Needed when the user already has MFA.
force_send_sms?booleanSend an SMS code to confirm, when the user has both SMS and an authenticator app.
phone*stringThe phone number, starting with + and the country code.
The enrolment has started and the code is sent.
application/json- response
id?stringThe ID of the enrolment.
curl -X POST 'https://api.example.com/v1/mfa/enrollment/start/sms/' \ --user "$API_KEY:" \ -H 'Content-Type: application/json' \ -d '{ "phone": "+31612345678", "password": "correct-Horse-battery-7", "mfa_token": "123456"}'{ "id": "845c16de-f627-48cb-bc81-a6b3b1fb134b__bc060460-266e-43f2-a030-e8b8d80126da"}