{"openapi":"3.1.0","info":{"title":"Vatstack (BYOK) API","version":"0.1.0","description":"Vatstack (BYOK) lets an AI assistant read your own Vatstack data through the Vatstack API with a key you supply (Vatstack secret key (sk_live_...); a public key only works for the rate tools). Read-only: 7 tools (list_vat_rates, get_vat_rate_by_ip, get_usage, list_vat_validations, get_vat_validation, list_vat_quotes, get_vat_quote). The BYOK key travels with each request, is used for that one...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-vatstack.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-vatstack/docs"},"termsOfService":"https://connectorbay.com/byok-vatstack/terms"},"servers":[{"url":"https://byok-vatstack.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-vatstack/docs"},"security":[{"upstreamKey":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","description":"Optional. A Pro API key raises rate limits; no credentials are required."},"upstreamKey":{"type":"apiKey","in":"header","name":"X-Upstream-Key","description":"Your own key for the service this connector wraps (bring your own key). Used for that one call only; never stored, logged or cached."}},"schemas":{"Error":{"type":"object","properties":{"ok":{"const":false},"error":{"type":"object"}}}}},"paths":{"/v1/tools/list_vat_rates":{"post":{"operationId":"list_vat_rates","summary":"List VAT rates by country: standard and reduced rates, digital-product category rates, currency and EU membership. Witho","description":"List VAT rates by country: standard and reduced rates, digital-product category rates, currency and EU membership. Without a subscription only EU member states are returned. Use for \"What are the standard VAT rates of all EU member states\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"country_code":{"anyOf":[{"maxLength":2,"type":"string"},{"type":"null"}],"default":null,"description":"Only this country, as a 2-letter ISO code such as DE.","title":"Country Code"},"state_code":{"anyOf":[{"maxLength":2,"type":"string"},{"type":"null"}],"default":null,"description":"2-letter US state code; needed together with country_code US.","title":"State Code"},"member_state":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"description":"True to list only EU member states (always applied without a subscription).","title":"Member State"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"How many objects to return (1 to 100).","title":"Limit"},"page":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"}},"title":"list_vat_ratesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_vat_rate_by_ip":{"post":{"operationId":"get_vat_rate_by_ip","summary":"Get the VAT rate that applies at the location of an IP address; with no address Vatstack uses the address of the caller.","description":"Get the VAT rate that applies at the location of an IP address; with no address Vatstack uses the address of the caller. Use for \"Which VAT rate applies to a customer at IP address 91.64.12.5\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"ip_address":{"anyOf":[{"maxLength":45,"type":"string"},{"type":"null"}],"default":null,"description":"IPv4 or IPv6 address to locate; leave empty to use the caller's own address.","title":"Ip Address"}},"title":"get_vat_rate_by_ipArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_usage":{"post":{"operationId":"get_usage","summary":"Show how many validations and supplies the account used this month and the capacity of its plan. Use for \"How many VAT v","description":"Show how many validations and supplies the account used this month and the capacity of its plan. Use for \"How many VAT validations have I used this month on Vatstack\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"get_usageArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_vat_validations":{"post":{"operationId":"list_vat_validations","summary":"List the VAT number validations saved in your account (newest first) with validity, registered company name and address,","description":"List the VAT number validations saved in your account (newest first) with validity, registered company name and address, and the VIES or HMRC consultation number. Needs a secret key. Use for \"Which VAT numbers did I validate since the start of this month\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"type":{"anyOf":[{"enum":["au_gst","ch_vat","eu_eori","eu_oss_vat","eu_vat","gb_eori","gb_vat","no_vat","sg_gst"],"type":"string"},{"type":"null"}],"default":null,"description":"Only this identifier type.","title":"Type"},"query":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"Search the VAT ID that was queried, for example IE6388047V.","title":"Query"},"external_id":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only validations stored with this external customer id.","title":"External Id"},"requested_since":{"anyOf":[{"maxLength":10,"type":"string"},{"type":"null"}],"default":null,"description":"Only validations requested on or after this date (YYYY-MM-DD).","title":"Requested Since"},"requested_until":{"anyOf":[{"maxLength":10,"type":"string"},{"type":"null"}],"default":null,"description":"Only validations requested on or before this date (YYYY-MM-DD).","title":"Requested Until"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"How many objects to return (1 to 100).","title":"Limit"},"page":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"}},"title":"list_vat_validationsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_vat_validation":{"post":{"operationId":"get_vat_validation","summary":"Get one saved VAT number validation by its id, with the validity result and consultation number. Needs a secret key. Use","description":"Get one saved VAT number validation by its id, with the validity result and consultation number. Needs a secret key. Use for \"Show Vatstack validation 5d1ded3128ca7a842aaf5ed4\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"validation_id":{"description":"Id of the validation object, as returned by list_vat_validations.","maxLength":200,"title":"Validation Id","type":"string"}},"required":["validation_id"],"title":"get_vat_validationArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_vat_quotes":{"post":{"operationId":"list_vat_quotes","summary":"List the VAT price quotes generated in your account, newest first, with country, amount, VAT treatment and the validatio","description":"List the VAT price quotes generated in your account, newest first, with country, amount, VAT treatment and the validation used. Quotes are kept for three days. Needs a secret key. Use for \"Which VAT quotes did my shop generate recently\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"How many objects to return (1 to 100).","title":"Limit"},"page":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"}},"title":"list_vat_quotesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_vat_quote":{"post":{"operationId":"get_vat_quote","summary":"Get one VAT quote by id: amount in cents, total, country and the VAT rate type that was applied. Needs a secret key. Use","description":"Get one VAT quote by id: amount in cents, total, country and the VAT rate type that was applied. Needs a secret key. Use for \"What VAT treatment did quote 5dc490ea73c1ce2f69628900 apply\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"quote_id":{"description":"Id of the quote object.","maxLength":200,"title":"Quote Id","type":"string"}},"required":["quote_id"],"title":"get_vat_quoteArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}}}}