Two-Factor Authentication with MFA
Two-Factor authentication with Bandwidth MFA services
⚠️ Your account must be activated to use the MFA product. Please contact sales support to learn how to get access!
Request URL
POSThttps://mfa.bandwidth.com/api/v1/accounts/{accountId}/code/voice
Basic Authentication
Bandwidth's MFA API leverages Basic Authentication with your Dashboard API Credentials. Read more about how Bandwidth secures endpoints in the Security & Credentials document.
Supported Parameters
| Parameter | Required | Description |
|---|---|---|
| to | Yes | To telephone number |
| from | Yes | From telephone number |
| applicationId | Yes | The voice application id |
| scope | No | An optional field to denote what scope or action the 2fa code is addressing. If not supplied, defaults to "2FA". |
| message | Yes | The message format of the 2fa code. There are three values that the system will replace "{CODE}", "{NAME}", "{SCOPE}". The "{SCOPE}" and "{NAME} value template are optional, while "{CODE}" must be supplied. As the name would suggest, code will be replace with the actual 2fa code. Name is replaced with the application name, configured during provisioning of 2fa. The scope value is the same value sent during the call and partitioned by the server. |
| digits | Yes | The number of digits for your 2fa code. The valid number ranges from 2 to 8, inclusively. |
Response Attributes
| Property | Description |
|---|---|
| CallId | The Call Id |
Example 1 of 1: Authenticate with Voice
curl -X POST \
--url "https://mfa.bandwidth.com/api/v1/accounts/{accountId}/code/voice" \
-u '{username}:{password}' \
--data-raw '
{
"to" : "+12345678902",
"from" : "+12345678901",
"applicationId" : "93de2206-9669-4e07-948d-329f4b722ee2",
"scope" : "scope",
"digits" : 5,
"message" : "Your temporary {NAME} {SCOPE} code is {CODE}"
}
'
The above command returns a JSON Response structured like this:
Status: 200
Content-Type: application/json; charset=utf-8
{
"CallId": "1256-adf14asd-52dfa"
}
var response = controller.CreateVoiceTwoFactor(accountId, new TwoFactorCodeRequestSchema
{
ApplicationId = applicationId,
From = fromNumber,
To = toNumber,
Scope = "scope",
Digits = 5,
Message = "Your temporary {NAME} {SCOPE} code is {CODE}"
});
Console.WriteLine( response.Data.CallId );
TwoFactorCodeRequestSchema request = new TwoFactorCodeRequestSchema();
request.setApplicationId(applicationId);
request.setFrom(fromNumber);
request.setTo(toNumber);
request.setScope("scope");
request.setDigits(5);
request.setMessage("Your temporary {NAME} {SCOPE} code is {CODE}");
ApiResponse<TwoFactorVoiceResponse> response = controller.createVoiceTwoFactor(accountId, request);
System.out.println( response.getResult().getCallId() );
application_id = voice_application_id
body = TwoFactorCodeRequestSchema.new
body.from = from_phone
body.to = to_phone
body.application_id = application_id
body.scope = 'scope'
body.digits = 5
body.message = "Your temporary {NAME} {SCOPE} code is {CODE}"
auth_client.create_voice_two_factor(account_id, body)
body = TwoFactorCodeRequestSchema(
mfrom = from_phone,
to = to_phone,
application_id = voice_application_id,
scope = 'scope',
digits = 5,
message = "Your temporary {NAME} {SCOPE} code is {CODE}"
)
response = auth_client.create_voice_two_factor(account_id, body)
call_id = response.body.call_id
const payload = new mfa.TwoFactorCodeRequestSchema();
payload.applicationId = applicationId;
payload.from = fromNumber;
payload.to = toNumber;
payload.scope = 'scope';
payload.digits = 5;
payload.message = "Your temporary {NAME} {SCOPE} code is {CODE}";
const response = await controller.createVoiceTwoFactor(accountId, payload);
console.log(JSON.stringify(response, null, 2));
$scope = 'scope';
$body = new BandwidthLib\TwoFactorAuth\Models\TwoFactorCodeRequestSchema();
$body->from = $fromPhone;
$body->to = $toPhone;
$body->applicationId = $voiceApplicationId;
$body->scope = $scope;
$body->digits = 5;
$body->message = "Your temporary {NAME} {SCOPE} code is {CODE}";
$authClient->createVoiceTwoFactor($accountId, $body);