Documentation
Getting Started
Free AnalysisPricing
FAQ
Threat Level Guide
Result Codes
List Profile Report
Threat Intelligence Center
Best Practices
Data Export Specs
Country Disposition
API
API OverviewVerification/Threats API
Threats API
Credits Balance API ►
Bulk FTP Transfer
Bulk API List Submission
Service Credits Balance API Overview
The Service Credits Balance API provides a seamless way to check the current balance of your account’s service credits. This API allows users to retrieve their available service credits through a simple, automated process, making it easier to manage and track usage. In this overview, we will guide you through how to access and use the API, including instructions on authentication, endpoint details, and the parameters required to successfully check your service credits balance. By following these steps, you'll be able to integrate the API into your system for real-time updates on your account's service credits.
Structure and Definition for Inbound Submissions
Our API requires you to authenticate each individual request. Below is an example of a basic URL structure request, just substitute with the provided account, associated password along with any optional parameters.
Structure: https://post.impressionwise.com/creditscheck.aspx?CODE=BBF&PSW=password
Required Data Fields
Parameters need to be separated by "&"
&CODE= 3 Digit Alpha-numeric, acccount code provided by Impressionwise = BBF. This code can be found in the Client Portal within the API Access section.
&PSW= Alpha-numeric, account password provided by Impressionwise = password. Same as Portal login password. If you are receiving WRONG_CREDENTIALS and if your password contains this character "&", then use "%26" as a replacement and re-attempt or contact us to assist.
Parameters and Usage
To retrieve the current service credits balance, simply use the request shown in the sample below substituting the required parameters with provided credentials and email address you want to verify.
Sample = https://post.impressionwise.com/creditscheck.aspx?code=BBF&psw=password
Upon successful posting, you can expect to receive the following response.
Response = CODE=BBF&CREDITS=136,012&TTP=0.41
Possible result parameter/values include:
&CODE= "3 Alpha-numeric, account code assigned by Impressionwise = BBF”. This code can be found in the Client Portal within the API Access section.
&CREDITS= "Numeric value representing the accounts, current service credits balance"
&TTP= "Time it took to process value represented in seconds"
Error Handling
From time to time you may experience an API error. It is important to watch out for these and handle them appropriately. Specifically, if your submission contains an invalid account code or password the result response would be WRONG_CREDENTIALS.
If you receive any other response other than those previously shown, please contact support.
Questions? Please feel free to contact us with any questions or specific customization requirements you may have regarding our automated, data cleansing feed services to ensure a successful evaluation or use of our services and let the results speak for themselves!
