---
title: "Get values for a sign-up form"
method: POST
path: "/v1/form-values"
---

# Get values for a sign-up form

`POST /v1/form-values`

## Request

- Base URL: `https://api.proxymail.qa`
- URL: `https://api.proxymail.qa/v1/form-values`
- Auth: HTTP bearer

What to type or pick in each field of a sign-up form, from a new test address made for it (201) or from one made earlier (`address`, 200). Send what the page says about each field: its type, name, label, placeholder, autocomplete, rules and a drop-down's options. Each field gets a value: the email (and its confirmation), names, a username and a password that fit the field's rules, the date of birth in the field's format (or its day, month and year), and a country its drop-down offers; anything else (a terms checkbox, a phone number) gets null and a note. A new address gets a date of birth when the form asks for one (adult unless `age` says otherwise) and a country the form offers; its password is saved on it and shown only in this answer. Proxy Mail QA never sees or fills in the page: you do.

## Headers

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

## Request body

- object
  - `fields` object[], required
    - `id` string: Your name for the field: it comes back with its value. Default: its position.
    - `type` string: The input type, or select for a drop-down.
    - `name` string
    - `label` string
    - `placeholder` string
    - `autocomplete` string
    - `group` string: What the group around it says.
    - `pattern` string
    - `min_length` integer
    - `max_length` integer
    - `options` object[]
      - `value` string, required
      - `label` string
  - `address` string: Use this address instead of making one. Its saved password is not returned.
  - `label` string
  - `age` string: For a new address, when the form asks for a date of birth. Default: adult.
  - `date_of_birth` string, date
  - `country` string: For a new address. Default: one the form offers.
  - `domain` string
  - `lifetime_days` integer

## Response `200`

Values from the address given

- FormValues
  - `address` string
  - `created` boolean: True when this call made the address.
  - `persona` object, nullable
  - `password` string: A new address's password, saved on it. Shown only here.
  - `values` object[]
    - `id` string
    - `kind` 'email' | 'confirm_email' | 'first_name' | 'last_name' | 'full_name' | 'username' | 'password' | 'confirm_password' | 'date_of_birth' | 'birth_day' | 'birth_month' | 'birth_year' | 'country' | 'other'
    - `value` string, nullable: What to type, or the option's value to pick. Null to leave it to you.
    - `note` string

## Other responses

- `201`: Values from a new address made for this form
- `400`: 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)