---
title: "Field sections a sign-up form may ask for | Proxy Mail QA"
description: "Developer docs for Proxy Mail QA: the MCP server for coding agents, the REST API for test suites, and the Chrome extension."
url: https://proxymail.qa/docs/reference/operations/listformsections
---

# Field sections a sign-up form may ask for

GET

/v1/form-sections

```js
const url = 'https://api.proxymail.qa/v1/form-sections?group=person&kyc_sandbox=stripe&kyc_outcome=pass';
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);
}
```

```sh
curl --request GET \
  --url 'https://api.proxymail.qa/v1/form-sections?group=person&kyc_sandbox=stripe&kyc_outcome=pass' \
  --header 'Authorization: Bearer <token>'
```

The field catalogue: each section (person, account, business and documents) with its labels in nine languages, where its value comes from and, for IDs and tax numbers, the countries it has formats for and their tier: A (a published test value), B (a shape that’s never issued), rule\_only or not\_offered. Sections a ready-made custom field covers have `ready_made`: its options and whether only leads add or change it. See <https://proxymail.qa/docs/field-formats>.

## Authorizations

- **[apiKey](https://proxymail.qa/docs/reference.html#apikey)**
- **[apiKeyHeader](https://proxymail.qa/docs/reference.html#apikeyheader)**

## Parameters

### Query Parameters

**country**

string

/^\[A-Za-z\]{2}$/

Only this country’s ID formats.

**group**

string

Allowed values: person account business documents

Only this group’s sections.

**kyc\_sandbox**

string

Allowed values: stripe plaid onfido veriff didit cashfree setu

A KYC vendor: adds its published sandbox values (kyc\_sandbox in the answer), labelled as that vendor’s, with links. Only for that vendor’s test mode.

**kyc\_outcome**

string

default: pass

Allowed values: pass fail review

With kyc\_sandbox: the result the test wants from the vendor’s sandbox.

## Responses

### 200

The sections

Media typeapplication/json

### object

**country**

string

nullable

**group**

string

nullable

**sections**

Array<object>

### object

**ready\_made**

Only on a section a ready-made custom field covers.

### object

**options**

The options its value takes.

Array<string>

Allowed values: ids\_from phones checked

**leads\_only**

Only the project’s leads add or change it (the ID and tax numbers).

boolean

**note**

string

#### Example 

```json
{
  "sections": [
    {
      "ready_made": {
        "options": [
          "ids_from"
        ]
      }
    }
  ]
}
```

### 400

An error

Media typeapplication/json

### object

**error**

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

string

**message**

What went wrong and what to do, in words.

string

#### Example generated

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

### 401

No API key, or one that isn’t valid: it may have been revoked, or its creator no longer has access to the project.

Media typeapplication/json

### object

**error**

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

string

**message**

What went wrong and what to do, in words.

string

#### Example generated

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

#### Headers

**WWW-Authenticate**

string

`Bearer realm="proxymail-qa"`, with `error="invalid_token"` when a key was sent but isn’t valid.

### 429

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.

Media typeapplication/json

### object

**error**

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

string

**message**

What went wrong and what to do, in words.

string

#### Example generated

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

#### Headers

**Retry-After**

integer

\>= 1

Seconds to wait before trying again. Sent with per-minute limits only.

[Previous](https://proxymail.qa/docs/reference/operations/getvariants.html): Unusual versions of the address, for testing sign-up forms

[Next](https://proxymail.qa/docs/reference/operations/listsignupstarters.html): Sign-up form starters
