メインコンテンツへスキップ
GET
/
v1
/
validate
VAT検証エンドポイント
curl --request GET \
  --url https://vat.cleariflow.com/v1/validate/
{
    "company": {
        "address": "8 RUE DE LONDRES\n75009 PARIS",
        "name": "EURL GOOGLE FRANCE"
    },
    "country": {
        "code": "FR",
        "name": "France"
    },
    "valid": true,
    "vat_number": "FR64443061841"
}

​
はじめに

​
ベースURL

https://vat.cleariflow.com/v1/validate/

​
検証エンドポイント

validateエンドポイントには、固有のAPIキーと確認したいVAT番号が必要です。 
https://vat.cleariflow.com/v1/validate/
? api_key = YOUR_UNIQUE_API_KEY
& vat_number = FR64443061841
この成功したリクエストは、検証されたVAT番号に関連する包括的な企業情報を返します。 
{
    "company": {
        "address": "8 RUE DE LONDRES\n75009 PARIS",
        "name": "EURL GOOGLE FRANCE"
    },
    "country": {
        "code": "FR",
        "name": "France"
    },
    "valid": true,
    "vat_number": "FR64443061841"
}

​
リクエストパラメータ

​
api_key
String
必須
固有のAPIキーです。各ユーザーはCleariflowの各APIごとに固有のAPIキーを持っているため、VAT検証・税率APIのキーはIPジオロケーションAPIなどでは動作しません。
​
vat_number
String
必須
検証するVAT番号です。

​
レスポンスパラメータ

APIレスポンスは、汎用的で軽量な JSON形式 で返されます。
​
vat_number
String
検証するVAT番号です。
​
valid
Boolean
送信されたVAT番号が有効な場合に true です。
​
company
Object
企業情報を含むオブジェクトです。
​
company.name
String
VAT番号に関連する企業の名前です。
​
company.address
String
VAT番号に関連する企業の住所です。
​
country
Object
国情報を含むオブジェクトです。
​
country.code
String
VAT番号に関連する国の2文字ISO 3166-1 alpha-2コードです。
​
country.name
String
VAT番号に関連する国の名前です。