Returns a verification result

POST

/api/v1/vat-verification/basic-check/{country}

v1-vat-verification

Basic verification of given VAT number against VIES. Optional parameters may help to build a better confidence score.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api.kompany.com//api/v1/vat-verification/basic-check/' \
--data-urlencode 'vatNumber='

Response Example

200 - Example 1

{
    "candidate": [
        {}
    ],
    "company": {},
    "confidenceScore": 0,
    "validationStatus": true
}

Request

Path Params

country

string

required

ISO_3166-1_alpha-2 representation of a country name - 2 chars

Body Params application/x-www-form-urlencoded

companyAddress

string

optional

company address lines

companyName

string

optional

Company name

companyNumber

string

optional

official company number

vatNumber

string

required

VAT number to validate

Responses

🟢200Denotes validity of checked VAT

application/json

Body

candidate

array [object]

optional

company

object

optional

confidenceScore

number

required

validationStatus

boolean

required

🔴500500

EIN Name Lookup with TIN number

Returns a verification result and company data