Enigma Docs

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

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 going forward and obtain

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

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/E000039e00000929'
params = {}
response = requests.get(url, params=params, headers=headers).json()
let requesturl = 'https://api.enigma.com/businesses/E000039e00000929';
// 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/E000039e00000929' -H 'x-api-key: YOUR-API-KEY' | python -m json.tool
Response
{
  "company_description": [],
  "enigma_id": "E000039e00000929",
  "data_sources": [
    "H1B Visa Applications",
    "Third-Party Active Business",
    "UCC Loans",
    "Corporate Registrations"
  ],
  "aliases": [
    "ENIGMA TECHNOLOGIES INC"
  ],
  "updated_at": "2020-02-29",
  "addresses": [
    {
      "street_address1": "245 5 AVE",
      "street_address2": "FL 17",
      "city": "NEW YORK",
      "state": "NY",
      "postal_code": "10016"
    },
    {
      "street_address1": "245 5 AVE",
      "street_address2": "",
      "city": "NEW YORK",
      "state": "NY",
      "postal_code": "10016"
    },
    {
      "street_address1": "245 5 AVE 17",
      "street_address2": "",
      "city": "NEW YORK",
      "state": "NY",
      "postal_code": "10016"
    },
    {
      "street_address1": "245 5 AVE",
      "street_address2": "17 FL",
      "city": "NEW YORK",
      "state": "NY",
      "postal_code": "10016"
    },
    {
      "street_address1": "501 LOUISIANA AVE",
      "street_address2": "",
      "city": "BATON ROUGE",
      "state": "LA",
      "postal_code": "70802"
    }
  ],
  "ein": [
    "422236667"
  ],
  "associated_people": [
    {
      "name": "OUDGHIRI HICHAM",
      "titles": [
        "OFFICER"
      ]
    },
    {
      "name": "HICHAM OUDGHIRI",
      "titles": [
        "OFFICER"
      ]
    }
  ],
  "registered_agents": [
    "ENIGMA TECHNOLOGIES INC",
    "CORPORATION SERVICE COMPANY"
  ],
  "phone_numbers": [
    "+8005102856"
  ],
  "websites": [
    "https://www.enigma.com/"
  ],
  "registrations": [
    {
      "state": "HI",
      "issue_date": "2019-01-26",
      "file_number": null
    },
    {
      "state": "WA",
      "issue_date": "2017-08-20",
      "file_number": null
    },
    {
      "state": "TX",
      "issue_date": "2017-10-27",
      "file_number": null
    },
    {
      "state": "CA",
      "issue_date": "2018-01-17",
      "file_number": null
    },
    {
      "state": "DC",
      "issue_date": "2017-08-18",
      "file_number": null
    },
    {
      "state": "LA",
      "issue_date": "2016-05-10",
      "file_number": null
    },
    {
      "state": "NY",
      "issue_date": "2011-11-09",
      "file_number": null
    },
    {
      "state": "DE",
      "issue_date": "2011-11-09",
      "file_number": "4163621"
    },
    {
      "state": "TN",
      "issue_date": null,
      "file_number": null
    }
  ],
  "corporate_structure": "CORPORATION",
  "headcount": "51-200",
  "year_incorporated": "2011"
}

Retrieving premium attributes

By default, calls to the ID endpoint of the Businesses API are free, and return the basic profile for the business. In addition to the basic profile, the ID endpoint allows users to access our premium attributes on a request-by-request basis.

📘

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

Using the attrs parameter, you can specify which premium attributes you would like the API to return. Different attributes have different prices, and each call to the ID endpoint is billed according to the attributes requested.

Back to our SMB lender example - when evaluating an applicant, the lender may want to know the business’ , and . To obtain this data, she would configure her attrs param as follows:

attrs: "ver,yelp"

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

Request
import requests
url = "https://api.dev.enigma.com/businesses/E00003a8000001ea"
querystring = {"attrs":"ver,yelp"}
headers = {
    'x-api-key': "YOUR-API-KEY"
    }
response = requests.request("GET", url, headers=headers, params=querystring)
print(response.json())
let requesturl = new URL('https://api.enigma.com/businesses/E00003a8000001ea');
requesturl.search = new URLSearchParams({attrs: 'ver,yelp'});
// Configure request headers
headers = {'x-api-key': "YOUR-API-KEY"}
fetch(requesturl.toString(), {
  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=ver,yelp' -H 'x-api-key: YOUR-API-KEY'
Response
{
    "enigma_id": "E00003a8000001ea",
    "data_sources": [
        "Liquor Licenses",
        "SBA Loans",
        "Third-Party Active Business",
        "UCC Loans",
        "Corporate Registrations"
    ],
    "aliases": [
        "245 GOURMET FOOD INC",
        "245 GOURMET FOOD",
        "CAFE 28"
    ],
    "updated_at": "2020-05-09",
    "addresses": [
        {
            "street_address1": "245 5 AVE",
            "street_address2": "",
            "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": "FRNT A",
            "city": "NEW YORK",
            "state": "NY",
            "postal_code": "10016"
        },
        {
            "street_address1": "245 5 AVE",
            "street_address2": "",
            "city": "GROUND FL NEW YORK",
            "state": "NY",
            "postal_code": "10016"
        },
        {
            "street_address1": "245 5 AVE",
            "street_address2": "",
            "city": "NEW YORK",
            "state": "NY",
            "postal_code": "10001"
        }
    ],
    "ein": [],
    "associated_people": [
        {
            "name": "EUI CHUN WHANG",
            "titles": [
                "OFFICER"
            ]
        },
        {
            "name": "EUI WHANG",
            "titles": [
                "OWNER"
            ]
        }
    ],
    "registered_agents": [
        "245 GOURMET FOOD INC"
    ],
    "phone_numbers": [
        "+12126867300"
    ],
    "websites": null,
    "registrations": [
        {
            "state": "NY",
            "issue_date": "2003-01-14",
            "file_number": null
        },
        {
            "state": "NY",
            "issue_date": "2003-01-14",
            "file_number": "2856713"
        }
    ],
    "corporate_structure": "CORPORATION",
    "headcount": "1-20",
    "company_description": [],
    "year_incorporated": "2003",
    "yelp_data": {
        "urls": [
            "https://www.yelp.com/biz/245-gourmet-food-new-york"
        ]
    },
    "verification": {
        "score": 1,
        "components": {
            "data_freshness": 1,
            "source_quality": 1,
            "data_footprint": 0.99,
            "business_activity": 1
        }
    }
}

Free Trial

As a reminder, we provide all new users with a $1000 free trial credit to get started. Use this to familiarize yourself with our premium attributes.

📘

Try our API

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

Updated 3 months ago


ID Endpoint


Suggested Edits are limited on API Reference Pages

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