README

Experian's Business Information Services is a leader in providing data and predictive insights to organizations, helping them mitigate risk and improve profitability. The Businesses API provides integrated access to our business database which provides comprehensive, third-party-verified information on 99.9 percent of all U.S. companies, with the industry's most extensive data on the broad spectrum of small and midsize businesses.

The Businesses API provides a la carte access to Experian's commercial credit and commercial public record information, including commercial scores, trades, corporate linkage, bankruptcies, liens, judgments, and more.

It All Starts With a Search

The Business Search API allows you to input a business name, address, city, and state to find their Business Identification Number (BIN) - you'll need this to get data from most of the other APIs. The primary search method is called \"Advanced Search\" and can be used for automated matching using our Match Reliability Code. A secondary search method, called \"QuickSearch\" and is a type-ahead style search that allows a human user to quickly find a business using a smaller amount of data.

SBCS Consortium Members can use the Businesses API search endpoints.

SBFE Consortium Members must use the SBFE API, using either the List of Similars product option to search for a business, or a Name/Address request for automated matching.

Businesses API in the Sandbox

Advanced Search - The primary way to search for US businesses and return a List of Similars. Designed for both automation and human interaction
Quick Search - The secondary search method. A flexible, type-ahead style search API for US businesses. Designed primarily for human interaction
Headers - Business identity information. Available as stand-alone and included with most API responses
Scores - Commercial Intelliscore Plus and Financial Stability Risk Scores, with scores, score factors, and monthly and quarterly trends
Scores Auto Search - Returns the Scores API, but with a Business Name and Address request input
Premier Profiles JSON - Experian's flagship commercial credit report
Premier Profiles HTML - Renders a styled Premier Profile report using HTML/CSS
Premier Profiles PDF - Provides an encoded Premier Profile PDF report
Intelliscore Report JSON – Our score only report
Intelliscore Report HTML – Our score only report in HTML format
Intelliscore Report PDF – Our score only report in PDF format
Business Compliance Insight JSON – The BCI report helps with client onboarding and Know-Your-Customer investigations
Business Compliance Insight HTML – The BCI Report in HTML format
Business Compliance Insight PDF – The BCI report in PDF format
Aggregates - The BizAggs represent over 400 unique data attributes that represent the building blocks of commercial credit
MultiSegments - MultiSegments allows you to request segments from most Businesses API endpoints in a single API call
Risk Dashboards - Includes commercial and FSR scores, credit limit amount, current DBT
Business Facts - Key operational facts including SIC, NAICS, public status, sales, employees
Fraud Shields - Screens for potential indicators of fraud. Includes possible OFAC match
Credit Status - Key credit facts about the business including tradeline count, balance, DBT
Legal Filings and Collections Summaries - Summary of all legal filings and collections
Collections - Summary and Detail
Trades - Trade summary, payment experiences, payment totals, and trade payment trends
Bankruptcies - Summary and Detail
Liens - Summary and Detail
Judgments - Summary and Detail
UCC Filings - Summary and Trends
Corporate Registrations - Corporate registration info for the business, including filing status
Corporate Linkage - Partial and/or Full Family Tree
Business Contacts - Individual owners, company owners, contacts and titles, and contacts business affiliations
Reverse Addresses - Input an address and find businesses affiliated with that address
Reverse Phones - Input a phone number and find businesses affiliated with that phone number
Reverse Tax IDs - Input a Tax ID (EIN) and find businesses affiliated with that Tax ID
Government Details – Economic diversity and government contract data for the business
IST Watch - Manage OFAC regulatory compliance and watchlist screening with the IST Watch API

Businesses API Environments

Sandbox - https://sandbox-us-api.experian.com/businessinformation/businesses
UAT - https://uat-us-api.experian.com/businessinformation/businesses
Production - https://us-api.experian.com/businessinformation/businesses

Please note that the Businesses API in the Developer Portal Sandbox is a non-production service that is for testing and demonstration purposes only. Only a limited number of businesses are available in the sandbox test environment. A list of valid Business Identification Numbers (BINs) can be provided to you upon your request, and valid BINs in the sandbox can also be obtained using the Business Search API. Please contact your Experian Account Executive to discuss obtaining production access to the Businesses API.

IPv3 Sample Subcodes

IPv3 Logistic Regression - 0586286
IPv3 Machine Learning - 0586548

Additional Developer Tools

BIS API Postman Collection - A starter Postman Collection and Environment for many BIS APIs
BIS HTML Resources - Images, CSS, and Javsscript files necessary to render BIS HTML API reports

This PHP package is automatically generated by the Swagger Codegen project:

API version: 1.0.2
Build package: io.swagger.codegen.languages.PhpClientCodegen

Requirements

PHP 5.5 and later

Installation & Usage

Composer

To install the bindings via Composer, navigate to where your composer.json file is and run the command:

composer require thelogicstudio/experian-businesses-php

Manual Installation

Download the files and include autoload.php:

    require_once('/path/to/SwaggerClient-php/vendor/autoload.php');

Tests

To run the unit tests:

composer install
./vendor/bin/phpunit

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OauthSecurity
$config = TheLogicStudio\ExperianBusinessesPHP\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new TheLogicStudio\ExperianBusinessesPHP\Api\BusinessInformationServicesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$body = new \TheLogicStudio\ExperianBusinessesPHP\Model\BusinessAggregatesRequest(); // \TheLogicStudio\ExperianBusinessesPHP\Model\BusinessAggregatesRequest | Business Aggregates Request
$content_type = "application/json"; // string | Content-Type field is to describe the data contained in the body.

try {
    $result = $apiInstance->aggregates($body, $content_type);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BusinessInformationServicesApi->aggregates: ', $e->getMessage(), PHP_EOL;
}

?>

Documentation for API Endpoints

All URIs are relative to https://sandbox-us-api.experian.com/businessinformation/businesses

Class	Method	HTTP request	Description
BusinessInformationServicesApi	aggregates	POST /v1/aggregates	BizAggs
BusinessInformationServicesApi	bankruptcies	POST /v1/bankruptcies	Business Bankruptcies
BusinessInformationServicesApi	bci	POST /v1/bci	Business Compliance Insight JSON
BusinessInformationServicesApi	bcihtml	POST /v1/bci/html	Business Compliance Insight HTML
BusinessInformationServicesApi	bcipdf	POST /v1/bci/pdf	Business Compliance Insight PDF
BusinessInformationServicesApi	businesscontacts	POST /v1/businesscontacts	Business Contacts
BusinessInformationServicesApi	collections	POST /v1/collections	Commercial Collections
BusinessInformationServicesApi	corporateLinkage	POST /v1/corporatelinkage	Corporate Linkage
BusinessInformationServicesApi	corporateRegistration	POST /v1/corporateregistrations	Corporate Registrations
BusinessInformationServicesApi	creditstatus	POST /v1/creditstatus	Commercial Credit Status
BusinessInformationServicesApi	facts	POST /v1/facts	Business Facts
BusinessInformationServicesApi	fraudShields	POST /v1/fraudshields	Commercial Fraud Shields
BusinessInformationServicesApi	governmentdetails	POST /v1/governmentdetails	Government Details
BusinessInformationServicesApi	headers	POST /v1/headers	Business Headers
BusinessInformationServicesApi	intelliscoreplus	POST /v1/reports/intelliscoreplus	Intelliscore Plus JSON
BusinessInformationServicesApi	intelliscoreplushtml	POST /v1/reports/intelliscoreplus/html	Intelliscore Plus HTML
BusinessInformationServicesApi	intelliscorepluspdf	POST /v1/reports/intelliscoreplus/pdf	Intelliscore Plus PDF
BusinessInformationServicesApi	istwatch	POST /v1/istwatch	IST Watch
BusinessInformationServicesApi	judgments	POST /v1/judgments	Business Judgments
BusinessInformationServicesApi	legalCollectionSummaries	POST /v1/legalcollectionsummaries	Legal Filings and Collections Summaries
BusinessInformationServicesApi	liens	POST /v1/liens	Business Liens
BusinessInformationServicesApi	multisegments	POST /v1/multisegments	MultiSegments. Request a la carte segments in a single call
BusinessInformationServicesApi	premierprofiles	POST /v1/reports/premierprofiles	Premier Profiles JSON
BusinessInformationServicesApi	premierprofileshtml	POST /v1/reports/premierprofiles/html	Premier Profiles HTML
BusinessInformationServicesApi	premierprofilespdf	POST /v1/reports/premierprofiles/pdf	Premier Profiles PDF
BusinessInformationServicesApi	quicksearch	POST /v1/quicksearch	Quick Search. Our secondary search method
BusinessInformationServicesApi	reverseaddresses	POST /v1/reverseaddresses	Reverse Addresses
BusinessInformationServicesApi	reversephones	POST /v1/reversephones	Reverse Phones
BusinessInformationServicesApi	reversetaxids	POST /v1/reversetaxids	Reverse TaxIDs
BusinessInformationServicesApi	riskdashboards	POST /v1/riskdashboards	Commercial Risk Dashboards
BusinessInformationServicesApi	scores	POST /v1/scores	Commercial Scores
BusinessInformationServicesApi	scoressearch	POST /v1/scores/search	Scores Auto Search
BusinessInformationServicesApi	search	POST /v1/search	Advanced Business Search. The primary search method
BusinessInformationServicesApi	trades	POST /v1/trades	Commercial Trades
BusinessInformationServicesApi	uccfilings	POST /v1/uccfilings	UCC Filings

Documentation For Models

Documentation For Authorization

OauthSecurity

Type: OAuth
Flow: password
Authorization URL:
Scopes:
admin: admin scope

Author

Ian Simpson, The Logic Studio

thelogicstudio / experian-businesses-php

Maintainers

Details