Check a verification
check_verificationValidate a carrier registration form before filing by running every Hail check for purpose rules, credits, duplicates, files, and required fields without submitting, saving, or charging.
Instructions
Check a carrier registration form without filing anything.
Takes the same arguments as ``submit_verification`` except ``attest_authorized``.
Runs every check Hail can run before filing: purpose rules, credit (402),
the carrier's current form, duplicates (409), field lengths, each file
(type, size, and for ``upload_id`` that it is this workspace's verification
document, uploaded within the last hour), and the form's required fields,
documents and address (for ``purpose="sms"``, the US texting application).
Nothing is filed, saved, held or charged, and uploads stay usable.
Returns ``ok``, ``files`` (slot, upload_id, size_bytes, sha256 per file) and
``note``; problems come back as ``problems`` with the field named.
The carrier runs its own checks at submission.Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"country_code": "<country_code>",
"number_type": "<number_type>",
"fields": "<fields>",
"documents": "<documents>",
"files": "<files>"
},
"name": "check_verification"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| files | Yes | The document files, one per slot named in ``documents``. Use an upload: the ``id`` from ``create_file_upload`` with purpose ``verification_document``, within an hour of uploading. A very small file can go inline as base64 instead. Each file is at most 10 MiB. | |
| fields | Yes | Applicant answers keyed by the field names in ``get_verification_requirements``. Choice fields take comma-separated option keys. | |
| address | No | The applicant's address. Give it when the requirements include one; otherwise leave it out. | |
| purpose | No | What the registration is for: ``number`` registers the applicant so a number can be bought; ``sms`` registers US texting (local 10DLC or toll-free). | number |
| quote_id | No | The number offer this registration lets the user buy: the offer's ``quote_id`` from ``quote_numbers``, the same one used for the requirements. Give it when ``purpose`` is ``number``; leave it out for ``sms``. | |
| documents | Yes | Map from each needed document slot to ``{option, fields}``, with the option chosen from that slot in the requirements. | |
| number_id | No | The owned number this registration is for: its ID from ``list_numbers``, the same one used for the requirements. Give it for toll-free texting and when the form asks for the sending number; otherwise leave it out. | |
| number_type | Yes | The kind of number this registration covers. Copy it from the offer in ``quote_numbers`` or the number in ``list_numbers``. | |
| country_code | Yes | ISO 3166-1 alpha-2 country code, such as ``US``. | |
| subject_type | No | Who the registration is for, matching the requirements: the user (``person``) or their company (``business``). It has no default; without it, nothing is sent. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||