Getting Started

The iSoftpull API provides access to read credit report data and allows you to run intelligences. To use any of the APIs, you need to create a Key/Token pair from the API Credentials tab. The API Token is highly sensitive information. Handle it carefully and ensure that anyone else does not get access to the token.

Making a Request

API Key ID/Token

Two header fields are required in the request.

• The value of the api-key field must be set to the API Key ID
• The value of the api-secret field must be set to the API Secret Access Token
  

Postman Collection

You can test the API using our Postman collection: https://www.getpostman.com/collections/ae610924d2f2d963c589

• Download the Postman App or use the Postman Web Version
• Click on the Import button, click on the Link tab, paste the collection link and click on Continue
• After importing the collection, you can use any one of the three test applicants
• Fill in the correct values for api-key and api-secret in the headers tab and click on Send
  

Applicant Details

The applicant details should be provided in the body of the request

Test Applicants

Sample Responses

If all the applicant details are filled out, the API response will contain the reports data and/or the intelligence data depending on the configuration selected when creating the API.

The reports data will contain the status, message and report link for each bureau. The report link will only be included if the report generation was successful.

The intelligence data will contain the result (either "passed" or "no offers matched") and the intelligence name. The intelligence name will only be included if the intelligence result value was "passed".

                
{
  "reports":{
    “link”:”https://app.isoftpull.com/client/applicants/view_only/123/soft_pull”,
    "equifax":{
      "status":"failure",
      "message":"Service Unavailable.",
      "failure_type":"error"
    },
    "transunion":{
      "status":"success",
      "message":"Transunion credit report generation succeeded.",
      "link":"https://app.isoftpull.com/client/reports/view_only/9751af23-7022-700efe"
    }
  },
  "intelligence":{
    "result":"passed",
    "name":"Loan Silver"
  }
}

                
                

Error Handling

                
{
    "status": "failure",
    "message": "Last name can't be blank",
}
                
                

The reports data will contain the status, message and report link for each bureau. If the report fails, it will also contain the field failure_type

The failure type could be error, no-hit or freeze.

The failure_type no-hit refers to the bureau not being able to find an applicant, error refers to a generic error, and freeze refers to the applicant's report being frozen

                
{
  "reports":{
    "equifax":{
      "status":"failure",
      "message":"Service Unavailable.",
      "failure_type":"error"

    },
    "transunion":{
      "status":"failure",
      "message":"No-hit file is returned – due to state-specific criteria — more identification information is needed",
      "failure_type":"no-hit"
    },
    "experian":{
       "status":"failure",
       "message":"25& 12-28-22 0000000 FILE FROZEN DUE TO FEDERAL LEGISLATION",
       "failure_type":"freeze"
     }
  },
  "intelligence":{
    "result":"no offers matched"
  }
}