Field sections a sign-up form may ask for
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);}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
Section titled “Authorizations”Parameters
Section titled “Parameters”Query Parameters
Section titled “Query Parameters”Only this country’s ID formats.
Only this group’s sections.
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 sections
object
object
Only on a section a ready-made custom field covers.
object
The options its value takes.
Only the project’s leads add or change it (the ID and tax numbers).
Example
{ "sections": [ { "ready_made": { "options": [ "ids_from" ] } } ]}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.
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.