Awkward names for a sign-up form's name field

GET

/v1/variants/names

curl --request GET \
  --url 'https://api.proxymail.qa/v1/variants/names?field=first_name' \
  --header 'Authorization: Bearer <token>'

Values for testing what a form does with a name: accept (a real person’s name: apostrophes, hyphens, accents, other scripts such as Chinese, Arabic or Thai, one letter, exactly the maximum), reject (over the maximum, empty, only spaces), store_as_text (HTML, a script tag, a SQL injection, a template expression: to be stored and shown exactly as typed, never run) and decide (digits, symbols, emoji, spaces around, a zero-width space, composed and decomposed accents, and 64, 128 and 255 characters when no maximum is given: apps differ, so note what the app did). See https://proxymail.qa/docs/unusual-names-and-passwords.

Authorizations

• apiKey

Parameters

Query Parameters

field

string

default: first_name

Allowed values: first_name last_name full_name display_name

Which field the values are for.

max_length

integer

>= 1 <= 1000

The field’s maximum length, when it has one: adds a value exactly that long and one over it.

Responses

200

The variants

Media typeapplication/json

object

field

string

max_length

integer

nullable

accept

Array<object>

object

tests

What the value checks, e.g. “A hyphen”.

string

value

What to type into the field, exactly.

string

reject

Array<object>

object

tests

What the value checks, e.g. “A hyphen”.

string

value

What to type into the field, exactly.

string

store_as_text

Array<object>

object

tests

What the value checks, e.g. “A hyphen”.

string

value

What to type into the field, exactly.

string

decide

Array<object>

object

tests

What the value checks, e.g. “A hyphen”.

string

value

What to type into the field, exactly.

string

Example ^generated

{
  "field": "example",
  "max_length": 1,
  "accept": [
    {
      "tests": "example",
      "value": "example"
    }
  ],
  "reject": [
    {
      "tests": "example",
      "value": "example"
    }
  ],
  "store_as_text": [
    {
      "tests": "example",
      "value": "example"
    }
  ],
  "decide": [
    {
      "tests": "example",
      "value": "example"
    }
  ]
}

400

An error

Media typeapplication/json

object

error

string

message

string

Example ^generated

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