API Reference

Using the Verosint APIs

Verosint offers API access for each signal orchestration tool.

SignalPrint - Use the SignalPrint API to evaluate a set of login or registration events against Open Source Intelligence (OSINT) data to determine risks to your systems and applications.

Rules Evaluation - Use the Rules Evaluation API to evaluate Rules that enable you to implement business decisions by defining the parameters by which customers can access your systems and data.

Get your API Key 🔑

An API key is required to interact with the Verosint API. To get your API key:

  1. Log in to the Verosint app
  2. Go to Account
  3. Click on API Keys

Configure the Client 💻

The Verosint API is using the standard Bearer token authentication. Your client must send the Authorization header with the API key provided as the token.

The following example shows a POST request sent to the SignalPrint API. You will need to replace the YOUR-API-KEY text with the actual API key.

POST https://api.verosint.com/v1/signalprint/events
Accept: application/json
Authorization: Bearer YOUR-API-KEY
Content-Type: application/json

[
  {
    "timestamp": "2023-02-28T15:04:26.531-06:00",
    "email": "[email protected]",
    "ip": "172.66.43.39",
    "userAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:110.0) Gecko/20100101 Firefox/110.0",
    "type": "LOGIN_SUCCESS"
  }
]

Read the Docs and Check the Examples :owlbert-books:

Verosint provides endpoints for interacting with SignalPrint, Rules and Risk Score. The API reference allows testing the API directly from this site. Check also the examples to see how queries can be formatted and the responses you can expect from the API.

OpenAPI Specification Download 📖

The OpenAPI 3.0-compatible specification file can be downloaded to facilitate integration with Verosint's APIs.

Public Postman Workspace

The workspace covers typical use cases for interacting with Verosint's APIs. As a Postman user, you can fork collections and see them in action in your own workspace. Each collection is documented in detail with examples.

📘

All API Endpoints Are Rate-Limited

For more information, check the API reference to see how the limits are reported back to the client in the HTTP response headers. When the client is above the rate limit, the standard 429 Too Many Requests HTTP Status code is returned.