Equifax

REST API for Equifax Data

[Step 1]: Equifax Credit Report Request

post/equifax/credit-report/{option}
  • This endpoint returns a JSON credit report based on the provided config value for the identity submitted in the request body.
  • The "config" string to be used in the URL is demonstrated in your Postman Collection.
  • Save the response header value, "RequestID". This value can be used to order the PDF version of the report when using the following endpoint in Step 2.
This is a dynamic REST API endpoint. The HTTP response body returned is subject to change based on the customer's unique order configuration or due to API changes made by our data providers
SecurityAuthorization Token
Request
path Parameters
option
required
string
Request Body schema: application/json
firstName
required
string (First Name) [ 0 .. 15 ] characters
middleName
string (Middle Name) [ 0 .. 15 ] characters
lastName
required
string (Last Name) [ 0 .. 25 ] characters
suffix
string (Generational Suffic) [ 0 .. 2 ] characters
age
string (Age) [ 0 .. 2 ] characters
dob
string <date> (Date of Birth)
ssn
string (ssn) [ 0 .. 9 ] characters
phone
string (Phone Number) [ 0 .. 10 ] characters
houseNumber
string (House Number) [ 0 .. 10 ] characters
quadrant
string (Quadrant) [ 0 .. 2 ] characters
streetName
string (Street Name) [ 0 .. 26 ] characters
streetType
string (Street Type)
apartmentNumber
string (Apartment Number) [ 0 .. 5 ] characters
city
required
string (City) [ 0 .. 20 ] characters
state
required
string (State) [ 0 .. 2 ] characters
zip
string (Zip Code) [ 0 .. 9 ] characters
occupation
string (Employment Occupation) [ 0 .. 35 ] characters
employerName
string (Employer Name) [ 0 .. 35 ] characters
Responses
200

Successful Get Report Response

Request samples
application/json

Success

{
}
Response samples
application/json
{
}

[Step 2]: Equifax PDF Credit Report Retrieve

post/equifax/custom-credit-report/{requestId}/{option}

This endpoint orders a PDF credit report based on the config value and RequestID value provided in the URL.

This is a dynamic REST API endpoint. The HTTP response body returned is subject to change based on the customer's unique order configuration or due to API changes made by our data providers

SecurityAuthorization Token
Request
path Parameters
requestId
required
string
option
required
string
Responses
200

OK

Request samples