---
title: "Wait for a verification, sign-in, invite or reset link"
method: GET
path: "/v1/addresses/{address}/link"
---

# Wait for a verification, sign-in, invite or reset link

`GET /v1/addresses/{address}/link`

## Request

- Base URL: `https://api.proxymail.qa`
- URL: `https://api.proxymail.qa/v1/addresses/{address}/link`
- Auth: HTTP bearer

Returns the newest such link received since `since`, waiting up to `timeout` seconds. We never open links: whoever calls decides whether to.

## Path parameters

- `address` string, email, required

## Query parameters

- `timeout` integer
- `service` string
- `since` string, date-time
- `unused` boolean
- `type` string
- `app` boolean

## Headers

- `Proxy-Mail-QA-Run` string, uuid
- `Proxy-Mail-QA-Test` string
- `Proxy-Mail-QA-Run-Retry` 'true'

## Response `200`

The link

- Match: A code or link and nothing else from the email.
  - `address` string
  - `type` 'code' | 'link'
  - `subtype` string: otp or coupon; verify, magic_signin, invite, reset or other.
  - `value` string: The code, or the link URL.
  - `service` string, nullable: Who sent it, e.g. Spotify.
  - `service_domain` string, nullable
  - `received_at` string, date-time
  - `expires_at` string, date-time, nullable: Only when the email says how long it lasts.
  - `email_id` string, uuid

## Other responses

- `404`: Nothing arrived in time, or the address isn't in this project. hint says why as far as we can tell; after a wait, refused lists mail we turned away since `since`.

---

[API](https://skmtc.dev/proxymail/apis/proxy-mail-qa-api.md) · [All operations](https://skmtc.dev/proxymail/apis/proxy-mail-qa-api/llms.txt) · [OpenAPI document](https://skmtc.dev/proxymail/apis/proxy-mail-qa-api/revisions/8f8a5e84cf5c?raw)