Check Command

optimus check validates VAT IDs from a CSV file or from a folder.

Syntax

optimus check <path> [options]

<path> is required. It can point to:

• A CSV file for single-file mode.
• A folder for folder mode.

Examples

Validate one CSV file with a mapping file:

optimus check customers.csv --map mapping.yml --standard

Run a qualified check and request a PDF report:

optimus check customers.csv --map mapping.yml --qualified --pdf

Run without a mapping file by naming the VAT ID column directly:

optimus check customers.csv --col-vat-id VatId --standard --token "<token>"

Process a folder:

optimus check C:\inbox\ --map mapping.yml

Validate parsing and mapping without calling the API:

optimus check customers.csv --map mapping.yml --standard --dry-run

Dry-run output includes a preview of the first 5 checkable rows that would be sent to the API. It does not create support logs.

Arguments

Argument	Description
<path>	Path to a CSV file or folder.

Options

Option	Value	Default	Description
--map	Path	not set	Path to the YAML mapping file.
--out	Path	<input-name>_result.csv in single-file mode	Path to the result CSV. Single-file mode only.
--token	String	OPTIMUS_TOKEN	Bearer token for API calls.
--env	test or prod	prod	API environment, unless a base URL is set.
--base-url	Absolute URL	depends on environment	Full API base URL override.
--col-vat-id	Column name or index	not set	Column containing VAT IDs. Required unless mapped in YAML.
--col-name	Column name or index	not set	Company name column.
--col-street	Column name or index	not set	Street column.
--col-zip	Column name or index	not set	Postal code column.
--col-city	Column name or index	not set	City column.
--in-delimiter	String	auto-detected or YAML	Input CSV delimiter.
--in-encoding	utf-8, windows-1252, iso-8859-1	utf-8	Input CSV encoding.
--no-header	Flag	false	Treat mappings as 1-based column indexes instead of header names.
--skip-rows	Number	0	Rows to skip before reading the header or records.
--out-delimiter	String	input delimiter or ;	Result CSV delimiter.
--out-encoding	utf-8, windows-1252, iso-8859-1	utf-8	Result CSV encoding.
--no-bom	Flag	false	Write output without a BOM.
--out-columns	Comma-separated list	default result columns	Select result CSV columns.
--pdf	Flag	false	Request a PDF report.
--no-pdf	Flag	false	Disable PDF output even when YAML enables it.
--sign	Flag	false	Digitally sign the PDF. Requires PDF output.
--no-sign	Flag	false	Disable signing even when YAML enables it.
--pdf-dir	Path	output directory or input directory	Folder for saved PDFs.
--pdf-timestamp	Flag	false	Add timestamp to PDF file names.
--transliteration	Flag	false	Enable transliteration for the validation request.
--notify	Flag	false	Ask the API to send a notification email.
--email-pdf	Flag	false	Ask the API to send the PDF by email. Requires PDF output.
--company-vat-id	VAT ID	not set	Own VAT ID used for validation.
--standard	Flag	not set	Request standard verification.
--qualified	Flag	not set	Request qualified verification.
--retry-duration	Duration	None	Retry duration: None, OneHour, TwoHours, FourHours, EightHours, TwentyFourHours.
--force-new	Flag	false	Start a new validation operation and replace saved resume state.
--dry-run	Flag	false	Validate file and mapping, print the first 5 checkable API rows, do not create support logs, and do not call the API.
--pattern	Glob	*.csv	File pattern for folder mode.
--min-age	Seconds	0	Minimum file age before folder mode picks up a file.
--on-duplicate	skip, overwrite, rename	skip	Duplicate file handling for folder mode moves.
--retry	Flag	false	Retry files that previously moved to the folder-mode error directory.
-v, --verbose	Flag	false	Show detailed output.
-q, --quiet	Flag	false	Only print errors.
--log-dir	Path	mode-specific logs folder	Folder for support logs.
--no-log	Flag	false	Disable the support log for this run.

Validation Rules

• <path> is required.
• --env must be test or prod.
• --verbose and --quiet cannot be used together.
• --sign requires PDF output and cannot be used with --no-pdf.
• --standard and --qualified cannot be used together.
• A check type is required through --standard, --qualified, or defaults.checkType in the mapping file.
• vatId must be mapped through --col-vat-id or columns.vatId.
• --out is not accepted in folder mode.