Checking Service Status using the SOAP API

  • Updated

To check the status of the TINCheck service and determine the number of checks you have remaining, you’ll 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.

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/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

See "Interpreting your results" for more information on each code that may be provided.

Output: ServiceStatusResponse

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

 

Interpreting your results

When results are returned, you'll 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: ⚠️ = considered a "bad" result   ✔️ = a "good" result

STATUS Details  
OK System is functioning normally ✔️

 

CallsRemaining Details  
No limit Monthly plan  
Number Checks remaining  

Was this article helpful?

Comments

0 comments

Please sign in to leave a comment.