Checks for a sign-up, password reset or magic-link flow
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);}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
Section titled “Authorizations”Parameters
Section titled “Parameters”Query Parameters
Section titled “Query Parameters”Which flow to check.
Responses
Section titled “Responses”The checks
object
object
A stable name for the check, such as code_works_once.
What it checks, e.g. “The code works only once”.
Only when the check can’t always run: what it needs, and when to skip it and say so.
What to do, in order.
What the app should do.
What goes wrong for people when it doesn’t.
Example
{ "flow": "sign_up"}An error
object
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).
What went wrong and what to do, in words.
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.
object
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).
What went wrong and what to do, in words.
Example generated
{ "error": "example", "message": "example"}Headers
Section titled “Headers”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.
object
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).
What went wrong and what to do, in words.
Example generated
{ "error": "example", "message": "example"}Headers
Section titled “Headers”Seconds to wait before trying again. Sent with per-minute limits only.