---
title: "Checks for a sign-up, password reset or magic-link flow | Proxy Mail QA"
description: "Developer docs for Proxy Mail QA: the MCP server for coding agents, the REST API for test suites, and the Chrome extension."
url: https://proxymail.qa/docs/reference/operations/flowchecks
---

# Checks for a sign-up, password reset or magic-link flow

GET

/v1/flow-checks

```js
const url = 'https://api.proxymail.qa/v1/flow-checks?flow=sign_up';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```sh
curl --request GET \
  --url 'https://api.proxymail.qa/v1/flow-checks?flow=sign_up' \
  --header 'Authorization: Bearer <token>'
```

The checks to run on a flow of the app under test, beyond “the email arrived”: for sign\_up, a wrong code refused, the code working once, an expired code refused, the newest code after a resend, landing signed in, no second account for the same address and a second person unable to see the first one’s data; for password\_reset, the new password replacing the old, the link working once, only the newest link working and the link in another browser; for magic\_link, failing on second use, surviving a mail scanner and only the newest link working. Each check names its steps, what to expect and why it matters, and needs when it can’t always run. Your test runs them through the app, as a person would. See <https://proxymail.qa/docs/flow-checks>.

## Authorizations

- **[apiKey](https://proxymail.qa/docs/reference.html#apikey)**
- **[apiKeyHeader](https://proxymail.qa/docs/reference.html#apikeyheader)**

## Parameters

### Query Parameters

**flow**

required

string

Allowed values: sign\_up password\_reset magic\_link

Which flow to check.

## Responses

### 200

The checks

Media typeapplication/json

### object

**flow**

string

Allowed values: sign\_up password\_reset magic\_link

**checks**

Array<object>

### object

**id**

required

A stable name for the check, such as code\_works\_once.

string

**checks**

required

What it checks, e.g. “The code works only once”.

string

**needs**

Only when the check can’t always run: what it needs, and when to skip it and say so.

string

**steps**

required

What to do, in order.

Array<string>

**expect**

required

What the app should do.

string

**why**

required

What goes wrong for people when it doesn’t.

string

#### Example 

```json
{
  "flow": "sign_up"
}
```

### 400

An error

Media typeapplication/json

### object

**error**

What went wrong, as a code, such as bad\_request (400), unauthorized (401), plan\_required (402), forbidden (403), not\_found (404), method\_not\_allowed (405), conflict (409), content\_too\_large (413), rate\_limited, daily\_limit or account\_held (429), or server\_error (500).

string

**message**

What went wrong and what to do, in words.

string

#### Example generated

```json
{
  "error": "example",
  "message": "example"
}
```

### 401

No API key, or one that isn’t valid: it may have been revoked, or its creator no longer has access to the project.

Media typeapplication/json

### object

**error**

What went wrong, as a code, such as bad\_request (400), unauthorized (401), plan\_required (402), forbidden (403), not\_found (404), method\_not\_allowed (405), conflict (409), content\_too\_large (413), rate\_limited, daily\_limit or account\_held (429), or server\_error (500).

string

**message**

What went wrong and what to do, in words.

string

#### Example generated

```json
{
  "error": "example",
  "message": "example"
}
```

#### Headers

**WWW-Authenticate**

string

`Bearer realm="proxymail-qa"`, with `error="invalid_token"` when a key was sent but isn’t valid.

### 429

Too many requests. With a Retry-After header, a per-minute limit was reached: the key’s requests (60 a minute on Free, 600 on Team), password reveals (30 a minute per person), or keys that aren’t valid from one network (120 a minute). Without one, `error` says which longer limit: `daily_limit`, the space’s new addresses for today (50 on Free), until midnight UTC; `account_held`, 10 addresses a day while a Free account’s recent use is looked at; or `rate_limited` when something is full, such as a project’s 50 custom fields.

Media typeapplication/json

### object

**error**

What went wrong, as a code, such as bad\_request (400), unauthorized (401), plan\_required (402), forbidden (403), not\_found (404), method\_not\_allowed (405), conflict (409), content\_too\_large (413), rate\_limited, daily\_limit or account\_held (429), or server\_error (500).

string

**message**

What went wrong and what to do, in words.

string

#### Example generated

```json
{
  "error": "example",
  "message": "example"
}
```

#### Headers

**Retry-After**

integer

\>= 1

Seconds to wait before trying again. Sent with per-minute limits only.

[Previous](https://proxymail.qa/docs/reference/operations/cleanuplist.html): Test addresses to clean up from your app

[Next](https://proxymail.qa/docs/reference/operations/passwordvariants.html): Awkward passwords for a sign-up form's password field
