Validate an EU VAT number against the official European Commission VIES service (27 EU states + XI Northern Ireland).
Use when asked whether a VAT ID is valid/active, before zero-rated reverse-charge B2B invoices, or to get a company's
registered name/address from its VAT number. Input: VAT with country prefix, e.g. 'IE6388047V', 'DE811193231' (spaces/dots ok).
Returns status: valid | invalid | invalid_format | member_state_unavailable (VIES/member state down - retry later, valid=null) | error,
plus name, address (if the member state discloses them; DE/ES often don't) and consultation_number (audit proof) when requester is set.
UK (GB) VAT checks are coming soon: until HMRC live access is granted, GB numbers return
status member_state_unavailable, valid=null, error HMRC_LIVE_ACCESS_PENDING (not charged). For >1 number use verify_batch.
Parametersvatrequiredrequester
Validate up to 100 EU VAT numbers in one call via VIES (supplier/customer list cleanup, onboarding, invoice runs).
Same per-item result as verify_vat; items with member_state_unavailable should be retried later
(GB items stay member_state_unavailable until HMRC live access is granted; they are not charged).
Parametersvatsrequiredrequester
Look up a company in official European business registers by name or registry number.
country: FR (SIREN), NO (org.nr), FI (Y-tunnus), CZ (ICO), PL (KRS number), EE, or any other ISO code / 'LEI' (GLEIF).
Returns legal name, ID, status/active, address, VAT ID, activity code and official source link.
Use to confirm a company exists and is active, find its registry number, or map a name to a VAT ID.
Parameterslimitqueryrequiredcountry
Screen a person or company name against official EU, UN, OFAC SDN and UK sanctions lists.
Fuzzy matching with transliteration; returns candidate matches with 0-100 scores, list, programme, DOB.
A potential match needs human review; this is a screening aid, not legal advice.
Parametersnamerequiredcountrythresholdbirth_year
One-call KYB check of a supplier/customer: EU VAT validation (VIES) + official business register
+ EU/UN/OFAC/UK sanctions screening, returning a pass / review / fail verdict with reasons.
company: a VAT ID ('FR40303265045'), a company name, or a registry id; country: optional ISO code (e.g. 'NO').
Parameterscompanyrequiredcountryrequester
Validate an EU EORI (customs Economic Operators Registration and Identification) number, e.g. 'SE5560360793',
'DE1234567890123', against the official European Commission EOS service. Use for import/export, customs declarations
and freight-forwarder onboarding. Returns valid/invalid and trader name/address only when the trader consented to publication.
UK (GB) EORIs are not in EOS (HMRC checks those); XI EORIs are.
Parameterseorirequired
Validate up to 100 EU EORI numbers in one call via the official EC EOS service (customs / import-export KYB).
Parameterseorisrequired
Validate an EU e-invoice XML (UBL 2.1 Invoice/CreditNote or UN/CEFACT CII, e.g. XRechnung, Factur-X/ZUGFeRD XML) against the
official CEN EN 16931 rules and, for XRechnung, the KoSIT XRechnung 3.0 rules. Returns valid, and every error with its rule ID
(e.g. BR-CO-10), a plain-English message, XPath and a fix hint. rules: auto | en16931 | xrechnung. Slovak sellers also get eFaktúra field
checks (FR SR transposition v1.12, warnings with ruleset SK-FS); Norwegian sellers get NO-LAW field checks. Peppol-specific rules are not checked yet.
For PDFs use the REST endpoint POST /einvoice/validate.
Parametersxmlrequiredrules
Read an incoming EU e-invoice into one JSON shape: seller, buyer, dates, references, totals, VAT breakdown, payment/IBAN, lines and
attachments. Accepts UBL 2.1 Invoice/CreditNote or UN/CEFACT CII XML (XRechnung, Peppol BIS 3, Factur-X XML) in xml, or a ZUGFeRD/Factur-X
PDF as base64 in pdf_base64. Use when asked to read, extract or book a received e-invoice. Values are returned as written in the invoice;
this does NOT validate it (use validate_einvoice for that).
Parametersxmlpdf_base64
Create a validated EU e-invoice (UBL 2.1) from simple JSON. invoice = {format: en16931|xrechnung|peppol-bis3, invoice_number,
issue_date (YYYY-MM-DD), due_date?, tax_point_date?, delivery_date?, currency (EUR), buyer_reference?, seller: {name, vat_id, street, city,
postal_code, country, email, phone, contact_name, company_id?, company_id_scheme?, legal_form?}, buyer: {...}, lines: [{description, quantity, unit_price, unit?, vat_category (S|Z|E|AE|K|G|O), vat_rate}],
payment: {iban, bic?, terms?}}. Totals and VAT breakdown are computed; returns {valid, xml, totals, errors}.
Parametersinvoicerequired
'Can I e-invoice this company?' id = EU VAT number (e.g. 'BE0403170701') or Peppol id ('0208:0403170701').
Returns VIES VAT status, Peppol registration (Peppol Directory, then SML/SMP; BIS 3 invoice support), the country's B2B e-invoice mandate
(dates, format, source) and the recommended format for create_einvoice. France's PPF directory is not included yet.
Parametersidrequired
SANDBOX ONLY - never reaches a real buyer. Runs the full send flow on an invoice (same JSON as create_einvoice): VIES check
of the buyer VAT, sanctions screen of the buyer name, EN 16931 create + validate, route lookup (Peppol/mandate), transport
hand-off and an Ed25519-signed evidence receipt (JWS). transport: "mock" (simulated, default), "recommand" or "e-invoice-be"
(the UBL is really submitted to that Peppol access point's sandbox, addressed to W System's own sandbox company; the
partner document id is returned). Use it to build and test an integration before live sending exists.
Parametersinvoicerequiredtransport
Counterparty due-diligence report in one call: VIES VAT, official business register, EU/UN/OFAC/UK sanctions,
EC EORI, GLEIF LEI and Peppol e-invoice route, with deterministic risk flags, 0-100 risk score, pass/review/fail
verdict, sources and UTC timestamp. company: VAT ID (best), registry number or name; country: ISO code for names.
Parameterscompanyrequiredcountry
Is this e-invoicing platform on France's official list of Plateformes Agréées (PA)? name = platform or company name
(e.g. 'Pennylane'), website = its site (e.g. 'https://www.acubeapi.com/'); give at least one. Checks the DGFiP lists on
impots.gouv.fr: registered PAs (with registration date) and operators awaiting interoperability tests. Returns
on_official_list, status (approved | awaiting_interop_tests | possible_match | not_found), scored matches, list date and the
official source. Use for supplier due diligence before the French reform (receive from 1 Sep 2026, SMEs issue from
1 Sep 2027). A 'solution compatible' is not a PA itself. Unofficial copy; the official lists prevail.
Parametersnamelimitwebsite
