# recovery.getStatus

Read mailbox recovery posture.

Reports whether this mailbox has a verified recovery address and how many recovery codes remain. The address is masked for every principal except system.

```ts
openemail.recovery.getStatus(
  identityId: string,
  options?: CallOptions,
): ApiPromise<RecoveryStatus>
```

It calls `GET /identities/{identityId}/recovery`: [Read mailbox recovery posture](/docs/api/credentials/get_RecoveryStatusRead) in the API reference.

## Example

```ts
const recoveryStatus = await openemail.recovery.getStatus(identityId)
```

## Arguments

| Argument | Type | Description |
| --- | --- | --- |
| `identityId` | `string` | Mailbox identity ULID. The path's `{identityId}`. |

## Options

It takes no options of its own. Every call also takes `signal`, `timeout`, `retry` and `headers`, which say how that one call is sent ([call options](/docs/sdks/typescript/calling-methods#call-options)).

## Answer

Awaited, it is the API's JSON, [`RecoveryStatus`](/docs/sdks/typescript/types/recovery-status). It is an [`ApiPromise`](/docs/sdks/typescript/responses): `.withResponse()` gives the same with the `Response` it came in, for its headers.

## Errors

| Status | What it means |
| --- | --- |
| `401` | unauthorized: the bearer credential is missing, malformed, expired, or revoked. Carries a `WWW-Authenticate: Bearer` challenge |
| `404` | Mailbox not found or not accessible to this principal |
| `503` | temporary_failure: the platform's storage could not answer just now; retry after the Retry-After window. Any operation can answer this. A write that got it may have been applied, so retry it with the same idempotency key where it takes one, or read the state back first (see Transient failures in the API description) |

A failed call rejects with a [`RequestError`](/docs/sdks/typescript/errors): its `status`, and its `code`, the API's `error`. Decide on the code: one status covers several.

## Types

It names these types of the API, each on a page of its own: [`RecoveryStatus`](/docs/sdks/typescript/types/recovery-status).
