IRBIS API Reference
  • IRBIS API Reference
  • Disclaimer for IRBIS Search Portal and Services
  • Introduction
  • Authenticate
  • Requests Endpoints
  • LookupId-List API Endpoint
  • Retrieve the API Results for all requests.
    • GET Multiple Results
    • Search Response Schema
  • Delete Record API
    • Headers and Body Request for Delete Record
  • Retrieve Credits Status API
    • Search Response Schema
  • BreachScan
    • Headers and Body Request by deepweb values
    • GET Get lookup data for a request by deepweb values
    • Search Response Schema
  • Phone Lookup
    • Headers and Body Request by Phone
    • GET Get lookup data for a request by Phone
    • Search Response Schema
  • Phone Verification (Real Phone)
    • Headers and Body Request by Phone
    • GET Get lookup data for a request by Phone
    • Search Response Schema
  • Phone Validation Request (Optional)
    • Headers and Body
    • Request Response Data
    • Search Response Schema
  • Phone Vs Name Validator
    • Headers and Body
    • Request Response Data
    • Search Response Schema
  • E-mail Lookup
    • Headers and Body Request by E-mail Lookup
    • GET Get lookup data for a request by E-mail Lookup
    • Search Response Schema
  • Name SocialScan
    • Headers and Body Request by Name Lookup
    • GET Get lookup data for a request by Name Lookup
    • Search Response Schema
  • Name WebScan
    • Headers and Body Request by Telescope
    • GET Get lookup data for a request by Name Lookup
    • Search Response Schema
  • Leads Search
    • Headers and Body Request by Topick
    • GET Get lookup data for a request by Post
    • Search Response Schema
  • Face WebScan
    • Headers and Body Request by Face WebScan
    • GET Get lookup data for a request by Face WebScan
    • Search Response Schema
  • AI Sentiment Analysis
    • Headers and Body Request by Text body
    • GET Get lookup data for a request by Text body
    • Search Response Schema
  • KYC Validator
    • Headers and Body Request by KYC Validator
    • Request KYC Validator results
    • Search Response Schema
  • WEB Scraper
    • Headers and Body Request
    • Request Response Data
    • Search Response Schema
  • IP Geolocation
    • Headers and Body
    • Request Response Data
    • Search Response Schema
  • Phone Vs IP Validator
    • Headers and Body
    • Request Response Data
    • Search Response Schema
  • Psychological Portrait
    • Headers and Body
    • Request Response Data
    • Search Response Schema
  • Psycho Profile and Summary by Text & Name (Optional)
    • Headers and Body
    • Request Response Data
    • Search Response Schema
  • Compliance Screening
    • SSN Trace (US only)
    • National Criminal Screening (US only)
    • Watchlists and Politically Exposed Persons (International)
    • Court Records (US only)
Powered by GitBook
On this page
  1. Retrieve Credits Status API

Search Response Schema

Search Response Schema for Sentiment Analysis

{
  "type": "object",
  "properties": {
    "balance": {
      "type": "number",
      "description": "Remaining balance in decimal format."
    },
    "currency": {
      "type": "string",
      "description": "Currency symbol for the balance (e.g., €, $, etc.)."
    },
    "credits": {
      "type": "integer",
      "description": "Available credit count in integer format."
    },
    "expiratioDate": {
      "type": "string",
      "format": "date-time",
      "description": "Expiration date of the credits in ISO 8601 format."
    },
    "status": {
      "type": "string",
      "description": "Current account status, e.g., 'Active' or 'Inactive'."
    }
  },
  "required": ["balance", "currency", "credits", "expiratioDate", "status"],
  "additionalProperties": false
}
PreviousRetrieve Credits Status APINextBreachScan

Last updated 7 months ago