API Parameters

Comprehensive reference guide for all supported parameters and fields across VeriRoute Intel APIs.

Request Structure

Understanding how to structure your API requests with proper parameters and formatting.

Common Request Parameters

Parameter Type Required Description
phone_number string Yes 10-digit U.S. phone number (e.g., "5551234567")
format string No Response format: "json" (default) or "xml"
include_metadata boolean No Include additional metadata in response (default: false)

Query Parameters

Parameters passed in the URL query string for GET requests:

  • Filtering: Use parameters like start_date, end_date, and status to filter results
  • Pagination: Control result sets with limit and offset parameters
  • Sorting: Order results using sort_by and sort_order parameters

Request Body Parameters

For POST requests, parameters are sent in the request body as JSON:

{
  "phone_number": "5551234567",
  "include_metadata": true,
  "options": {
    "detailed_response": true,
    "include_history": false
  }
}

Response Fields

Understanding the structure and content of API response data.

Standard Response Structure

All API responses follow a consistent structure:

{
  "success": true,
  "data": {
    // API-specific response data
  },
  "metadata": {
    "request_id": "req_123456789",
    "timestamp": "2024-01-15T10:30:00Z",
    "processing_time_ms": 150
  },
  "pagination": {
    "total": 100,
    "limit": 20,
    "offset": 0,
    "has_more": true
  }
}

Common Response Fields

Field Type Description
success boolean Indicates if the request was successful
data object Contains the main response data
metadata object Request metadata and processing information
error object Error details (only present when success is false)

Parameter Types

Understanding different parameter types and their validation rules.

Data Types

String

Text values with specific format requirements:

  • Phone Numbers: 10-digit format (e.g., "5551234567")
  • Dates: ISO 8601 format (e.g., "2024-01-15T10:30:00Z")
  • Enums: Predefined values (e.g., "active", "inactive")

Boolean

True/false values for feature flags and options:

  • Accepted values: true, false
  • Case-sensitive in JSON requests
  • Used for optional features and metadata inclusion

Integer

Numeric values for counts, limits, and IDs:

  • Pagination: limit (1-1000), offset (≥0)
  • Timeouts: Values in seconds or milliseconds
  • Identifiers: Positive integers for resource IDs

Array

Lists of values for batch operations:

  • Phone Numbers: Array of strings for bulk lookups
  • Filters: Multiple filter criteria
  • Options: Multiple configuration values

Validation Rules

All parameters are validated according to these rules:

  • Required Fields: Must be present and non-empty
  • Format Validation: Phone numbers, dates, and enums must match expected formats
  • Range Limits: Numeric values must fall within specified ranges
  • Length Limits: String values have maximum length restrictions
  • Character Sets: Only allowed characters are accepted

Best Practices

🔍 Parameter Validation

Always validate parameters client-side before sending requests to reduce API errors and improve user experience.

📊 Efficient Pagination

Use appropriate limit values (20-100) for pagination to balance performance and data transfer.

🎯 Selective Fields

Request only the data you need using field selection parameters to improve response times.

🔄 Consistent Formatting

Maintain consistent parameter formatting across all requests to ensure reliable API behavior.