Sign in again as a saved test account

POST

/v1/addresses/sign-in

curl --request POST \
  --url https://api.proxymail.qa/v1/addresses/sign-in \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "site": "example", "environment": "example", "tags": [ "example" ] }'

The saved test account to sign in to the app under test with, and its password, in one call: one with a saved password and every tag given, that no test has checked out, the one used on this site first, then the one that got mail most recently. With site, an account not yet used anywhere is marked as used there. Needs a key with “Can read saved passwords”; every reveal is logged. 404 when none fits.

Authorizations

• apiKey

Request Body

Media typeapplication/json

object

site

The host or page URL of the sign-in form.

string

<= 300 characters

environment

Only accounts for this environment (or for none).

string

<= 40 characters

tags

Every one of these tags.

Array<string>

<= 20 items

Example ^generated

{
  "site": "example",
  "environment": "example",
  "tags": [
    "example"
  ]
}

Responses

200

The account and its password

Media typeapplication/json

object

address

string

label

string | null

created_at

string format: date-time

expires_at

string format: date-time

persona

object

first_name

string | null

last_name

string | null

username

string | null

date_of_birth

Present only when the address has one.

string format: date

country

ISO 3166-1 alpha-2 code, such as GB. Present only when the address has one.

string

notes

string | null

tags

Array<string>

has_password

boolean

password

Only in the response to creating it with password: true.

string

site

Where it is used: the host of the app under test. Present only when set.

string

environment

Which environment it is used in, such as staging. Present only when set.

string

email_count

integer

latest

The newest code or link, like Match.

object | null

checked_out_until

Only while someone has it checked out of the pool.

string format: date-time

password

string

used_on_site

Whether it had been used on this site before.

boolean

Example ^generated

{
  "address": "example",
  "label": "example",
  "created_at": "2026-04-15T12:00:00Z",
  "expires_at": "2026-04-15T12:00:00Z",
  "persona": {
    "first_name": "example",
    "last_name": "example",
    "username": "example",
    "date_of_birth": "2026-04-15",
    "country": "example"
  },
  "notes": "example",
  "tags": [
    "example"
  ],
  "has_password": true,
  "password": "example",
  "site": "example",
  "environment": "example",
  "email_count": 1,
  "latest": "example",
  "checked_out_until": "2026-04-15T12:00:00Z",
  "used_on_site": true
}

400

An error

Media typeapplication/json

object

error

string

message

string

Example ^generated

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

403

An error

Media typeapplication/json

object

error

string

message

string

Example ^generated

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

404

An error

Media typeapplication/json

object

error

string

message

string

Example ^generated

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

429

An error

Media typeapplication/json

object

error

string

message

string

Example ^generated

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