Experian API Node.js Library
The Experian Node library provides convenient access to the REST Experian APIs from applications written in server-side JavaScript.
Please keep in mind that this package is for use with server-side Node that uses Experian client_id, client_secret, username, password and subcode (if applicable).
Documentation
Experian API documentation can be @ Experian
Installation
Install the package with:
npm install experian --save
Usage
The package needs to be configured with your account's client_id, client_secret which is available in your Experan My Apps. Require it with the key's value:
var Experian = ;//Create instance of Experian APIvar myExperianAPI = CLIENT_IDCLIENT_SECRET;//Login Method - Returns a promisemyExperianAPI;
Methods
Login
Get API Field
Set Timeout
Set API Version
Set API Key
US Business
Search
businessus
Headers
businessusheaders "bin":"807205801" "subcode":"0563736"
Business Facts
businessus
Fraud Shields
businessus
Risk Dashboards
businessus
Bankruptcies
businessus
Scores
businessus
Trades
businessus
Credit Status
businessus
Corporate Linkage
businessus
Legal Collection Summaries
businessus
Liens
businessus
Judgements
businessus
Collections
businessus
UCC Filings
businessus
Corporate Registrations
businessus
Configuring Timeout
Request timeout is configurable (the default is Node's default of 120 seconds):
experian; // in ms (this is 20 seconds)
response
object
An example "requestId": "XXXX-XXXX-XXXX-XXXX" "success": true "results": ...
error
object
"success": false "requestId": "XXXX-XXXX-XXXX-XXXX" "errors": "errorCode": XXXX "errorType": "Error Type" "message": "Error Message"
Examples
Node.js Express Example
We provided an Express based example of using the Experian Node.js API in the examples/express
folder.
Vanilla js Example
We provided an Express based example of using the Experian Node.js API in the examples/vanilla
folder.
Development
Run all tests:
$ npm install$ npm test