Skip to main content

Integration CLI

Integration CLI is a command-line client for validating VAT IDs from CSV files or from a folder that receives CSV files automatically.

Your ERP cannot connect to an API? No problem. With Integration CLI, you can integrate VAT ID verification into any system automatically, without development effort.

Export your data as CSV and the CLI handles the rest: verify VAT IDs, validate company data, enrich company records, detect deviations, and return corrections.

Once set up, everything runs automatically in the background. If you have any questions, contact Optimus support.

Use it when you need to:

  • Validate a single CSV file and write a result CSV.
  • Run standard or qualified VAT ID checks.
  • Keep selected local columns, such as customer numbers, in the result file.
  • Save PDF reports when requested.
  • Process a mailbox-style folder with inbox, processing, done, error, and results folders.
  • Resume interrupted validation operations without starting duplicate API work.

The executable name is optimus. The current public command is:

optimus check <path>

<path> can be a CSV file or a folder.

Recommended setup

Put stable settings such as column mapping, delimiters, output columns, PDF defaults, and folder mode options in mapping.yml. Use command-line flags for one-off choices such as --env test, --dry-run, --out, or --verbose.

How The Docs Are Organized

Files Created By A Run

Depending on options, a run can create:

FilePurpose
customers_result.csvResult CSV for a single input file when --out is not set.
customers.csv.optimus-state.jsonSaved validation state used for resume behavior.
logs/optimus-check-*.logPrivacy-safe support log for the run.
*.pdfVAT validation report when PDF output is enabled.
error/*.errFolder mode error details for files that cannot be processed.