Welcome to Enigma Docs

Welcome to Enigma! Here you'll find comprehensive guides and documentation to help you start working with Enigma's Businesses product as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    

ID Endpoint

Enigma's ID endpoint supports retrieval of a business profile using its unique Enigma ID.

The ID endpoint supports retrieval of a business profile using its unique Enigma IDEnigma ID - Enigma ID is the unique, persistent ID for the entity in Enigma’s SMB data, assigned as a result of our expert Entity Resolution process.. Additionally, this endpoint allows you to select premium attributes - Enigma’s differentiated, derived attributes that provide key signals about each business entity.

For technical guidance around this endpoint, see our API Reference.

Overview

For example, again suppose an SMB lender is evaluating an application from a business for a loan. The lender is interested in understanding the applicant’s risk profile - things the industry it operates in, what licenses it has, whether it has had any adverse credit events in the past.

Once the lender has identified the applicant using our Match Endpoint, they will use the ID endpoint to retrieve data on the business.

Making a request to businesses/ID

Headers

To make a Businesses API request, first ensure to enter your API key by adding the following request header.

X-api-key: YOUR-API-KEY

Query Parameters

attrs: Pass the desired attributes using this key in the query parameter. More than one attribute can be passed by using a comma(,) separated list. By default all basic attributes will be returned.

lookback_months: For certain premium attributes (see attribute dictionary), historical data going back to Jan 2017 is available. Use this parameter to control the number of months of historical data to pull. Values can be in the range of 0-48 inclusive. By default the API returns the most recently available 1 month of data.

Inputs

Once your headers are configured, all you need is the Enigma ID for the business you want to learn more about. The ID endpoint supports GET requests, where the Enigma ID is appended to the Businesses API base URL.

Below is an example of a GET request to pull data on Enigma Technologies using its unique Enigma ID.

Request
import requests
import json

base_url = 'https://api.enigma.com'
headers = {
  'x-api-key': 'YOUR-API-KEY'
}
url = base_url + '/businesses/E000f971c20000020c?attrs=refunds&lookback_months=2'
# In addition to our basic attributes, this will return the premium attribute 'refunds' for the most recently available 2 months.
params = {}
response = requests.get(url, params=params, headers=headers).json()
let requesturl = 'lookup/E000f971c20000020c';
// Configure request headers
let headers = new Headers();
headers.append('x-api-key': 'YOUR-API-KEY');
fetch(requesturl, {
  method: 'GET',
  headers: headers
})
.then(response => response.json())
.then(function (response) {
  console.log(response);
})
.catch(function (error) {
  console.log(error);
});
curl -X GET 'https://api.enigma.com/businesses/E000f971c20000020c' -H 'x-api-key: YOUR-API-KEY' | python -m json.tool
Response
{
    "enigma_id": "E000f971c20000020c",
    "business_enigma_id": "B00233ee1f5e",
    "data_sources": [
        "Third-Party Active Business",
        "UCC Loans",
        "Corporate Registrations",
        "H1B Visa Applications",
        "Card Transactions"
    ],
    "aliases": [
        "ENIGMA TECHNOLOGIES INC",
        "ENIGMA TECHNOLOGIES INC WA",
        "ENIGMA TECHNOLOGIES"
    ],
    "addresses": [
        {
            "street_address1": "245 5TH AVE",
            "street_address2": "FL 17",
            "city": "NEW YORK",
            "state": "NY",
            "postal_code": "10016"
        },
        {
            "street_address1": "245 5TH AVE",
            "street_address2": "",
            "city": "NEW YORK",
            "state": "NY",
            "postal_code": "10016"
        },
        {
            "street_address1": "600 W MAIN ST",
            "street_address2": "",
            "city": "JEFFERSON CITY",
            "state": "MO",
            "postal_code": "65101"
        },
        {
            "street_address1": "501 LOUISIANA AVE",
            "street_address2": "",
            "city": "BATON ROUGE",
            "state": "LA",
            "postal_code": "70802"
        }
    ],
    "ein": [],
    "associated_people": [
        {
            "name": "HICHAM OUDGHIRI",
            "titles": [
                "CEO",
                "OFFICER"
            ]
        },
        {
            "name": "OUDGHIRI HICHAM",
            "titles": [
                "OFFICER"
            ]
        }
    ],
    "registered_agents": [
        "CORPORATION SERVICE COMPANY",
        "ENIGMA TECHNOLOGIES INC",
        "CORPORATION SERVICE COMPANY D B A CSC-LAWYERS INCORPORATING SERVICE COMPANY",
        "SECRETARY OF STATE"
    ],
    "phone_numbers": [],
    "websites": [
        "https://www.enigma.com/"
    ],
    "registrations": [
        {
            "state": "WA",
            "issue_date": "2017-08-20",
            "file_number": "604163534"
        },
        {
            "state": "MA",
            "issue_date": "2020-04-28",
            "file_number": "001435918"
        },
        {
            "state": "TN",
            "issue_date": "2019-01-26",
            "file_number": "001007445"
        },
        {
            "state": "LA",
            "issue_date": "2016-05-10",
            "file_number": "42261937F"
        },
        {
            "state": "TX",
            "issue_date": "2017-10-27",
            "file_number": "0802847446"
        },
        {
            "state": "HI",
            "issue_date": "2019-01-26",
            "file_number": "100516F1"
        },
        {
            "state": "DC",
            "issue_date": "2017-08-18",
            "file_number": "EXTUID_4192167"
        },
        {
            "state": "CA",
            "issue_date": "2018-01-17",
            "file_number": "C4106346"
        },
        {
            "state": "NY",
            "issue_date": "2011-11-09",
            "file_number": "4163621"
        },
        {
            "state": "MO",
            "issue_date": "2018-07-28",
            "file_number": "F001330176"
        }
    ],
    "corporate_structure": "CORPORATION",
    "company_description": [],
    "year_incorporated": "2011",
    "refunds": [
        {
            "end_date": "2022-02-28",
            "1m": {
                "average_transaction_size": null,
                "revenue_ratio": null,
                "revenue_ratio_growth_rate": null,
                "start_date": "2022-02-01",
                "amount": null
            },
            "3m": {
                "average_transaction_size": null,
                "revenue_ratio": 0.0,
                "revenue_ratio_growth_rate": null,
                "start_date": "2021-12-01",
                "amount": 0.0
            },
            "12m": {
                "average_transaction_size": null,
                "revenue_ratio": 0.0,
                "revenue_ratio_growth_rate": null,
                "start_date": "2021-03-01",
                "amount": 0.0
            }
        },
        {
            "end_date": "2022-01-31",
            "1m": {
                "average_transaction_size": null,
                "revenue_ratio": 0.0,
                "revenue_ratio_growth_rate": null,
                "start_date": "2022-01-01",
                "amount": 0.0
            },
            "3m": {
                "average_transaction_size": null,
                "revenue_ratio": 0.0,
                "revenue_ratio_growth_rate": null,
                "start_date": "2021-11-01",
                "amount": 0.0
            },
            "12m": {
                "average_transaction_size": null,
                "revenue_ratio": 0.0,
                "revenue_ratio_growth_rate": null,
                "start_date": "2021-02-01",
                "amount": 0.0
            }
        }
    ]
}

Retrieving premium attributes

📘

To see what the basic profile includes and what premium data is available, see our Attribute Dictionary

Back to our SMB lender example - when evaluating an applicant, the lender may want to know the business’ Verification ScoreVerification Score - The score from 0 to 1 represents Enigma’s confidence, based on the verification components below. and yelp_datayelp_data - A list of Yelp URLs corresponding to Yelp pages associated with the business. To obtain this data, she would configure her attrs param as follows:

attrs: "verification,yelp"

Below is an example of a GET request containing this parameter.

Request
import requests
import json
base_url = 'https://api.enigma.com/businesses/'
headers = {
  'x-api-key': 'YOUR-API-KEY'
}
url = base_url + 'E00003a8000001ea?attrs=yelp,verification'
params = {}
response = requests.get(url, params=params, headers=headers).json()
let requesturl = 'lookup/E00003a8000001ea';
// Configure request headers
let headers = new Headers();
headers.append('x-api-key': 'YOUR-API-KEY');
fetch(requesturl, {
  method: 'GET',
  headers: headers
})
.then(response => response.json())
.then(function (response) {
  console.log(response);
})
.catch(function (error) {
  console.log(error);
});
curl -X GET 'https://api.dev.enigma.com/businesses/E00003a8000001ea?attrs=verification,yelp' -H 'x-api-key: YOUR-API-KEY'| python -m json.tool
Response
{
  "enigma_id": "E00003a8000001ea",
  "data_sources": [
    "Liquor Licenses",
    "Government Assistance",
    "SBA Loans",
    "Third-Party Active Business",
    "UCC Loans",
    "Corporate Registrations",
    "Card Transactions"
  ],
  "aliases": [
    "245 GOURMET FOOD INC",
    "CAFE 28",
    "245 GOURMET FOOD",
    "245 GOURMET FOOD INC DBA 245 GOURMET FOOD INC",
    "245 GOURMENT FOOD INC"
  ],
  "updated_at": "2021-07-30",
  "addresses": [
    {
      "street_address1": "245 5 AVE",
      "street_address2": "",
      "city": "NEW YORK",
      "state": "NY",
      "postal_code": "10016"
    },
    {
      "street_address1": "245 5 AVE",
      "street_address2": "FRNT A",
      "city": "NEW YORK",
      "state": "NY",
      "postal_code": "10016"
    },
    {
      "street_address1": "245 5 AVE",
      "street_address2": "A",
      "city": "NEW YORK",
      "state": "NY",
      "postal_code": "10016"
    },
    {
      "street_address1": "245 5 AVE",
      "street_address2": "RM 1900",
      "city": "NEW YORK",
      "state": "NY",
      "postal_code": "10016"
    },
    {
      "street_address1": "245 5 AVE",
      "street_address2": "",
      "city": "NEW YORK",
      "state": "NY",
      "postal_code": "10001"
    },
    {
      "street_address1": "245 5 AVE",
      "street_address2": "",
      "city": "GROUND FL NEW YORK",
      "state": "NY",
      "postal_code": "10016"
    }
  ],
  "ein": [],
  "associated_people": [
    {
      "name": "EUI CHUN WHANG",
      "titles": [
        "OFFICER"
      ]
    },
    {
      "name": "EUI WHANG",
      "titles": [
        "OWNER"
      ]
    }
  ],
  "registered_agents": [
    "245 GOURMET FOOD INC"
  ],
  "phone_numbers": [
    "+12126867300"
  ],
  "websites": [],
  "registrations": [
    {
      "state": "NY",
      "issue_date": "2003-01-14",
      "file_number": "2856713"
    }
  ],
  "corporate_structure": "CORPORATION",
  "company_description": [],
  "year_incorporated": "2003",
  "verification": {
    "score": 1,
    "components": {
      "data_freshness": 1,
      "source_quality": 1,
      "data_footprint": 1,
      "business_activity": 1
    }
  }
}

📘

Try our API

Try it out in our Quick Start tool or by hitting the API directly.

Updated 8 days ago


ID Endpoint


Enigma's ID endpoint supports retrieval of a business profile using its unique Enigma ID.

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.