Read verification documents
check_verification_documentsReads verification files before form submission, extracts fields and document types, and warns about unreadable, expired, mismatched, or wrong-type documents so users can correct them.
Instructions
Read the files of a number verification form, before the form is filled or submitted.
Takes the arguments of ``check_verification``. ``fields`` and ``address``
may be empty or partial. An AI model reads each file.
Returns ``fields``, ``address`` and ``documents.<slot>.fields``: the values the
files show, by the form's own keys, to fill the form after the user confirms
them. ``documents.<slot>.option`` is the document type the file looks like.
``warnings`` (``field``, ``kind``, ``message``) lists what the carrier may
refuse: an unreadable, upside-down or expired document, a file of another
type than the chosen one, or a typed name that differs from the printed one.
Each message names the fix. A submission with warnings is still accepted.
A file nothing was read from has ``read`` false; an unclear file also has an
``unreadable`` warning, and a file past the daily reads has ``skipped``
``daily_limit``. Only the first 3 pages of a PDF are read; a PDF of more
than 5 pages is not read.
Each file read uses one of the workspace's daily document reads (30 per day);
a file given for several slots uses one. Nothing is filed, saved, held or
charged, and uploads stay usable.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_documents"
}
}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. | |
| 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 document slot to ``{option, fields, covers}``. ``option`` may be empty while the type is not chosen. ``covers`` lists the other slots the same file stands for: the file is sent once, for this slot, and one read fills all of them. | |
| 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 | |||