Quick Start Guide

This guide is designed to help you understand Experian APIs. Here, you will find everything you need to get your first application off the ground, including sample code.

If this is your first time with Experian APIs, we recommend you to complete the steps below.

Step 1: Create an account

To make your first API request you’ll first need to create a Developer Portal account.
Once your email address is verified, you’re ready to start developing your first application.

Step 2: Register your first application

Now you have successfully registered, you are ready to create an application and test our range of APIs.

  1.  Log in to the Developer Portal
  2.  Click on the profile tab and navigate to the My Apps section
  3.  Click on the Add New App button
  4.  Create an App name of your choice (e.g. 'My Test Application')
  5.  Select the products you require
  6.  Select Add App to complete the registration of your application

Your applications can now be accessed in My Apps.

Step 3: Get an access token

When you register an application, a Client ID and Client Secret are created.
These will be used to make the calls from your application to the Experian API.

Get your access token using the Client ID and Client Secret from the application you have created along with
your Developer Portal Username and Password.

The call to get the Oauth2 token is a POST request with a Content-Type which needs to be specified as JSON;
the response will also be in JSON format:

Request example:

curl -X POST
-d '{"username": "youremail@email.com", "password": "YOURPASSWORD"}'
-H "Client_id: 3QC11Sm45ti8wXXxx9A5hma5XIlXXXXX"
-H "Client_secret: ipu3WXXxTExxZDXW"
-H "Cache-Control: no-cache"
-H "Content-Type: application/json"
"https://sandbox-us-api.experian.com/oauth2/v1/token"

 

Response example:

{
    "issued_at": "1478405901908",
    "expires_in": "7200",
    "token_type": "Bearer",
    "access_token": "eyJraWQiOiJBSmpTMXJQQjdJODBHWjgybmNsSlZPQkF3V3B3ZTVYblNKZUdSZHdpcEYxIiwidHlwIjoiSldUIiwiYWxnIjoiUlMyNTYifQ.
                     eyJzdWIiOiJmcmVkZGllIiwiRW1haWwiOiJmcmVkZXJpYy52YW5kZXJlbHN0QGV4cGVyaWFuLmNvbSIsIkZpcnN0TmFtZSI6ImZyZWRkaWUiL
                     CJpc3MiOiJFWFBFUklBTiIsIkxhc3ROYW1lIjoidmFuZGVyIGVscyIsImV4cCI6MTUwOTAyNDkxMSwiaWF0IjoxNTA5MDE3NzExLCJqdGkiOi
                     I1YTdlYzJhZS00YzdiLTQ3MzktYmU0MS1hMDdjZTBmNTc2N2YifQ.MINbv9JtA9JeBW0cp6mhRZ7xhOvu3oI8WDu73xInj14w1fZRX0PaHFR9
                     OsCgzGrn-7s46vS2vyScd_MWYfFRWQ8TUGpZ6Gbdh43l_B4UJxu5Uujh1bhrWA1KCsxr5p7LKNI6Pxhc76oVd2EAd0I3X7um-d_fIlds1N4KA
                     XmYtXT_oU8DklKHYiWH6L5Yx3Ue_kYQwXikqU0nXdvab35KyFCza9XqSJEeVEubTSdTvvVluzv4AJxN5X-yEtzOtNTV_Yynj4KzdYv8tpuoF2
                     LGdzp4G0fOe8mLRNY3g4rCfAnpe0yc1h6LHh0TMhu2e8jaIro4dx7b3VhLlXULm1RqPw",
    "refresh_token": "3Ib5SjC6AOUx5R47ffobFFi8DhGlC2GO"
}

 

Step 4: Send your first request

Use your access token as a bearer token in the authorisation header and make your first API call as shown below:

curl -X GET 
 'https://sandbox-us-api.experian.com/risk/businesses/v1/businesstargeter?name=Test' 
 -H 'accept: application/json' 
 -H 'authorization: Bearer eyJraWQiOiJBSmpTMXJQQjdJODBHWjgybmNsSlZPQkF3V3B3ZTVYblNKZUdSZHdpcEYxIiwidHlwIjoiSldUIiwiYWxnIjoiUlMyNTYifQ.
                           eyJzdWIiOiJmcmVkZGllIiwiRW1haWwiOiJmcmVkZXJpYy52YW5kZXJlbHN0QGV4cGVyaWFuLmNvbSIsIkZpcnN0TmFtZSI6ImZyZWRkaWU
                           iLCJpc3MiOiJFWFBFUklBTiIsIkxhc3ROYW1lIjoidmFuZGVyIGVscyIsImV4cCI6MTUwOTAyNDkxMSwiaWF0IjoxNTA5MDE3NzExLCJqdG
                           kiOiI1YTdlYzJhZS00YzdiLTQ3MzktYmU0MS1hMDdjZTBmNTc2N2YifQ.MINbv9JtA9JeBW0cp6mhRZ7xhOvu3oI8WDu73xInj14w1fZRX0
                           PaHFR9OsCgzGrn-7s46vS2vyScd_MWYfFRWQ8TUGpZ6Gbdh43l_B4UJxu5Uujh1bhrWA1KCsxr5p7LKNI6Pxhc76oVd2EAd0I3X7um-d_fI
                           lds1N4KAXmYtXT_oU8DklKHYiWH6L5Yx3Ue_kYQwXikqU0nXdvab35KyFCza9XqSJEeVEubTSdTvvVluzv4AJxN5X-yEtzOtNTV_Yynj4Kz
                           dYv8tpuoF2LGdzp4G0fOe8mLRNY3g4rCfAnpe0yc1h6LHh0TMhu2e8jaIro4dx7b3VhLlXULm1RqPw'

Explore the Developer Portal for more information including our range of API endpoints through the Documentation tab.