Skip to content
GET
/v1/flow-checks
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.

flow
required
string
Allowed values: sign_up password_reset magic_link

Which flow to check.

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

{
"flow": "sign_up"
}

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

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

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

{
"error": "example",
"message": "example"
}
WWW-Authenticate
string

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

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

{
"error": "example",
"message": "example"
}
Retry-After
integer
>= 1

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