Platform API Documentation

INTRODUCTION

ENDPOINTS

Getting Started

Welcome to the Relativity6 Platform API documentation. This guide provides information on how to integrate with our core platform services.

Base URL

https://api.relativity6.com

Request Format

All requests should be sent with the following headers:

Content-Type: application/json
x-api-key: YOUR_API_KEY

Authorization

All Platform API requests require authentication using an API key provided by Relativity6. Include this key in the header of every request.

Authentication Method

Add your API key to the request headers:

x-api-key: YOUR_API_KEY

Health Check Endpoint

GET

/health

This endpoint provides a simple health check to verify that the API is operational. It requires authentication via the x-api-key header.

Example Request

GET https://api.relativity6.com/health
x-api-key: YOUR_API_KEY

Response

{
    "status": "healthy",
    "timestamp": "2025-03-27T03:51:52.922Z",
    "version": "1.0.0",
    "environment": "development"
}

Response Properties

Property	Type	Description
status	string	Indicates the operational status. Always "healthy" on success.
timestamp	string	ISO 8601 timestamp when the health check was performed.
version	string	The current running version of the API service.
environment	string	The deployment environment (e.g., development, staging, production).

Research Endpoint

POST

/research

⚠️ Experimental - Not Recommended for Production

This endpoint is currently unstable and will be changing soon. It is not recommended for production use at this time. Please contact support for alternative solutions.

The research endpoint performs a comprehensive search and analysis based on the provided business information (name, location, domain) and returns detailed insights.

Example Request

POST https://api.relativity6.com/research
Content-Type: application/json
x-api-key: YOUR_API_KEY

{
  "name": "Relativity6",
  "state": "MA",
  "address_line_1": "210 BROADWAY STREET",
  "city": "CAMBRIDGE",
  "zip": "02139",
  "country": "US",
  "domain": "relativity6.com"
}

Request Body

Parameters

Parameter	Type	Required	Description
name	string	Yes	The legal business name.
state	string	Yes	The 2-letter state/province code (e.g., MA, CA).
address_line_1	string	No	Primary street address.
address_line_2	string	No	Secondary address information (e.g., Suite, Apt).
city	string	No	City name.
zip	string	No	Postal or ZIP code.
country	string	No	The 2-letter country code (e.g., US, CA). Defaults to US if not provided.
domain	string	No	The company's primary website domain (e.g., relativity6.com).

Example Response

{
  "requestId": "a0bc1e5a-ac9f-437f-96d7-fa803221d9db",
  "business_risk_summary": {
    "company_name": "Relativity6",
    "state": "MA",
    "risk_summary": "Relativity6 operates in the insurtech sector, focusing on real-time risk assessment and classification for insurance underwriting. The business utilizes AI and machine learning to analyze risks, which may include operational risks associated with data accuracy and cybersecurity concerns."
  },
  "business_classification": {
    "business_description": "Relativity6 is a Cambridge, Massachusetts-based insurtech company founded in 2016. It specializes in providing real-time risk monitoring and industry classification solutions for the insurance sector using AI and machine learning technologies.",
    "codes": {
      "naics": {
        "primary": {
          "code_2_digit": {
            "code": "51",
            "title": "Information",
            "confidence": 0.95
          },
          "code_4_digit": {
            "code": "5112",
            "title": "Software Publishers",
            "confidence": 0.9
          },
          "code_6_digit": {
            "code": "511210",
            "title": "Software Publishers",
            "confidence": 0.85
          }
        },
        "secondary": {
          "code_2_digit": {
            "code": "54",
            "title": "Professional, Scientific, and Technical Services",
            "confidence": 0.85
          },
          "code_4_digit": {
            "code": "5415",
            "title": "Computer Systems Design and Related Services",
            "confidence": 0.8
          },
          "code_6_digit": {
            "code": "541511",
            "title": "Custom Computer Programming Services",
            "confidence": 0.75
          }
        }
      },
      "sic": {
        "code": "7371",
        "title": "Computer Programming Services",
        "confidence": 0.9
      },
      "mcc": {
        "code": "7372",
        "title": "Computer Programming, Data Processing, and Integrated Systems Design Services",
        "confidence": 0.85
      }
    },
    "keywords": [
      "SOFTWARE",
      "AI",
      "MACHINE-LEARNING",
      "CLASSIFICATION"
    ]
  },
  "entity_verification": {
    "company_name": "Relativity6",
    "existence_check": {
      "exists": true,
      "citations": [
        "https://rocketreach.co/relativity6-profile_b447f49dfabc8034",
        "https://www.insurancebusinessmag.com/us/news/technology/case-study-relativity6s-industry-classification-tool-402605.aspx",
        "https://leadiq.com/c/relativity6/5a1d9f3b23000052008fb982",
        "https://www.cbinsights.com/company/relativity6",
        "https://relativity6.com"
      ]
    },
    "address": {
      "address_line_1": "210 BROADWAY STREET Broadway Street",
      "address_line_2": "",
      "city": "CAMBRIDGE",
      "state": "MA",
      "zip": "02139",
      "zip_4": "",
      "county": "",
      "country": "",
      "latitude": 0,
      "longitude": 0
    },
    "contact_info": {
      "phone": "(415) 810-4857",
      "email": "",
      "website": "https://www.relativity6.com",
      "fax": "",
      "social_media": {
        "linkedin": "",
        "facebook": "",
        "twitter": "",
        "youtube": ""
      }
    },
    "company_details": {
      "year_founded": 2016,
      "legal_status": [],
      "employee_count": 0,
      "revenue": 0,
      "is_new_business": false,
      "public_vs_private": "",
      "stock_exchange": "",
      "ticker": "",
      "ceo": ""
    },
    "employees": []
  },
  "digital_entity_risk_verification": {
    "domain": "relativity6.com",
    "domain_classification": "business",
    "domain_classification_score": 0.9,
    "first_seen_date": "20161203",
    "domain_age_days": 3319,
    "whois_created_date": "20160303",
    "whois_expiry_date": "20250303",
    "security_assessment": {
      "overall_cybersecurity_grade": {
        "grade": "B",
        "score": 117,
        "description": "Good - Low risk"
      },
      "domain_grade": {
        "grade": "A",
        "description": "Excellent - Very low risk"
      },
      "ssl_certificate": {
        "grade": "B",
        "issuer": "Let's Encrypt",
        "expiry_date": "20250107"
      },
      "website_security_score": 117
    },
    "infrastructure": {
      "hosting_provider": "Amazon Web Services",
      "hosting_domain": "amazonaws.com",
      "ip_block_owner": "Amazon.com, Inc.",
      "web_server_count": 3,
      "mail_servers": [
        "alt1.aspmx.l.google.com",
        "alt2.aspmx.l.google.com",
        "aspmx.l.google.com",
        "aspmx2.googlemail.com",
        "aspmx3.googlemail.com"
      ],
      "technologies": [
        "Adobe Fonts",
        "Amazon CloudFront"
      ]
    },
    "online_presence": {
      "backlinks_count": 6,
      "external_links_count": {
        "homepage": 75,
        "level2": 91
      },
      "social_networks": [
        "Facebook Link",
        "Facebook SDK",
        "LinkedIn",
        "Twitter Cards",
        "Twitter Link"
      ],
      "advertising_platforms": [
        "DoubleClick.Net",
        "Google Adsense"
      ]
    },
    "network_analysis": {
      "network_growth_percentage": 0,
      "dbi_density": {
        "current_quarter": 67,
        "previous_quarter_1": 66,
        "previous_quarter_2": 65
      },
      "device_count": {
        "current_quarter": 0,
        "previous_quarter_1": 0,
        "previous_quarter_2": 0
      }
    },
    "risk_indicators": {
      "is_free_email": false,
      "is_isp": false,
      "suspicious_features": []
    }
  },
  "business_reputation_risk": {
    "adverse_media": [
      {
        "title": "Relativity6 Partners with Duck Creek Technologies, Offering Fast and Accurate Industry Classification",
        "date": "2023-07-19T13:08:27Z",
        "source": "KY3",
        "url": "https://www.ky3.com/prnewswire/2023/07/19/relativity6-partners-with-duck-creek-technologies-offering-fast-accurate-industry-classification/"
      }
    ],
    "risk_score": 11,
    "risk_level": "Standard",
    "risk_indicators": [
      {
        "category": "News Media",
        "subcategory": "news_media_ownership_change",
        "score": 11,
        "date": ""
      }
    ],
    "news_events": [
      {
        "event_type": "Ownership Change",
        "severity": "",
        "confidence": 0,
        "materiality_score": 0.414000004529953,
        "entity_risk": "Undetermined",
        "articles": [
          {
            "title": "Relativity6 Partners with Duck Creek Technologies, Offering Fast and Accurate Industry Classification",
            "url": "https://www.ky3.com/prnewswire/2023/07/19/relativity6-partners-with-duck-creek-technologies-offering-fast-accurate-industry-classification/",
            "date": "2023-07-19T13:08:27Z",
            "publisher": "KY3"
          }
        ]
      }
    ],
    "source_information": []
  }
}

Response Properties

The response contains several nested objects providing detailed information. Key top-level properties include:

Property	Type	Description
requestId	string	Unique identifier for this specific API request.
business_risk_summary	object	High-level summary of business and associated risks.
business_classification	object	Detailed industry classification codes (NAICS, SIC, MCC) and keywords.
entity_verification	object	Information verifying the existence and details of the business entity (address, contacts, etc.).
digital_entity_risk_verification	object	Analysis of the company's online presence and associated digital risks (domain details, security).
business_reputation_risk	object	Assessment of reputation based on adverse media and news events.

Refer to the example response above for the detailed structure within each nested object.

Error Codes

Status	Description
400	Bad Request - Invalid or missing required parameters.
401	Unauthorized - Invalid or missing x-api-key.
500	Internal Server Error - An issue occurred on the server side.
503	Service Unavailable - The service is temporarily unavailable or overloaded.

Flags API

POST

/flags

The Flags API provides configurable hazard analysis and risk assessment for businesses. This endpoint analyzes business information and returns a custom set of flags determined by your organization's requirements.

Configurable Analysis

The flags returned by this API are customized for each client based on their specific risk assessment needs. The available flags and categories are configured during onboarding.

Full Request Example

POST https://api.relativity6.com/flags
Content-Type: application/json
x-api-key: YOUR_API_KEY

{
  "business_name": "Acme Construction Company",
  "business_address": "123 Industrial Blvd, San Francisco, CA 94107",
  "category_filter": ["High-Risk Activities", "Regulatory/Compliance"],
  "flag_filter": ["Construction", "OSHA violations"]
}

Request Body

{
  "business_name": "Acme Construction Company",
  "business_address": "123 Industrial Blvd, San Francisco, CA 94107",
  "category_filter": ["High-Risk Activities", "Regulatory/Compliance"],
  "flag_filter": ["Construction", "OSHA violations"]
}

Parameters

Parameter	Type	Required	Description
business_name	string	Yes	The name of the business to analyze
business_address	string	Yes	The complete business address including city and state
category_filter	array	No	Optional array of category names to limit analysis to specific risk categories
flag_filter	array	No	Optional array of specific flag names to check for (overrides category_filter)

Response

The response contains the analysis results with detailed information about each identified hazard or risk factor.

{
  "requestId": "flags-1234567890abcdef",
  "business_name": "Acme Construction Company",
  "business_address": "123 Industrial Blvd, San Francisco, CA 94107",
  "hazard_results": [
    {
      "hazard_flag": "Construction",
      "hazard_category": "High-Risk Activities",
      "explanation": "Business appears to be involved in construction activities based on company name and industry classification",
      "confidence_score": 0.95,
      "evidence_link": "https://example.com/evidence-source"
    },
    {
      "hazard_flag": "OSHA violations",
      "hazard_category": "Regulatory/Compliance",
      "explanation": "Recent OSHA violations found for this business location",
      "confidence_score": 0.87,
      "evidence_link": "https://osha.gov/enforcement/results"
    }
  ]
}

Error Codes

Status	Description
400	Bad Request - Missing required fields or invalid filter values
403	Forbidden - Invalid API Key or insufficient permissions
429	Too Many Requests - Rate limit exceeded
500	Server Error - Analysis service temporarily unavailable

SOS API

POST

/sos

The SOS (Secretary of State) API provides comprehensive business incorporation and registration data. This endpoint searches for business entities in state databases and returns detailed information about incorporation status, business identifiers, and official registration records.

Official State Records

This API searches official state business registries to provide authoritative information about business incorporation and legal status.

Full Request Example

POST https://api.relativity6.com/sos
Content-Type: application/json
x-api-key: YOUR_API_KEY

{
  "name": "Acme Corporation",
  "address": "123 Main Street, San Francisco, CA 94105"
}

Request Body

{
  "name": "Acme Corporation",
  "address": "123 Main Street, San Francisco, CA 94105"
}

Parameters

Parameter	Type	Required	Description
name	string	Yes	The legal business name to search for
address	string	No	Business address to help improve matching accuracy

Response

The response contains detailed business information if a match is found, including incorporation details, identifiers, and addresses.

Success Response (Match Found)

{
  "requestId": "sos-1234567890abcdef",
  "searchedName": "Acme Corporation",
  "searchedAddress": "123 Main Street, San Francisco, CA 94105",
  "matchFound": true,
  "matchChecks": {
    "exactNameMatch": true,
    "exactAddressMatch": false,
    "matchStrength": 0.95,
    "matchedName": "Acme Corporation",
    "matchedAddress": "125 Main Street, San Francisco, CA 94105"
  },
  "entityData": {
    "businessName": "Acme Corporation",
    "aliases": ["Acme Corp", "Acme Industries"],
    "incorporation": {
      "status": "Active",
      "type": "Corporation",
      "foundedDate": "2020-03-15",
      "state": "CA",
      "country": "US"
    },
    "identifiers": [
      {
        "register": "California Secretary of State",
        "number": "C1234567"
      }
    ],
    "addresses": [
      {
        "street": "125 Main Street",
        "city": "San Francisco",
        "state": "CA",
        "postalCode": "94105",
        "country": "US"
      }
    ]
  }
}

No Match Response

{
  "requestId": "sos-1234567890abcdef", 
  "searchedName": "Nonexistent Business LLC",
  "searchedAddress": "456 Fake Street, Nowhere, CA 90210",
  "matchFound": false
}

Error Codes

Status	Description
400	Bad Request - Missing required 'name' parameter
403	Forbidden - Invalid API Key or insufficient permissions
429	Too Many Requests - Rate limit exceeded
500	Server Error - Business registry service temporarily unavailable

Property APIs

The Property APIs provide comprehensive property data services including address validation and detailed property information combining characteristics, financial data, and ownership details. All property endpoints use the /property resource path.

Comprehensive Property Intelligence

Access validated address data, detailed property characteristics, financial information, and ownership details from authoritative property databases.

Validate

Standardize and validate US postal addresses

POST /property/validate

Principals & Financials

Get comprehensive property data including characteristics, financial information, and ownership details

POST /property/principals-financials

POST

/property/validate

Validates and standardizes US postal addresses using official USPS data. Returns standardized address components, geographic coordinates, and delivery information.

Request Example

POST https://api.relativity6.com/property/validate
Content-Type: application/json
x-api-key: YOUR_API_KEY

{
  "street": "123 Main Street",
  "city": "San Francisco",
  "state": "CA",
  "zipcode": "94105"
}

Parameters

Parameter	Type	Required	Description
street	string	Yes	Primary street address
street2	string	No	Secondary address (apt, suite, etc.)
city	string	No	City name
state	string	No	State abbreviation
zipcode	string	No	ZIP code
candidates	number	No	Max results to return (1-10, default: 1)
match	string	No	Match strategy: "strict", "range", or "invalid" (default: "strict")

Response

{
  "success": true,
  "data": {
    "results": {
      "lookups": [
        {
          "street": "123 Main Street",
          "city": "San Francisco",
          "state": "CA",
          "zipCode": "94105",
          "result": [
            {
              "deliveryLine1": "123 Main St",
              "lastLine": "San Francisco CA 94105-1804",
              "deliveryPointBarcode": "941051804123",
              "components": {
                "primaryNumber": "123",
                "streetName": "Main",
                "streetSuffix": "St",
                "cityName": "San Francisco",
                "state": "CA",
                "zipCode": "94105",
                "plus4Code": "1804"
              },
              "metadata": {
                "latitude": 37.7749,
                "longitude": -122.4194,
                "precision": "Zip9",
                "countyFips": "06075",
                "countyName": "San Francisco",
                "timeZone": "Pacific",
                "utcOffset": -8,
                "obeysDst": true
              }
            }
          ]
        }
      ]
    }
  },
  "requestId": "prop-validate-1234567890abcdef"
}

POST

/property/principals-financials

Provides comprehensive property intelligence by first validating the address, then retrieving detailed property characteristics, financial data, and ownership information. This endpoint combines multiple data sources to deliver a complete property profile in a single request.

Request Example

POST https://api.relativity6.com/property/principals-financials
Content-Type: application/json
x-api-key: YOUR_API_KEY

{
  "street": "456 Oak Avenue",
  "city": "Springfield",
  "state": "IL",
  "zipcode": "62701"
}

Parameters

Uses the same parameters as the validate endpoint.

Parameter	Type	Required	Description
street	string	Yes	Primary street address
street2	string	No	Secondary address (apt, suite, etc.)
city	string	No	City name
state	string	No	State abbreviation
zipcode	string	No	ZIP code

Response

The response is organized into logical sections: address validation, property characteristics (physical features), financial data (assessments, taxes), and owner information (ownership details). Address and contact information is not duplicated across sections.

{
  "success": true,
  "data": {
    "address_validation": {
      "delivery_line_1": "456 Oak Ave",
      "last_line": "Springfield IL 62701-1234",
      "components": {
        "primary_number": "456",
        "street_name": "Oak",
        "street_suffix": "Ave",
        "city_name": "Springfield",
        "state_abbreviation": "IL",
        "zipcode": "62701",
        "plus4_code": "1234"
      },
      "metadata": {
        "county_fips": "17167",
        "county_name": "Sangamon",
        "carrier_route": "R032",
        "congressional_district": "13",
        "latitude": 39.7817,
        "longitude": -89.6501,
        "precision": "Zip9",
        "time_zone": "Central",
        "utc_offset": -6,
        "dst": true
      }
    },
    "property_characteristics": {
      "1st_floor_sqft": "1250",
      "acres": "0.2500000",
      "air_conditioner": "central",
      "bathrooms_total": "2.500",
      "bedrooms": "4",
      "building_sqft": "1850",
      "year_built": "1985",
      "stories_number": "2",
      "exterior_walls": "brick_veneer",
      "foundation": "full_basement",
      "garage": "attached",
      "gross_sqft": "2100",
      "heat": "forced_air",
      "heat_fuel_type": "natural_gas",
      "land_use_standard": "single_family_residence",
      "lot_sqft": "10890.00",
      "fireplace": "yes",
      "fireplace_number": "2",
      "flooring": "hardwood",
      "parking_spaces": "2",
      "porch_area": "120",
      "roof_cover": "asphalt_shingle",
      "rooms": "8",
      "structure_style": "colonial",
      "subdivision": "Maple Heights Subdivision",
      "zoning": "R-1"
    },
    "financial_data": {
      "assessed_improvement_value": "185000",
      "assessed_land_value": "45000",
      "assessed_value": "230000",
      "assessor_last_update": "2024-03-15",
      "market_improvement_value": "185000",
      "market_land_value": "45000",
      "market_value_year": "2024",
      "previous_assessed_value": "225000",
      "sale_amount": "210000",
      "sale_date": "2019-06-12",
      "tax_assess_year": "2024",
      "tax_billed_amount": "3450.75",
      "tax_fiscal_year": "2024",
      "total_market_value": "230000",
      "financial_history": [
        {
          "document_type_description": "deed_of_trust",
          "lender_name": "First National Bank of Springfield",
          "mortgage_amount": "168000",
          "mortgage_due_date": "2049-07-01",
          "mortgage_recording_date": "2019-07-15",
          "mortgage_term": "360",
          "mortgage_type": "conventional"
        }
      ]
    },
    "owner_information": {
      "owner_full_name": "Sarah M Johnson",
      "deed_owner_full_name": "Sarah M Johnson",
      "ownership_type": "individual",
      "owner_occupancy_status": "owner_occupied",
      "deed_sale_date": "2019-06-12",
      "deed_sale_price": "210000",
      "ownership_transfer_date": "2019-06-12"
    }
  },
  "requestId": "prop-principals-fin-1234567890abcdef"
}

Response Structure

Section	Description
address_validation	Standardized address components, coordinates, and delivery metadata
property_characteristics	Physical property details: square footage, bedrooms, bathrooms, building features
financial_data	Assessment values, tax information, sale history, and mortgage details
owner_information	Property ownership details, deed information, and transfer history

Error Codes

Status	Description
400	Bad Request - Missing required 'street' parameter
403	Forbidden - Invalid API Key or insufficient permissions
429	Too Many Requests - Rate limit exceeded
500	Server Error - Property data service temporarily unavailable