# permission.check

> For the complete documentation index, see [llms.txt](https://ensforge.com/llms.txt).

Checks whether an account may perform one operation on an ENS name, and lists exactly what it lacks when it may not. Errors and examples for permission.check.

Source: https://ensforge.com/docs/reference/sdk/permission/check

<ApiMeta kind="Read" stability="stable" since="1.0.0" source="packages/sdk/src/actions/permission/check/index.ts#L54" batchable />

Checks whether an account may perform one operation on an ENS name, and lists exactly what it
lacks when it may not.

## When to use [#when-to-use]

Use to explain to a user why a change is not possible, or which role or approval to request.

## Details [#details]

- `via` says how the account is allowed: owner, operator, approved, delegate, roles or anyone.
- `missing` lists ownership or approvals, roles on a resource, or what blocks the change for
  everyone (a burned fuse, the name's status, a transfer rule).
- Writes use the same engine to explain failed simulations as `UnauthorizedError`.

## Signature [#signature]

```ts
function check(client: Like, options: check.Options): Promise<check.ReturnType>
```

Call it as `ens.permission.check(options)` on a client, or `Actions.permission.check(client, options)`.

`permission.check.request(options)` builds a deferred read for `Actions.batch`. See [Look up many at once](/docs/sdk/look-up-many-at-once).

## Parameters [#parameters]

| Option | Type | Default | Description |
| --- | --- | --- | --- |
| `name` (required) | `string` |  | ENS name. Normalized automatically. |
| `operation` (required) | `Operation` |  | The operation to check. |
| `account` | `string` | the client's account | Account to check. |

Also takes the [read options](/docs/reference/sdk/client#read-options).

## Returns [#returns]

Resolves to `PermissionCheck`. Whether it is allowed, how, and what is missing.

| Field | Type | Description |
| --- | --- | --- |
| `allowed` | `boolean \| null` | `null` when the contract's permission model is unknown (a custom resolver). |
| `via` | `Authority \| null` |  |
| `contract` | `Address \| null` | Contract that enforces the operation. |
| `resource` | `bigint \| null` | EAC resource checked, for role-based contracts. |
| `missing` | `readonly UnauthorizedError.Requirement[]` |  |

## Errors [#errors]

| Error | Codes | When |
| --- | --- | --- |
| [`InvalidInputError`](/docs/reference/errors/invalid-input-error) | [`INVALID_NAME`](/docs/reference/errors/INVALID_NAME), [`INVALID_ADDRESS`](/docs/reference/errors/INVALID_ADDRESS), [`INVALID_COIN_TYPE`](/docs/reference/errors/INVALID_COIN_TYPE) | invalid input. |
| [`ConfigError`](/docs/reference/errors/config-error) | [`WALLET_NOT_CONFIGURED`](/docs/reference/errors/WALLET_NOT_CONFIGURED) | without `account` or a client account. |
| [`NetworkError`](/docs/reference/errors/network-error) | [`RPC_REQUEST_FAILED`](/docs/reference/errors/RPC_REQUEST_FAILED), [`RPC_TIMEOUT`](/docs/reference/errors/RPC_TIMEOUT), [`RATE_LIMITED`](/docs/reference/errors/RATE_LIMITED) | the RPC request fails. |

It can also fail with the errors every read can (`Errors.CommonError`: `ConfigError`, `ContractRevertError`, `InternalError`, `NetworkError`).

See [How errors work](/docs/sdk/errors-explained).

## Examples [#examples]

<Tabs groupId="api" items={["Client","Standalone","Effect"]} persist>
<Tab>
```ts title="Explaining a disabled button"
const { allowed, missing } = await ens.permission.check({ name: "alice.eth", operation: "setResolver" })
```
</Tab>

<Tab>
```ts title="Checking a text record with a standalone call"
import { Actions } from "@ensforge/sdk"

const result = await Actions.permission.check(publicClient, { name: "alice.eth", account, operation: { setRecord: "text", key: "url" } })
```
</Tab>

<Tab>
```ts title="Checking in an Effect program"
import { Actions } from "@ensforge/sdk/effect"

const result = yield* Actions.permission.check(ens, { name: "alice.eth", operation: "transfer" })
```
</Tab>
</Tabs>

## Example response [#example-response]

Recorded from Ethereum mainnet on 2026-11-18 at block 26443964. Values change as the chain does.

```ts
await ens.permission.check({ name: "nick.eth", operation: "transfer", account: "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045" })
```

```json
{
  "allowed": false,
  "via": null,
  "contract": "0xf60aba43E1f7F3DAB1186Ff03B561401C9Df85E2",
  "resource": null,
  "missing": [
    {
      "type": "owner",
      "contract": "0xf60aba43E1f7F3DAB1186Ff03B561401C9Df85E2",
      "owner": "0xb8c2C29ee19D8307cb7255e1Cd9CbDE883A267d5"
    }
  ]
}
```

## See also [#see-also]

- [`permission.get`](/docs/reference/sdk/permission/get) for every operation at once