API Reference

Validate a VAT number and optionally verify it against the EU VIES registry.

Request body

Example — format check (no auth needed)

curl https://www.versys.io/api/check \
  -H "Content-Type: application/json" \
  -d '{"vat": "DE129273398"}'

Example — VIES live lookup

curl https://www.versys.io/api/check \
  -H "Authorization: Bearer vsk_..." \
  -H "Content-Type: application/json" \
  -d '{"vat": "FR40303265045", "vies": true}'

Response fields

Validate up to 100 VAT numbers in a single request.

Request body

Example

curl https://www.versys.io/api/batch \
  -H "Authorization: Bearer vsk_..." \
  -H "Content-Type: application/json" \
  -d '{
    "vats": ["DE129273398", "FR40303265045", "GB980780684"],
    "vies": true
  }'

Response

Returns {"count": N, "results": [...], "credit_balance": N}. Each item in results has the same fields as the single check response, in the same order as the input array.

Check a client's VAT number, compare the submitted name with registry data, and return reverse-charge guidance for your invoice workflow.

If you are authenticated and have saved your business country and VAT number in your profile, the API will use those values automatically when supplier_country or supplier_vat are omitted.

Request body

Example

curl https://www.versys.io/api/compliance/check \
  -H "Authorization: Bearer vsk_..." \
  -H "Content-Type: application/json" \
  -d '{
    "client_name": "Acme GmbH",
    "client_vat": "DE129273398",
    "with_vies": true
  }'

Response fields

Validate an IBAN using the ISO 13616 checksum and look up bank details where available.

Request body

Example

curl https://www.versys.io/api/iban/check \
  -H "Content-Type: application/json" \
  -d '{"iban": "DE89370400440532013000"}'

Response fields

Validate up to 100 IBANs in a single request.

Request body

Example

curl https://www.versys.io/api/iban/batch \
  -H "Content-Type: application/json" \
  -d '{
    "ibans": ["DE89370400440532013000", "GB82WEST12345698765432"]
  }'

Returns {"count": N, "results": [...]} where each item has the same fields as the single check.

Validate a payment card number using the Luhn algorithm and look up issuer details by BIN.

Request body

Example

curl https://www.versys.io/api/card/check \
  -H "Content-Type: application/json" \
  -d '{"card_number": "4111111111111111"}'

Response fields

Validate up to 100 card numbers in a single request.

Request body

Example

curl https://www.versys.io/api/card/batch \
  -H "Content-Type: application/json" \
  -d '{
    "cards": ["4111111111111111", "5500005555555559"]
  }'

Returns {"count": N, "results": [...]} where each item has the same fields as the single check.

Look up issuer information for a BIN (Bank Identification Number) or full card number. The first 6–8 digits are used; the rest are ignored.

Request body

* Provide either bin or card_number.

Example

curl https://www.versys.io/api/bin/lookup \
  -H "Content-Type: application/json" \
  -d '{"bin": "41111111"}'

Response fields

Validate an EORI (Economic Operators Registration and Identification) number and optionally look it up against the EU customs registry or the UK HMRC registry.

Request body

Example — format check (no auth needed)

curl https://www.versys.io/api/eori/check \
  -H "Content-Type: application/json" \
  -d '{"eori": "GB123456789012"}'

Example — live registry lookup

curl https://www.versys.io/api/eori/check \
  -H "Authorization: Bearer vsk_..." \
  -H "Content-Type: application/json" \
  -d '{"eori": "DE123456789012345", "lookup": true}'

Response fields

Validate up to 100 EORI numbers in a single request. Requires authentication. Format validation only — live registry lookup is not available in batch mode.

Request body

Example

curl https://www.versys.io/api/eori/batch \
  -H "Authorization: Bearer vsk_..." \
  -H "Content-Type: application/json" \
  -d '{
    "eori": ["GB123456789012", "DE123456789012345", "FR12345678901234"]
  }'

Returns {"count": N, "results": [...]} where each item has the same fields as the single check response (without lookup fields). Each result also includes an index field matching its position in the input array.

Validate a VAT number format, look up company data from GLEIF and national registries (free), and optionally add a live VIES EU registration check (costs credits).

Request body

Example — format check (no auth needed)

curl https://www.versys.io/api/company/lookup \
  -H "Content-Type: application/json" \
  -d '{"vat": "DE123475223"}'

Example — registry lookup (GLEIF + LEI, free)

curl https://www.versys.io/api/company/lookup \
  -H "Authorization: Bearer vsk_..." \
  -H "Content-Type: application/json" \
  -d '{"vat": "DE123475223", "lookup": true, "name": "Deutsche Telekom AG"}'

Example — registry + VIES (full check)

curl https://www.versys.io/api/company/lookup \
  -H "Authorization: Bearer vsk_..." \
  -H "Content-Type: application/json" \
  -d '{"vat": "DE123475223", "lookup": true, "vies": true}'

Response fields

name_match object

Present when a name hint was supplied and registry data was found, or when both VIES and registry names are available.

Registry source priority

When multiple sources return data, fields are merged in this priority order (highest first):

1. Country-specific APIs: HMRC (GB), Companies House (GB), Brønnøysund Register (NO), CVR (DK), SIRENE (FR)
2. GLEIF (global LEI database — strong coverage for large companies)
3. OpenCorporates (broad coverage for SMEs)

Look up up to 100 VAT numbers in a single request. Format validation is always performed. Pass "lookup": true for free GLEIF/registry enrichment, and/or "vies": true for VIES verification (credits charged per item with VIES).

Request body

Example

curl https://www.versys.io/api/company/batch \
  -H "Authorization: Bearer vsk_..." \
  -H "Content-Type: application/json" \
  -d '{
    "vats": ["DE123475223", "GB123456789", "FR12345678901"],
    "lookup": true
  }'

Returns {"count": N, "results": [...]} where each item has the same fields as the single company lookup response.

Validate a domestic bank account number using country-specific format and checksum rules. Supported countries: GB, DE, FR, ES, IT, BE, NL, NO.

Request body

Always include country plus the country-specific fields shown below.

Example — GB sort code + account

curl https://www.versys.io/api/domestic/check \
  -H "Content-Type: application/json" \
  -d '{
    "country": "GB",
    "sort_code": "20-00-00",
    "account": "55779911"
  }'

Example — DE BLZ + account

curl https://www.versys.io/api/domestic/check \
  -H "Content-Type: application/json" \
  -d '{
    "country": "DE",
    "blz": "37040044",
    "account": "532013000"
  }'

Response fields

Returns the e-Invoicing mandate status and technical requirements for a given buyer country, supply type and transaction direction. No authentication or credits required.

Request body

Example — B2B invoice, GB supplier → DE buyer

curl https://www.versys.io/api/vida/check \
  -H "Content-Type: application/json" \
  -d '{"buyer_country": "DE", "supplier_country": "GB", "supply_type": "b2b"}'

Example — B2G invoice to Italian public authority

curl https://www.versys.io/api/vida/check \
  -H "Content-Type: application/json" \
  -d '{"buyer_country": "IT", "supply_type": "b2g"}'

Response fields

Countries covered

Active or planned B2B mandates: IT, RO, HU, GR, PL, DE, BE, ES, FR. B2G mandate data: GB, NL, SE, NO, DK, FI, AT, IE, PT and all remaining EU-27 (via Directive 2014/55/EU). For countries not in the detailed table the API returns mandate_status: "none" for B2B/B2C or mandate_status: "active" for B2G if the country is an EU member state.

Generate a tamper-evident PDF report for any completed check. Every PDF contains a SHA-256 report ID and a versys.io/verify/{id} URL. Any recipient can open that URL to see the original check result — if any field in the PDF differs from what the verify page shows, the document has been altered.

Request body

Example

curl https://www.versys.io/api/pdf \
  -H "Authorization: Bearer vsk_..." \
  -H "Content-Type: application/json" \
  -d '{
    "kind": "vat",
    "scope": "single",
    "result": { "vat": "DE129273398", "valid": true, "vies_valid": true, ... }
  }' \
  --output report.pdf

Returns a application/pdf binary. The filename is set via Content-Disposition.

Verify a report

Every PDF footer contains: Verify: versys.io/verify/{hash}. GET /verify/{hash} returns an HTML page showing the stored result fields. No authentication required to verify.