Create MFA Confirmation

POSThttps://api.omise.co/mfa_confirmations

Create a multi-factor authentication confirmation for secure account operations. MFA confirmations provide an additional layer of security for sensitive actions.

---

Request Parameters

Required - 1 fieldRequired Parameters

▼

`code`STRING(required)

The MFA verification code from your authenticator app or SMS.

Example:"123456"

Additional - 1 fieldAdditional Parameters

▼

---

Responses

200

MFA confirmation created successfully

MFA confirmation created and verified. The confirmation can now be used for the associated action.

MFA confirmation object fields:

• object - String value "mfa_confirmation"
• id - MFA confirmation ID (mfa_*). Use this for subsequent operations.
• location - API endpoint path for this confirmation
• verified - Boolean indicating if MFA code was valid
• action - The action this confirmation is for
• expires_at - Expiration timestamp for the confirmation (ISO 8601)
• created_at - Confirmation creation timestamp (ISO 8601)

400

Bad request

Request validation failed. Check the error message for details.

Common causes:

• Missing required code parameter
• Invalid code format
• Incorrect MFA code
• MFA code has expired

401

Unauthorized

Authentication failed. Invalid or missing API key.

Common causes:

• Missing Authorization header
• Invalid secret key
• Using public key instead of secret key
• Incorrect HTTP Basic Auth format

404

Not found

MFA configuration not found for the account.

Common causes:

• MFA has not been enabled for the account
• Account does not have MFA configured

5xx

Server error

Server-side error occurred. These are rare but should be handled gracefully.

How to handle:

• Retry the request with exponential backoff
• Check status.omise.co for service incidents
• See Error Handling for detailed guidance

---

Code samples

cURL

curl https://api.omise.co/mfa_confirmations \
  -u skey_test_5xuy4w91xqz7d1w9u0t: \
  -d "code=123456" \
  -d "action=transfer_creation"

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

mfa_confirmation = Omise::MfaConfirmation.create({
  code: '123456',
  action: 'transfer_creation'
})

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

mfa_confirmation = omise.MfaConfirmation.create(
    code='123456',
    action='transfer_creation'
)

Node.js

const omise = require('omise')({
  secretKey: 'skey_test_5xuy4w91xqz7d1w9u0t'
});

const mfaConfirmation = await omise.mfaConfirmations.create({
  code: '123456',
  action: 'transfer_creation'
});

PHP

<?php
define('OMISE_SECRET_KEY', 'skey_test_5xuy4w91xqz7d1w9u0t');

$mfaConfirmation = OmiseMfaConfirmation::create([
    'code' => '123456',
    'action' => 'transfer_creation'
]);

Java

Client client = new Client.Builder()
    .secretKey("skey_test_5xuy4w91xqz7d1w9u0t")
    .build();

MfaConfirmation mfaConfirmation = client.mfaConfirmations().create()
    .code("123456")
    .action("transfer_creation")
    .send();

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

var mfaConfirmation = await client.MfaConfirmations.Create(new CreateMfaConfirmationRequest
{
    Code = "123456",
    Action = "transfer_creation"
});

Go

client, _ := omise.NewClient(
    "pkey_test_5xuy4w91xqz7d1w9u0t",
    "skey_test_5xuy4w91xqz7d1w9u0t",
)

mfaConfirmation, _ := client.MfaConfirmations().Create(&operations.CreateMfaConfirmation{
    Code:   "123456",
    Action: "transfer_creation",
})

---

Error and result codes

Common Error Codes

Code	Description	Resolution
bad_request	Missing or invalid parameters	Check code format and required fields
authentication_failure	Invalid API key	Verify your secret key is correct
invalid_mfa_code	MFA code is incorrect	Enter the correct code from your authenticator
expired_mfa_code	MFA code has expired	Request a new code and try again
mfa_not_enabled	MFA not configured	Enable MFA on your account first

MFA Confirmation Fields

Field	Description
id	MFA confirmation ID (use for subsequent operations)
verified	Boolean indicating if MFA was successful
action	The action this confirmation authorizes
expires_at	When the confirmation expires
created_at	Confirmation creation timestamp

---

🔑API Credentials

▼

Try it out

Required - 1 fields

▼

code(Required)

Additional - 1 fields

▼

Your IP: ...Loading...