OpenAPI & Client Libraries

The OpenAPI Spec

https://www.tincomply.com/help-center/api/openapi.json

Download openapi.json

The spec is OpenAPI 3.0 and describes:

• Every endpoint in this reference, grouped the same way as the navigation.
• Every request field, with types, required fields, and the list of service identifiers for requestedServices.
• Named, typed response objects for each service, with real sample requests and responses.
• Error responses for 400, 401 and 404, and the X-API-Key authentication scheme.
• The result codes and the What to do with this result guidance from each endpoint page.

The spec is generated from the same source as these docs, so it always matches them. The URL is permanent: point your tools at it, rather than at a downloaded copy, and new endpoints appear when you refresh.

Import Into Your API Tool

Tools that read OpenAPI can import the spec straight from its URL, so there is nothing to download:

In each tool, choose to import from a URL and paste the spec address above. Then set your API key as the X-API-Key header.

Generate a Client Library

OpenAPI Generator builds a typed client in dozens of languages from the spec, with a method for every endpoint and a class for every request and result. It needs Node.js and Java installed.

# Download the spec, for tools that need a file rather than a URL
curl -o tin-comply-openapi.json https://www.tincomply.com/help-center/api/openapi.json

npx @openapitools/openapi-generator-cli generate \
  -i https://www.tincomply.com/help-center/api/openapi.json \
  -g python \
  -o tincomply-python \
  --additional-properties=packageName=tincomply

npx @openapitools/openapi-generator-cli generate \
  -i https://www.tincomply.com/help-center/api/openapi.json \
  -g csharp \
  -o TinComply.Client \
  --additional-properties=packageName=TinComply.Client

npx @openapitools/openapi-generator-cli generate \
  -i https://www.tincomply.com/help-center/api/openapi.json \
  -g typescript-fetch \
  -o tincomply-ts \
  --additional-properties=npmName=tincomply

npx @openapitools/openapi-generator-cli generate \
  -i https://www.tincomply.com/help-center/api/openapi.json \
  -g java \
  -o tincomply-java \
  --additional-properties=library=native,invokerPackage=com.tincomply.client

npx @openapitools/openapi-generator-cli generate \
  -i https://www.tincomply.com/help-center/api/openapi.json \
  -g go \
  -o tincomply-go \
  --additional-properties=packageName=tincomply

npx @openapitools/openapi-generator-cli generate \
  -i https://www.tincomply.com/help-center/api/openapi.json \
  -g powershell \
  -o TinComply \
  --additional-properties=packageName=TinComply

Using the generated Python client:

# pip install ./tincomply-python
import tincomply

config = tincomply.Configuration(api_key={"apiKey": "YOUR_API_KEY"})

with tincomply.ApiClient(config) as client:
    api = tincomply.TaxIDBusinessApi(client)
    response = api.irs_tin_name_matching(
        tincomply.IrsTinNameMatchingRequest(tin="123-12-1234", name="JOHN SMITH")
    )
    result = response.irs_tin_name_matching_result
    print(result.result, result.message)

Other generators work too, such as Microsoft Kiota and NSwag for .NET, openapi-typescript, and oapi-codegen for Go. Regenerate the client when you want endpoints added after you first generated it.

API Gateways and Integration Platforms

API gateways such as Azure API Management, AWS API Gateway and Kong import OpenAPI 3 directly, as do integration platforms that build connectors from an OpenAPI file. Configure authentication as an API key sent in the X-API-Key header.

Connecting an AI assistant instead? Use TIN Comply's MCP server, which signs in with OAuth rather than an API key. See AI Connections.