# Set enterprise MFA policy

Source: https://business-api-docs.youhodler.com/api/reference/policies/enterprises-mfa-assurance-set

**Authentication:** Send `Authorization: Bearer <access_token>`.

Requires both policies.manage and policies.read covering the target scope; the current setting is read for the audit diff before writing. Set mode to inherited to remove the scope setting. Setting optional beneath a mandatory ancestor returns HTTP 409 with data.reason=mfa_cannot_relax and data.resource naming that ancestor. A platform-owned setting may only be changed by platform staff with platform-wide policies.manage authority; other callers receive HTTP 403 with data.reason=mfa_setting_platform_owned. The required reason is trimmed and must contain 3 to 500 characters for the audit record. This changes the assurance policy; it does not enroll or remove an authentication factor.

## Parameters

| Name | Location | Type | Required | Description and constraints |
| --- | --- | --- | --- | --- |
| `enterprise_id` | path | string | Yes | format: uuid |

## Request

Required request body.

### Request body schema

| Field | Type | Required | Description and constraints |
| --- | --- | --- | --- |
| `mode` | "inherited" or "optional" / "mandatory" | Yes |  |
| `reason` | string | Yes | minLength: 3; maxLength: 500 |

Additional fields are not accepted.

#### Request body schema.mode

At least one alternative must match.

##### Request body schema.mode: alternative 1

Type: `"inherited"`. 

##### Request body schema.mode: alternative 2

Type: `"optional" / "mandatory"`.

**Request URL — PUT**
```http
PUT /enterprises/{enterprise_id}/mfa-assurance
```

**Request Body — application/json**
```json
{
  "mode": "mandatory",
  "reason": "Require fresh authentication for protected actions"
}
```

## Responses

**200 Operation succeeded**

Operation succeeded.

```json
{
  "effective_mode": "mandatory",
  "own_mode": "mandatory",
  "owner": "scope",
  "scope_ref": "enterprises/b8e2f1a0-4c3d-4e5f-9a1b-2c3d4e5f6a7b",
  "source_scope_ref": "enterprises/b8e2f1a0-4c3d-4e5f-9a1b-2c3d4e5f6a7b"
}
```

**400 Invalid request payload**

Invalid request payload, query, or parameter shape.

**401 Caller is not authenticated or the bearer token is invalid**

Caller is not authenticated or the bearer token is invalid.

**403 Caller lacks the required capability or permitted scope**

Caller lacks the required capability or permitted scope.

**404 Resource not found**

Resource not found.

**409 State conflict — the request cannot be applied to the current resource state**

State conflict — the request cannot be applied to the current resource state.

**500 An unexpected internal failure occurred**

An unexpected internal failure occurred. The public error code is temporarily_unavailable; internal details are not exposed.

**502 Upstream service returned an unexpected error**

Upstream service returned an unexpected error.

**503 Service is temporarily unavailable**

Service is temporarily unavailable; retry with backoff.
### Response 200 schema

Content type: `application/json`.

#### application/json body

| Field | Type | Required | Description and constraints |
| --- | --- | --- | --- |
| `effective_mode` | "optional" / "mandatory" | Yes |  |
| `own_mode` | "optional" / "mandatory" or null | Yes |  |
| `owner` | "scope" / "platform" or null | No |  |
| `scope_ref` | string or string | Yes |  |
| `source_scope_ref` | string or string or null | Yes |  |

Additional fields are not accepted.

##### application/json body.own_mode

At least one alternative must match.

###### application/json body.own_mode: alternative 1

Type: `"optional" / "mandatory"`. 

###### application/json body.own_mode: alternative 2

Type: `null`. 

##### application/json body.owner

At least one alternative must match.

###### application/json body.owner: alternative 1

Type: `"scope" / "platform"`. 

###### application/json body.owner: alternative 2

Type: `null`. 

##### application/json body.scope_ref

At least one alternative must match.

###### application/json body.scope_ref: alternative 1

Type: `string`. pattern: `^(enterprises)\/([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$`

###### application/json body.scope_ref: alternative 2

Type: `string`. pattern: `^(clients)\/([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$`

##### application/json body.source_scope_ref

At least one alternative must match.

###### application/json body.source_scope_ref: alternative 1

At least one alternative must match.

###### application/json body.source_scope_ref: alternative 1: alternative 1

Type: `string`. pattern: `^(enterprises)\/([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$`

###### application/json body.source_scope_ref: alternative 1: alternative 2

Type: `string`. pattern: `^(clients)\/([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$`

###### application/json body.source_scope_ref: alternative 2

Type: `null`.

### Response 400 schema

Content type: `application/json`.

#### application/json body

| Field | Type | Required | Description and constraints |
| --- | --- | --- | --- |
| `code` | string | Yes |  |
| `data` | object | No | No additional fields |
| `details` | object | No | Additional fields allowed |
| `message` | string | Yes |  |

Additional fields are not accepted.

##### application/json body.data

| Field | Type | Required | Description and constraints |
| --- | --- | --- | --- |
| `acr_values` | string | No | RFC 9470 step-up challenge (`insufficient_user_authentication`). |
| `blockers` | object[] | No | For `closure_preconditions_not_met` on a terminal lifecycle verb: what must be resolved before the transition. |
| `code` | string | No | For legal refusals: the document code the refusal is about. |
| `max_age` | string | No | RFC 9470 step-up challenge (`insufficient_user_authentication`). |
| `max_source_amount` | object | No | For `amount_below_minimum` / `amount_above_maximum`: the product maximum in source asset units; null means no maximum. No additional fields |
| `min_source_amount` | object | No | For `amount_below_minimum` / `amount_above_maximum`: the effective minimum in source asset units, fees included. No additional fields |
| `published_version` | string | No | For `document_version_superseded`: the version currently published. |
| `reason` | string | No | Typed refinement of `code`, from the failing service's contract. |
| `resource` | string | No | Resource kind a `resource_not_found` refers to. |
| `retry_after_ms` | integer | No | Suggested back-off in milliseconds for throttling or temporary unavailability; null means no delay is known. minimum: 0 |
| `source` | string | No | For `not_admissible`: the gate that denied (verification, lifecycle, policy, compliance). |

Additional fields are not accepted.

###### application/json body.data.blockers

For `closure_preconditions_not_met` on a terminal lifecycle verb: what must be resolved before the transition.

Type: `object[]`. 

###### application/json body.data.blockers item

| Field | Type | Required | Description and constraints |
| --- | --- | --- | --- |
| `description` | string | Yes |  |
| `type` | "non_zero_balance" / "active_sub_resources" / "pending_operations" / "active_users" / "active_service_accounts" / "active_role_assignments" | Yes |  |
| `assets` | object[] | No | minItems: 1 |
| `count` | integer | No | minimum: 0; maximum: 9007199254740991 |

Additional fields are not accepted.

###### application/json body.data.blockers item.assets

Type: `object[]`. minItems: 1

###### application/json body.data.blockers item.assets item

| Field | Type | Required | Description and constraints |
| --- | --- | --- | --- |
| `asset` | string | Yes | Currency code (ISO-4217 or on-chain ticker) pattern: `^[A-Z0-9]{1,16}$` |
| `kind` | "balance" / "held" / "owed" / "unsettled" | Yes |  |

Additional fields are not accepted.

###### application/json body.data.max_source_amount

For `amount_below_minimum` / `amount_above_maximum`: the product maximum in source asset units; null means no maximum.

| Field | Type | Required | Description and constraints |
| --- | --- | --- | --- |
| `currency` | string | Yes |  |
| `value` | string | Yes |  |

Additional fields are not accepted.

###### application/json body.data.min_source_amount

For `amount_below_minimum` / `amount_above_maximum`: the effective minimum in source asset units, fees included.

| Field | Type | Required | Description and constraints |
| --- | --- | --- | --- |
| `currency` | string | Yes |  |
| `value` | string | Yes |  |

Additional fields are not accepted.

### Response 401 schema

Content type: `application/json`.

#### application/json body

| Field | Type | Required | Description and constraints |
| --- | --- | --- | --- |
| `code` | string | Yes |  |
| `data` | object | No | No additional fields |
| `details` | object | No | Additional fields allowed |
| `message` | string | Yes |  |

Additional fields are not accepted.

##### application/json body.data

| Field | Type | Required | Description and constraints |
| --- | --- | --- | --- |
| `acr_values` | string | No | RFC 9470 step-up challenge (`insufficient_user_authentication`). |
| `blockers` | object[] | No | For `closure_preconditions_not_met` on a terminal lifecycle verb: what must be resolved before the transition. |
| `code` | string | No | For legal refusals: the document code the refusal is about. |
| `max_age` | string | No | RFC 9470 step-up challenge (`insufficient_user_authentication`). |
| `max_source_amount` | object or null | No | For `amount_below_minimum` / `amount_above_maximum`: the product maximum in source asset units; null means no maximum. No additional fields |
| `min_source_amount` | object | No | For `amount_below_minimum` / `amount_above_maximum`: the effective minimum in source asset units, fees included. No additional fields |
| `published_version` | string | No | For `document_version_superseded`: the version currently published. |
| `reason` | string | No | Typed refinement of `code`, from the failing service's contract. |
| `resource` | string | No | Resource kind a `resource_not_found` refers to. |
| `retry_after_ms` | integer or null | No | Suggested back-off in milliseconds for throttling or temporary unavailability; null means no delay is known. minimum: 0 |
| `source` | string | No | For `not_admissible`: the gate that denied (verification, lifecycle, policy, compliance). |

Additional fields are not accepted.

###### application/json body.data.blockers

For `closure_preconditions_not_met` on a terminal lifecycle verb: what must be resolved before the transition.

Type: `object[]`. 

###### application/json body.data.blockers item

| Field | Type | Required | Description and constraints |
| --- | --- | --- | --- |
| `description` | string | Yes |  |
| `type` | "non_zero_balance" / "active_sub_resources" / "pending_operations" / "active_users" / "active_service_accounts" / "active_role_assignments" | Yes |  |
| `assets` | object[] | No | minItems: 1 |
| `count` | integer | No | minimum: 0; maximum: 9007199254740991 |

Additional fields are not accepted.

###### application/json body.data.blockers item.assets

Type: `object[]`. minItems: 1

###### application/json body.data.blockers item.assets item

| Field | Type | Required | Description and constraints |
| --- | --- | --- | --- |
| `asset` | string | Yes | Currency code (ISO-4217 or on-chain ticker) pattern: `^[A-Z0-9]{1,16}$` |
| `kind` | "balance" / "held" / "owed" / "unsettled" | Yes |  |

Additional fields are not accepted.

###### application/json body.data.max_source_amount

For `amount_below_minimum` / `amount_above_maximum`: the product maximum in source asset units; null means no maximum.

| Field | Type | Required | Description and constraints |
| --- | --- | --- | --- |
| `currency` | string | Yes |  |
| `value` | string | Yes |  |

Additional fields are not accepted.

###### application/json body.data.min_source_amount

For `amount_below_minimum` / `amount_above_maximum`: the effective minimum in source asset units, fees included.

| Field | Type | Required | Description and constraints |
| --- | --- | --- | --- |
| `currency` | string | Yes |  |
| `value` | string | Yes |  |

Additional fields are not accepted.

### Response 403 schema

Content type: `application/json`.

See [response 401 schema](#response-401-schema).

### Response 404 schema

Content type: `application/json`.

See [response 401 schema](#response-401-schema).

### Response 409 schema

Content type: `application/json`.

See [response 401 schema](#response-401-schema).

### Response 500 schema

Content type: `application/json`.

See [response 401 schema](#response-401-schema).

### Response 502 schema

Content type: `application/json`.

See [response 400 schema](#response-400-schema).

### Response 503 schema

Content type: `application/json`.

See [response 400 schema](#response-400-schema).
