Check Service Status

Learn how to check the status of the TINCheck service using the SOAP API.

To check the status of the TINCheck service and determine the number of checks you have left, you will need to provide your authentication credentials along with any data (input parameters) required by the method to return a result.

The following is an example request using the ServiceStatus method.

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:pvs="http://www.TinCheck.com/WebServices/PVSService/">
  <soap:Header/>
  <soap:Body>
    <pvs:ServiceStatus>
      <pvs:CurUser>
        <pvs:UserID></pvs:UserID>
        <pvs:UserLogin>youremail@example.com</pvs:UserLogin>
        <pvs:UserPassword>YourPassword</pvs:UserPassword>
        <pvs:UserEncryption></pvs:UserEncryption>
      </pvs:CurUser>
    </pvs:ServiceStatus>
  </soap:Body>
</soap:Envelope>

Note:

Each xml node in the body content uses the pvs namespace.

Input

The following input parameters are required for this API method:

Input parameters: CurUser

UserLogin: Your TINCheck login (email address).
UserPassword: Your TINCheck password.
UserEncryption: Leave empty.
UserID: Leave empty.

Output

Read about service status results for more information on each code that might be provided.

Output: ServiceStatusResponse

Status: TINCheck system status.
CallsRemaining: The number of calls remaining for the authenticated user.

Service status results

Learn about what your service status results mean.

When results are returned, you will see a numeric code alongside a description of the code. Here's a list of each code and description combination you may see when running this type of check:

Note:

⚠️ is considered a "bad" result. ✔️ is a "good" result.

Table 1. Status results
STATUS	Details
OK	System is functioning normally	✔️

Table 2. Checks results
CallsRemaining	Details
No limit	Monthly plan
Number	Checks remaining

Sovos Docs

Check Service Status

Input

Output

Service status results

sovos-footer