{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"cec7ea8f-f0fe-4591-a55b-ae72bd6125ad","name":"VAT API","description":"Welcome to the VAT API docs. These docs are hosted by the Postman service, you can select various languages to see the example requests and reponses in your preferred programming language. Where multiple responses can be generated by a particular resource you can select on the right hand side to see the different type of responses a resource might produce.\n\n**Note:- These docs are for the current Version 2 of the VAT API service, if you require the Version 1 docs they can [viewed here](https://vatapi.com/docs/)**\n\nIf you are new to VAT API grab an API Key by creating a **30 day free trial** account at [vatapi.com](https://vatapi.com)\n\n# Endpoints\n\n<img src=\"https://vatapi.com/assets/images/docs-aws-api-gateway-icon.png\" width=\"80\" height=\"80\" alt=\"Amazon API Gateway Logo\"> VAT API is proxied and protected by the [Amazon API Gateway](https://aws.amazon.com/api-gateway/) service.\n\n\nWe run the following endpoints:-\n\n|Region|Endpoint|Description|\n|---|---|---|\n|EU|https://eu.vatapi.com/v2|Businesses trading within the EU region will benefit from connecting to the EU region endpoint which is located in Amazon's London data centre.|\n|Global|https://global.vatapi.com/v2|International businesses selling products or services into the EU region will benefit from connecting to the Global region endpoint which utilises Amazon's global Cloudfront network of edge servers.|\n\n**Enterprise Customers**\n\nFor Enterprise accounts with their own endpoint, please [contact support](https://vatapi.com/support) for more information.\n***\n\n# Authentication\nAuthenticate each api request by passing a valid `x-api-key` header value.\n\nYour API Key can be found in the account dashboard:- https://vatapi.com/login make sure to store your API Key somewhere secure and never share publicly.\n\n# Postman\nIf you're an existing [Postman](https://www.getpostman.com/) user you can quickly test VAT API functionality by clicking the 'Run in Postman' button in the top right corner of this page, this will prompt you to import VAT API as a Postman Collection...\n\nThe VAT API collection expects two Postman variables to be set:\n\n|Variable|Description|\n|---|---|\n|**region**|Determines which API endpoint to connect to. Set to 'eu' or 'global'|\n|**x-api-key**|Sets the required API Key header value. Set this to the 'x-api-key' value found in your account dashboard.|\n\nInformation on setting up and using Postman variables can be [found here](https://www.getpostman.com/docs/v6/postman/environments_and_globals/variables)\n\nIf you haven't used Postman before we highly recommend you install the software as it will save you time testing API functionality before embarking on writing any integration code.\n\n# Rate limit\nTo prevent VAT API from being overwhelmed requests are rate limited. Sending to many requests may trigger responses with the HTTP status code 429. The limits are dynamic and we reserve the right to adjust them at any time to accomodate customer demand.\n\n# API Conventions\n* All responses are in JSON format.\n* JSON numbers are bounded to a signed 32-bit integer.\n* Query parameters and JSON fields use lower case, with underscores separating words.\n* The status of the HTTP response indicates whether the request has succeeded or failed. For convenience the status code is contained in each JSON response.\n* If a request is successful the JSON message field defaults to the string 'success' otherwise the message will be descriptive of what may have have caused the error.\n \n# Example Response\n\n**400 Bad Request**\n\n\n\t{\n\t\t\"code\": 400,\n\t\t\"message\": \"Please send a valid JSON payload in the body of the request.\"\n\t}\n\n# Response Codes\n|Code|Name|Description|Suggested Action|\n|---|---|---|---|\n|200|OK|The request has succeeded.|n/a|\n|201|Created|The request has been fulfilled and has resulted in one or more new resources being created.|n/a|\n|400|Bad Request|The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing).|Make sure that your request includes all of the required fields and your data is valid.|\n|403|Forbidden|You don't have the needed authorization to make the request.|Make sure you are using a valid API Key and have the necessary `x-api-key` header value set for the request.|\n|404|Not Found|The origin server did not find a current representation for the target resource or is not willing to disclose that one exists.|Check you are requesting a resource that actually exists.|\n|429|Too Many Requests|The user has sent too many requests in a given amount of time.|Reduce the number of requests/minute made to the API and check you are not exceedig the number of requests your subscription plan allows, also check you're not making multiple requests for the same resource/dataset for example you may have inadvertently created a never ending loop.|\n|500|Internal Server Error|The server encountered an unexpected condition that prevented it from fulfilling the request.|The issue maybe temporary, if it persists contact support.|","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":true,"owner":"4196441","team":273674,"collectionId":"cec7ea8f-f0fe-4591-a55b-ae72bd6125ad","publishedId":"RztsnRaL","public":true,"publicUrl":"https://docs.vatapi.com","privateUrl":"https://go.postman.co/documentation/4196441-cec7ea8f-f0fe-4591-a55b-ae72bd6125ad","customColor":{"top-bar":"FBFBFB","right-sidebar":"303030","highlight":"001E81"},"documentationLayout":"classic-double-column","customisation":null,"version":"8.10.1","publishDate":"2021-04-08T11:13:56.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/5dc3e0fbc29f3ab33e48d854d62b69585892355511083b0f84063b9c1dc27e3c","favicon":"https://res.cloudinary.com/postman/image/upload/v1550139908/team/qd1x1xxqtlufhipu1vpm.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://docs.vatapi.com/view/metadata/RztsnRaL"}