REST API Native connection

Calling the API

To start, make an HTTP Post call to the following URL:

https://api.usemarvin.ai/naics/naics/search/

🚧

Legacy endpoints still work in production

Don’t worry if you’re currently using the following two endpoints, they will redirect to the above endpoint. In the future they will be deprecated, you will be warned far in advance!:

https://apiv2.usemarvin.ai/naics/naics/search/
https://apiv2.usemarvin.ai/naics/naics/search/additional/

Input in the following parameters, using a JSON object:

Name

Type

Description

token

string

Required The API token provided by Relativity6

name

string

Required The company name that is going to be searched.

address

string

Optional The specific address where the company is located.

state

string

Optional The Two-Letter state code where the company is located. e.g. MA: Massachusetts

*Make sure to input the state in order to return existence check response.

predictionType

string

Optional Set the predictor to be used. Values: "USA_NAICS_2017" or "USA_NAICS_2022". Default value: "USA_NAICS_2017".

📘

DBA vs. LLC/Inc/Co vs. Website vs. Names

Everyone's data is different. Please try inputting different types of business names, as well as websites if they are available to you to see which produces the most accuracy in aggregate. We have found through research that putting in a full person's name will produce the least reliably accurate results, e.g. "Jonathan Ringvald" or "Joe Smith".

SmartTags

SmartTags are optional tags that control the way the search is performed. For example, you might want to reduce the data load by choosing false on existenceCheck.

Name

Type

Description

advancedSearch

boolean

Optional Establishes if the search will be performed with the intelligent name cleaning.

Default value: true

prediction

boolean

Optional Choose whether or not to perform the industry predictions.

Default value: true

existenceCheck

boolean

Optional. Choose whether or not to perform the company existence checking on the internet.

Default value: true

keywords

boolean

Optional. Establishes if the search will try to find the keywords.

Default value: false

inputWarning

boolean

Optional. Specifies important messages detected in the request.

Default value: false

explainConfidenceScore

boolean

Optional. Specifies how the Confidence Score is compose according to individual Accuracy of each prediction and the calculated relevance score.

Default value: false

companyWebsite
⭐️ New ⭐️

boolean

Optional. Main website detected.

Default value: false

📘

New Additional information from SmartTags:

advancedSearch: Is a true/false parameter. When set in true, the API will modify the given company name in order to "clean it" so the search will be more effective. When set in false, the API will search the company with the given exact name. If not given, the default value is true.

❗️

Deprecated response

The past 01.07.2022 the API response was updated. See Changelog for detailed description of changes.

Sample Request

In this example, we are looking for the NAICS classification of "Relativity6", within the State of Massachusetts.

{
   "token": "YOUR_TOKEN_HERE",
   "name": "Relativity6",
   "address": "Cambridge",
   "state": "MA", 
   "predictionType":"USA_NAICS_2017",
   "advancedSearch": true, 
   "prediction": true, 
   "existenceCheck": true,
   "keywords": true,
   "inputWarning": true,
   "explainConfidenceScore": true,
   "companyWebsite": true
}

Sample Response

Averaging 2900 milliseconds, the response looks like the following, with two predicted NAICS titles, codes and accuracies for the business entity inquired:

{
    "usa_naics_2017_prediction": {
        "prediction_a": {
            "title": "Computer Systems Design Services",
            "code": 541512,
            "accuracy": 0.75
        },
        "prediction_b": {
            "title": "Computer Training",
            "code": 611420,
            "accuracy": 0.75
        }
    },
    "existence_check": {
        "exists": true,
        "evidence_exist": [
            "https://www.relativity6.com/industry-classification-api",
            "https://relativity6.atlassian.net/wiki/spaces/AN/overview",
            "https://www.crunchbase.com/organization/relativity6",
            "https://www.bizapedia.com/ma/relativity6-inc.html",
            "https://sourceforge.net/software/product/Relativity6/"
        ]
    },
    "keywords": [
        "SOFTWARE",
        "FINANCIAL",
        "INDUSTRY",
        "ARTIFICIAL",
        "RESEARCH",
        "MARKET",
        "CLASSIFY",
        "CLASSIFICATION",
        "SERVICE",
        "AUTO",
        "IMPLEMENT"
    ],
NEW "input_warning":[   
NEW     "No state specified",       
NEW     "No city detected in address", 
NEW     "Multiple names detected in the name field", 
NEW     "Existence check detected only in directories"
NEW ],
NEW "explain_confidence_score":[    
NEW     "Confidence score: Prediction 1 - Accuracy 50% + Relevance score + 30% = 80%",
NEW     "Confidence score: Prediction 2 - Accuracy 45% + Relevance score + 30% = 75%"
NEW ],
NEW "company_website":[
NEW     "http://apple.com",
NEW     "https://www.applestore.com"
NEW ],
    "response_id": "4t9l0ee3va0y4931dc2icaf656bb09f99r814f1e4id8b",
    "response_timestamp": "2022-01-11 05:19:17 CST",
    "response_execution_time": "313 ms",
    "response_notification": "Relativity6 calculated the prediction output successfully",
    "request": {
        "token": "****************************bfe9",
        "name": "Relativity6",
        "intelligentName": "relativity6",
        "address": "",
        "state": "MA",
        "predictionType": "USA_NAICS_2017",
        "advancedSearch": true,
        "prediction": true,
        "existenceCheck": true,
        "keywords": true,
        "inputWarning": true,
        "explainConfidenceScore": true,
        "companyWebsite": true
    }
}

Response explanation

Name

Type

Description

usa_naics_2017_prediction

object

Object containing the information of the industry predictions, each of these predictions contains the following information

title

string

the description of the industry predicted for the company

code

string

the NAICS code according to the predicted industry

accuracy

string

this value determines how reliable the prediction is (from 0 to 1)

existence_check

object

determines if the company searched exists with a significant digital footprint on the internet In order to calculate the existence check it is necessary to enter the name and state information in request. Even if the name and state information is entered in the request to calculate the existence check, there is no guarantee that the company has a web presence.

exists

boolean

A boolean value that determines if the company was found on the internet

evidence_exist

array(string)

links to webpages where the existence of the searched company was found

response_id

string

unique key to identify the response in the system

response_timestamp

string

timestamp when the request was delivered

response_execution_time

string

exact time that the response took to be processed and delivered in miliseconds

response_notification

string

simple message that notifies that everything went well during the request

request

string

It’s a copy of the request that the API received from the client in order to process the given response

keywords

array of strings

Keywords that describe the business' digital footprint

inputWarning
:star: New :star:

array of strings

Set of messages and warnings to indicate to the client which kind of type of data the predictions were made and if some data were missing to improve the quality of the prediction.

explainConfidenceScore
:star: New :star:

array of strings

Shows how the confidence score is composed and how that result is reached.

🚧

Sandbox limit

The request limit in the sandbox can only handle 1,000 calls per second. If you receive the following caption: "Sandbox too busy. Try again later." please try again later.


What’s Next

Check out a list of code examples in different programming languages

Did this page help you?