{"openapi":"3.1.0","info":{"title":"OpenCorporates (BYOK) API","version":"0.1.0","description":"OpenCorporates (BYOK) lets an AI assistant read your own OpenCorporates data through the OpenCorporates API with a key you supply (OpenCorporates API token). Read-only: 6 tools (search_companies, search_companies_by_address, search_nonprofit_companies, search_companies_by_industry_code, get_company, get_account_status). The BYOK key travels with each request, is used for that one call only and is...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-opencorporates.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-opencorporates/docs"},"termsOfService":"https://connectorbay.com/byok-opencorporates/terms"},"servers":[{"url":"https://byok-opencorporates.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-opencorporates/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/search_companies":{"post":{"operationId":"search_companies","summary":"Search companies in the OpenCorporates database by name, optionally limited to jurisdictions or countries and to a range","description":"Search companies in the OpenCorporates database by name, optionally limited to jurisdictions or countries and to a range of incorporation dates; returns a page of company records. Use for \"Find companies named Tesla registered in the UK\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"q":{"description":"Company name text to search for.","maxLength":200,"title":"Q","type":"string"},"jurisdiction_code":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Jurisdiction codes to restrict to, lowercase with underscores, for example gb or us_ny; several values separated by a pipe like be|gb.","title":"Jurisdiction Code"},"country_code":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Country codes to restrict to, for example us or gb; several values separated by a pipe like us|ca.","title":"Country Code"},"incorporation_date":{"anyOf":[{"maxLength":30,"type":"string"},{"type":"null"}],"default":null,"description":"Incorporation date range as from:to in YYYY-MM-DD, for example 2014-01-01:2014-12-31; either side may be left empty.","title":"Incorporation Date"},"inactive":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"description":"True to return only inactive companies, false for only active ones; leave out for both.","title":"Inactive"},"per_page":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":30,"description":"How many companies per page (1 to 100; the provider's default is 30).","title":"Per Page"},"page":{"anyOf":[{"maximum":1000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number of results, starting at 1.","title":"Page"}},"required":["q"],"title":"search_companiesArguments","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/search_companies_by_address":{"post":{"operationId":"search_companies_by_address","summary":"Find companies whose registered address matches a street address, for example to see who is registered at one building. ","description":"Find companies whose registered address matches a street address, for example to see who is registered at one building. Use for \"Which companies are registered at 10 East 39th Street, New York\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"registered_address":{"description":"Address text to match against registered addresses.","maxLength":200,"title":"Registered Address","type":"string"},"country_code":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Country codes to restrict to, for example us or gb; several values separated by a pipe like us|ca.","title":"Country Code"},"per_page":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":30,"description":"How many companies per page (1 to 100; the provider's default is 30).","title":"Per Page"},"page":{"anyOf":[{"maximum":1000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number of results, starting at 1.","title":"Page"}},"required":["registered_address"],"title":"search_companies_by_addressArguments","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/search_nonprofit_companies":{"post":{"operationId":"search_nonprofit_companies","summary":"Search only companies whose type is classed as nonprofit, by name, optionally limited to countries and incorporation dat","description":"Search only companies whose type is classed as nonprofit, by name, optionally limited to countries and incorporation dates. Use for \"Find nonprofit organisations with political in the name in the UK or US\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"q":{"description":"Company name text to search for.","maxLength":200,"title":"Q","type":"string"},"country_code":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Country codes to restrict to, for example us or gb; several values separated by a pipe like us|ca.","title":"Country Code"},"incorporation_date":{"anyOf":[{"maxLength":30,"type":"string"},{"type":"null"}],"default":null,"description":"Incorporation date range as from:to in YYYY-MM-DD.","title":"Incorporation Date"},"nonprofit":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":true,"description":"Always true for this tool; restricts results to nonprofit company types.","title":"Nonprofit"},"per_page":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":30,"description":"How many companies per page (1 to 100; the provider's default is 30).","title":"Per Page"},"page":{"anyOf":[{"maximum":1000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number of results, starting at 1.","title":"Page"}},"required":["q"],"title":"search_nonprofit_companiesArguments","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/search_companies_by_industry_code":{"post":{"operationId":"search_companies_by_industry_code","summary":"Search companies by name that carry a given industry code, written as scheme-code such as eu_nace_2-692, within chosen j","description":"Search companies by name that carry a given industry code, written as scheme-code such as eu_nace_2-692, within chosen jurisdictions. Use for \"Find tax-related companies in Belgium or the UK with NACE code 692\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"industry_codes":{"description":"Industry code with its scheme, for example eu_nace_2-692.","maxLength":60,"title":"Industry Codes","type":"string"},"q":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Company name text to search for.","title":"Q"},"jurisdiction_code":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Jurisdiction codes to restrict to, lowercase with underscores, for example gb or us_ny; several values separated by a pipe like be|gb.","title":"Jurisdiction Code"},"per_page":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":30,"description":"How many companies per page (1 to 100; the provider's default is 30).","title":"Per Page"},"page":{"anyOf":[{"maximum":1000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number of results, starting at 1.","title":"Page"}},"required":["industry_codes"],"title":"search_companies_by_industry_codeArguments","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_company":{"post":{"operationId":"get_company","summary":"Get one company record by jurisdiction and registry number: status, dates, type, registered address, previous names, ide","description":"Get one company record by jurisdiction and registry number: status, dates, type, registered address, previous names, identifiers, financial summary and the register source. Use for \"Show the OpenCorporates record for UK company 07444723\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"jurisdiction_code":{"description":"Jurisdiction code, lowercase with underscores, for example gb or us_ny.","maxLength":20,"title":"Jurisdiction Code","type":"string"},"company_number":{"description":"The company number issued by the register, for example 07444723.","maxLength":60,"title":"Company Number","type":"string"}},"required":["jurisdiction_code","company_number"],"title":"get_companyArguments","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_account_status":{"post":{"operationId":"get_account_status","summary":"Show the API usage of the token's account (calls used against the plan allowance). Use for \"How many OpenCorporates API ","description":"Show the API usage of the token's account (calls used against the plan allowance). Use for \"How many OpenCorporates API calls have I used\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"get_account_statusArguments","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}}}}