About the TINCheck REST API
The TINCheck REST API allows you to bring the TINCheck validation service directly to your backend systems. This approach means validation results can be retrieved programmatically, and integrated directly into any system.
Enabling the TINCheck REST API
If you have an active pre-paid or monthly plan, you have access to the TINCheck API, no additional signup or activation process is needed. Each check performed through the API will count against your monthly or pre-paid number of checks.
Accessing the TINCheck REST API
The TINCheck web service is located at the following URL path: https://api-us.sovos.com
An active TINCheck login (email address as username)
An active TINCheck subscription
An API access key
Note:Every API user must have a unique API key from TINCheck. To request a key, contact support with your company name, the email of the user in TINCheck, and their email. The API key will be generated and sent with Secure Mail.
Authenticating each request
Request authentication is OAuth2 based, requiring each request to pass an authenticated bearer token. To retrieve the authentication token, pass the API access key and secret to the OAuth endpoint: /oauth/client_credential/accesstoken?grant_type=client_credentials
OAuth tokens are valid for ten minutes.
The
UserIDandUserEncryptionparameters are not used and should be left empty.
Available web service methods
- ValidateTinName
- Runs basic TIN/Name validation.
- ServiceStatus
- Returns system status and the number of checks remaining for the authenticated API user.
- ValidateListMatch
- Runs list validations (including OFAC and casino barred lists).
- ValidateTinNameAddressListMatch
- Runs all TINCheck validations at once including IRS TIN/Name, USPS address, DMF, OFAC, and casino barred lists.
How to test the TINCheck REST API
We suggest using PostmanA or a similar service.