---
title: "One field section’s format, safe value and variants | 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/getformsection
---

# One field section’s format, safe value and variants

GET

/v1/form-sections/{id}

```js
const url = 'https://api.proxymail.qa/v1/form-sections/example?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/example?kyc_sandbox=stripe&kyc_outcome=pass' \
  --header 'Authorization: Bearer <token>'
```

For an ID or tax number in one country: its format (shape, pattern, check digit), a fake value that follows the format, given only where one can never be a real person’s, accept and reject variants, its tier and a note. A format with a rule only, such as My Number, a PAN, a UK or EU VAT number, an ABN or a UK passport, gets the rule and any reject variants, but no value; Korea’s RRN gets nothing. id.passport defaults to Utopia (UTO), ICAO’s fictional state, and a passport value comes with its expiry and machine-readable lines (MRZ), for the account’s own name and date of birth when address is one of yours. Values are made here, never checked: check one with the pattern, or the npm or Python helper, on your own machine. With kyc\_sandbox, a KYC vendor’s own sandbox values for the section, for kyc\_outcome (country optional).

## Authorizations

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

## Parameters

### Path Parameters

**id**

required

string

The section id, such as id.national.

### Query Parameters

**country**

string

/^(\[A-Za-z\]{2}|UTO|uto)$/

A two-letter country code, or UTO for Utopia. Required for ID and tax number sections, except passports, which default to UTO.

**address**

string

The test address the value is for, so it stays the same for that account.

**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 section

Media typeapplication/json

### object

#### Example generated

```json
{}
```

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

### 404

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"
}
```

### 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/listsignupstarters.html): Sign-up form starters

[Next](https://proxymail.qa/docs/reference/operations/namevariants.html): Awkward names for a sign-up form's name field
