Equifax APIs

REST APIs for Equifax

Equifax API calls must originate from the end-client

Equifax end-points are accessible by first using the User API /users/efx-config response data, and then the Equifax /oauth/token call. As mentioned above, User API and Equifax API calls are intended to be called from the end-client/user's device.

Equifax Documentation in Swagger

Endpoints

Delivery Token
Credit Alerts
Credit Score
Credit Score Latest
Credit Score History
Credit Report List
Credit Report
Credit Report Summary
Credit Report PDF
/oauth/token
/v1/creditMonitoring
/v1/creditScore
/v1/creditScore/latest
/v1/creditScore/history
/v1/creditReport
/v1/creditReport/{reportId}
/v1/creditReport/{reportId}/summary
/v1/creditReport/{reportId}/print

Credit Monitoring

/{efx_url}/v1/creditMonitoring

Request
query Parameters
format
required
string
Example: format=json
Responses
200
get/{efx_url}/v1/creditMonitoring
Request samples

Credit Report (First in list) - PRINT

/{efx_url}/v1/creditReport/{reportId}/print

Request
path Parameters
reportId
required
string
query Parameters
access_token
required
string
Example: access_token={{efxtoken}}
Responses
200
get/{efx_url}/v1/creditReport/{reportId}/print
Request samples

Credit Report Summary (First in list)

/{efx_url}/v1/creditReport/{reportId}/summary

Request
path Parameters
reportId
required
string
query Parameters
format
required
string
Example: format=json
Responses
200
get/{efx_url}/v1/creditReport/{reportId}/summary
Request samples

Credit Score History

/{efx_url}/v1/creditScore/history

Request
query Parameters
historicalLimit
required
integer <int32>
Example: historicalLimit=24
format
required
string
Example: format=json
Responses
200
get/{efx_url}/v1/creditScore/history
Request samples

Credit Score Latest

/{efx_url}/v1/creditScore/latest

Request
query Parameters
format
required
string
Example: format=json
Responses
200
get/{efx_url}/v1/creditScore/latest
Request samples

CreditReportList

/{efx_url}/v1/creditReport

Request
query Parameters
format
required
string
Example: format=json
Responses
200
get/{efx_url}/v1/creditReport
Request samples

Full Credit Report (First in list)

/{efx_url}/v1/creditReport/{reportId}

Request
path Parameters
reportId
required
string
query Parameters
format
required
string
Example: format=json
Responses
200
get/{efx_url}/v1/creditReport/{reportId}
Request samples

Health Check

/{efx_url}/v1/creditMonitoring/healthcheck

Request
query Parameters
format
required
string
Example: format=json
header Parameters
Content-Type
required
string
Example: {{content-type}}
Responses
200
get/{efx_url}/v1/creditMonitoring/healthcheck
Request samples

OAUTH Token

/{efx_url}/oauth/token

For this path parameter, {efx_url}, use the url found in the response of a call to /users/efx-config.

A successful request to {efx_url}/oauth/token will return credentials required for other Equifax API calls.

Request
path Parameters
efx_url
required
string
Example: https://api.efx-url.com/consumer-data
Request Body schema: application/x-www-form-urlencoded
optional
scope
required
string
grant_type
required
string
api_key
required
string
client_assertion
required
string
Responses
200

The token in this response can be used to access the Equifax API

post/{efx_url}/oauth/token
Request samples
application/x-www-form-urlencoded
scope=delivery&grant_type=jwt-bearer&api_key=%7B%7Befx_api_key%7D%7D&client_assertion=%7B%7Befx_assertion%7D%7D
Response samples
application/json;charset=UTF-8
{
  • "access_token": "87e22d35-0089-4613-809b-62f248c2c978",
  • "token_type": "bearer",
  • "expires_in": 610,
  • "scope": "read write"
}