Skip to main content
PUT
Submit an MFA response for an account
This endpoint requires a valid authorisation for the user. If no active authorisation exists, the request will be rejected. You can optionally pass the x-teal-authorisation-id header to specify which authorisation to use; otherwise the system will resolve a valid authorisation automatically. See Authorisations for more details.

Authorizations

X-API-KEY
string
header
required

Headers

x-teal-authorisation-id
string<uuid>

Optional authorisation ID to associate with this request. If not provided, the system will attempt to resolve a valid authorisation for the user automatically.

Example:

"7f3b8c2a-1d4e-4f6a-8b8c-9a0b1c2d3e4f"

Path Parameters

account_id
string
required

ID of the account requiring MFA

Body

application/json
mfa
string
required

The MFA response value (code, date, or password characters depending on the MFA method)

Example:

"123456"

Response

MFA response accepted

account_id
string
required

The id of the account

Example:

"95a0e70b-fe02-4f47-aef9-2efff279df71"

payroll_provider
string
required

The payroll provider to use

Example:

"quickbooks"

user_name
string
required

The login of the user

Example:

"john.smith@company.com"

created_at
string<date-time>
required
Example:

"2019-05-17T00:00:00.000Z"

status
string

Status of account

Example:

"PENDING"

mfa_enabled
boolean

Is mfa enabled for this account

latest_pay_date
string<date-time>

The latest pay date of the payroll under this account

Example:

"2019-05-17T00:00:00.000Z"