---
title: "Check out an account from the pool"
method: POST
path: "/v1/addresses/checkout"
---

# Check out an account from the pool

`POST /v1/addresses/checkout`

## Request

- Base URL: `https://api.proxymail.qa`
- URL: `https://api.proxymail.qa/v1/addresses/checkout`
- Auth: HTTP bearer

An account in the project that matches every filter given, that nobody else has checked out, and that lives past the hold: the least recently used first. It's yours for `minutes` (default 10, at most 60): nobody else can check it out until you return it or the time runs out, which frees it on its own. Use the `checkout.token` to extend or return it. 409 when every matching account is checked out (saying when the first comes free), 404 when none match. Tag accounts with their state (verified, premium…) to make pools.

## Headers

- `Proxy-Mail-QA-Run` string, uuid
- `Proxy-Mail-QA-Test` string

## Request body

- object
  - `tags` string[]: Every one of these tags.
  - `country` string: ISO 3166-1 alpha-2, such as DE.
  - `min_age` integer
  - `max_age` integer
  - `has_password` boolean
  - `search` string: Part of the address, label, notes, name or username.
  - `site` string: Used on this site: a host or page URL.
  - `environment` string: Used in this environment, such as staging.
  - `minutes` integer

## Response `200`

The account, held for you

- object
  - `address` string
  - `label` string, nullable
  - `created_at` string, date-time
  - `expires_at` string, date-time
  - `persona` object, nullable
    - `first_name` string, nullable
    - `last_name` string, nullable
    - `username` string, nullable
    - `date_of_birth` string, date: Present only when the address has one.
    - `country` string: ISO 3166-1 alpha-2 code, such as GB. Present only when the address has one.
  - `notes` string, nullable
  - `tags` string[]
  - `has_password` boolean
  - `password` string: Only in the response to creating it with password: true.
  - `site` string: Where it is used: the host of the app under test. Present only when set.
  - `environment` string: Which environment it is used in, such as staging. Present only when set.
  - `email_count` integer
  - `latest` object, nullable: The newest code or link, like Match.
  - `checked_out_until` string, date-time: Only while someone has it checked out of the pool.
  - `checkout` object
    - `token` string, uuid
    - `until` string, date-time

## Other responses

- `400`: An error
- `404`: An error
- `409`: An error

---

[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)