One field section’s format, safe value and variants
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);}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
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”The section id, such as id.national.
Query Parameters
Section titled “Query Parameters”A two-letter country code, or UTO for Utopia. Required for ID and tax number sections, except passports, which default to UTO.
The test address the value is for, so it stays the same for that account.
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.
With kyc_sandbox: the result the test wants from the vendor’s sandbox.
Responses
Section titled “Responses”The section
object
Example generated
{}An error
object
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).
What went wrong and what to do, in words.
Example generated
{ "error": "example", "message": "example"}No API key, or one that isn’t valid: it may have been revoked, or its creator no longer has access to the project.
object
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).
What went wrong and what to do, in words.
Example generated
{ "error": "example", "message": "example"}Headers
Section titled “Headers”Bearer realm="proxymail-qa", with error="invalid_token" when a key was sent but isn’t valid.
An error
object
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).
What went wrong and what to do, in words.
Example generated
{ "error": "example", "message": "example"}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.
object
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).
What went wrong and what to do, in words.
Example generated
{ "error": "example", "message": "example"}Headers
Section titled “Headers”Seconds to wait before trying again. Sent with per-minute limits only.