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
  • Overview
  • Response
  • Usage Notes

LookupId-List API Endpoint

Overview

The LookupId-List endpoint provides a comprehensive list of all available and current customer subscription endpoints, including their exact names and associated lookup ID numbers. These lookup IDs are crucial as they are required to trigger each specific endpoint within the API. This endpoint is essential for developers to understand and utilize the correct lookup IDs to access the various services provided by the API.

Endpoint

URL

GET https://irbis.espysys.com/api/request-monitor/lookupid-list?key={API_KEY}

Method

GET

Headers

  • accept: application/json

  • Content-Type: application/json

Example Request

Here’s an example of how to request the list of lookup IDs using curl. Note that the API key is sanitized for security:

curl -X 'GET' \
  'https://irbis.espysys.com/api/request-monitor/lookupid-list?key=YOUR_API_KEY' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json'

Replace YOUR_API_KEY with your actual API key.

Response

Response Body

The response is a JSON array where each object contains:

  • lookupId: The unique identifier required to trigger a specific endpoint.

  • endPoint: The exact API endpoint that can be triggered using the lookupId.

  • lookupName: A descriptive name of the endpoint for easier identification.

Example Response

[
  {
    "lookupId": 146,
    "endPoint": "/api/developer/web_collection",
    "lookupName": "WEB Collection (Combo)"
  },
  {
    "lookupId": 176,
    "endPoint": "/api/developer/ipgeo_number",
    "lookupName": "geolocation_number"
  },
  {
    "lookupId": 152,
    "endPoint": "/api/developer/combined_id",
    "lookupName": "Instagram ID (Combo)"
  },
  {
    "lookupId": 159,
    "endPoint": "/api/developer/combined_name",
    "lookupName": "Telescope (Combo)"
  },
  {
    "lookupId": 193,
    "endPoint": "/api/developer/real_phone",
    "lookupName": "Real Phone"
  },
  {
    "lookupId": 120,
    "endPoint": "/api/developer/combined_phone",
    "lookupName": "Phone Lookup (Combo)"
  },
  {
    "lookupId": 156,
    "endPoint": "/api/developer/face_search",
    "lookupName": "Facial Recognition Sniper (Combo)"
  },
  {
    "lookupId": 119,
    "endPoint": "/api/developer/deepweb",
    "lookupName": "Compromised S/n Lookup (Combo)"
  },
  {
    "lookupId": 124,
    "endPoint": "/api/developer/combined_email",
    "lookupName": "Guess Info - E-mail (Combo)"
  },
  {
    "lookupId": 121,
    "endPoint": "/api/developer/combined_email",
    "lookupName": "E-mail Lookup (Combo)"
  },
  {
    "lookupId": 122,
    "endPoint": "/api/developer/combined_name",
    "lookupName": "Name Lookup (Combo)"
  },
  {
    "lookupId": 139,
    "endPoint": "/api/developer/kyc",
    "lookupName": "KYC Validation and Enrichment (Combo)"
  },
  {
    "lookupId": 189,
    "endPoint": "/api/developer/lookup_phone_verification",
    "lookupName": "validate phone lookup"
  },
  {
    "lookupId": 143,
    "endPoint": "/api/developer/ip_geo",
    "lookupName": "IP Address Geolocation (Combo)"
  },
  {
    "lookupId": 192,
    "endPoint": "/api/developer/lookup_phone_name_verification",
    "lookupName": "Phone Vs Name Validator"
  },
  {
    "lookupId": 126,
    "endPoint": "/api/developer/sentiment_analysys",
    "lookupName": "AI Sentiment Analysis (Combo)"
  },
  {
    "lookupId": 125,
    "endPoint": "/api/developer/combined_phone",
    "lookupName": "Guess Info - Phone (Combo)"
  },
  {
    "lookupId": 177,
    "endPoint": "/api/developer/ipgeo_number",
    "lookupName": "email_domain_validator"
  },
  {
    "lookupId": 196,
    "endPoint": "/api/developer/phone_list",
    "lookupName": "Search List of Phone Numbers (Combo)"
  },
  {
    "lookupId": 180,
    "endPoint": "/api/developer/psycho_profile",
    "lookupName": "Psychological Portrait"
  }
]

Usage Notes

  • Lookup ID: To trigger any specific endpoint, the corresponding lookupId must be included in your request.

  • Endpoint Names: The lookupName provides a human-readable identifier for each endpoint, making it easier to identify the services available to your account.

This endpoint is particularly useful for developers needing to dynamically interact with various services offered by the API without hardcoding endpoint details.

PreviousRequests EndpointsNextRetrieve the API Results for all requests.

Last updated 9 months ago