Skip to content
API Documentation

pullCreditReport

Mutation

Pull a credit report from various credit bureaus. The credit report will be in a normalized common format.

Available sources:

  • SPINWHEEL: Requires reqOrgContactId and completed user verification
  • CRS_TRANSUNION: Requires firstName, lastName, addressLine1, city, state, zip (ssn, dob optional)
  • CRS_EQUIFAX: Requires firstName, lastName, ssn, city, state, addressLine1 (dob, zip optional)
  • ARRAY_EQUIFAX: Requires firstName, lastName, ssn, dob, addressLine1, city, state, zip
  • ARRAY_EQUIFAX_KBA: Requires userVerificationId from KBA verification
  • CRS_STANDARD_PREQUAL_VANTAGE4_TU: Requires firstName, lastName, ssn, addressLine1, city, state, zip

Mutation Signature

mutation {
  pullCreditReport(input: PullCreditReportInput!): PullCreditReportResponse!
}

Example Request

mutation PullCreditReport($input: PullCreditReportInput!) {
  pullCreditReport(input: $input) {
    # Add fields you want to retrieve
  }
}

Example Variables:

{
  "input": {
    "creditReportSource": "CRS_TRANSUNION",
    "reqOrgContactId": "userB",
    "firstName": "TAMMY",
    "middleName": "JO",
    "lastName": "KERR",
    "addressLine1": "1511 W KIRBY AVE",
    "city": "CHAMPAIGN",
    "state": "IL",
    "zip": "618215541"
  }
}

Example Response

{
  "data": {
    "pullCreditReport": {
      "data": {
        "creditReportId": "019c3042-f0d7-7f9d-8c02-02090ab253bd",
        "reqOrgContactId": "userB",
        "leadId": null,
        "applicantResidenceState": "IL",
        "source": "CRS_TRANSUNION",
        "reportStatus": "COMPLETED",
        "debts": [
          {
            "id": "5d51dced-45a6-4960-bf4c-0cab134034cd",
            "creditorId": "24501883",
            "externalDebtId": null,
            "applicantState": "IL",
            "ecoaCode": "I",
            "creditorName": "MACYS/GEMB",
            "creditorType": "DEPARTMENT_VARIETY_AND_OTHER_RETAIL",
            "accountType": "CHARGE_ACCOUNT",
            "portfolioType": "REVOLVING",
            "debtType": null,
            "currentBalance": 0,
            "openDate": "2020-05-05T00:00:00.000+00:00",
            "lastPaymentDate": "2024-11-16",
            "hasLastPayment": true
          },
          {
            "id": "642fc6bc-4e78-4b80-b3db-b7fbe1ef39ac",
            "creditorId": "25947714",
            "externalDebtId": null,
            "applicantState": "IL",
            "ecoaCode": "I",
            "creditorName": "DISCOVERCARD",
            "creditorType": "BANKS",
            "accountType": "CREDIT_CARD",
            "portfolioType": "REVOLVING",
            "debtType": null,
            "currentBalance": 0,
            "openDate": "2013-07-31T00:00:00.000+00:00",
            "lastPaymentDate": "2023-07-01",
            "hasLastPayment": true
          }
        ]
      },
      "errors": null
    }
  }
}

Arguments

ArgumentTypeDescription
inputPullCreditReportInput!Input containing the credit report source and applicant details

Input Types

PullCreditReportInput

Input for Pulling Credit Report

Required Fields:

FieldTypeDescription
creditReportSourceCREDIT_REPORT_PULL_SOURCE!Credit Report Source to specify where to pull the credit report from. Possible values are: - SPINWHEEL - CRS_TRANSUNION - CRS_EQUIFAX - ARRAY_EQUIFAX - ARRAY_EQUIFAX_KBA - CRS_STANDARD_PREQUAL_VANT…
reqOrgContactIdString!Requesting organization contact ID

Optional Fields:

FieldTypeDescription
leadIdStringSigma lead ID (optional)
firstNameStringContact first name *** REQUIRED when creditReportSource is: - ARRAY_EQUIFAX - CRS_TRANSUNION - CRS_EQUIFAX - CRS_STANDARD_PREQUAL_VANTAGE4_TU
middleNameStringContact middle name *** OPTIONAL when creditReportSource is: - CRS_TRANSUNION - CRS_EQUIFAX - CRS_STANDARD_PREQUAL_VANTAGE4_TU
lastNameStringContact last name *** REQUIRED when creditReportSource is: - ARRAY_EQUIFAX - CRS_TRANSUNION - CRS_EQUIFAX - CRS_STANDARD_PREQUAL_VANTAGE4_TU
suffixStringContact name suffix (e.g., Jr., Sr., II, III) *** OPTIONAL when creditReportSource is: - CRS_TRANSUNION - CRS_EQUIFAX - CRS_STANDARD_PREQUAL_VANTAGE4_TU
ssnStringContact social security number *** REQUIRED when creditReportSource is: - ARRAY_EQUIFAX - CRS_EQUIFAX - CRS_STANDARD_PREQUAL_VANTAGE4_TU
dobStringContact date of birth in yyyy-mm-dd format 1990-04-12 *** REQUIRED when creditReportSource is: - ARRAY_EQUIFAX - CRS_EQUIFAX - CRS_STANDARD_PREQUAL_VANTAGE4_TU
addressLine1StringContact address line 1 *** REQUIRED when creditReportSource is: - ARRAY_EQUIFAX - CRS_TRANSUNION - CRS_EQUIFAX - CRS_STANDARD_PREQUAL_VANTAGE4_TU
addressLine2StringContact address line 2 *** OPTIONAL when creditReportSource is: - ARRAY_EQUIFAX - CRS_EQUIFAX - CRS_STANDARD_PREQUAL_VANTAGE4_TU
cityStringContact address city *** REQUIRED when creditReportSource is: - ARRAY_EQUIFAX - CRS_TRANSUNION - CRS_EQUIFAX - CRS_STANDARD_PREQUAL_VANTAGE4_TU
stateStringContact address state *** REQUIRED when creditReportSource is: - ARRAY_EQUIFAX - CRS_TRANSUNION - CRS_EQUIFAX - CRS_STANDARD_PREQUAL_VANTAGE4_TU
zipStringContact address zip code *** REQUIRED when creditReportSource is: - ARRAY_EQUIFAX - CRS_TRANSUNION - CRS_STANDARD_PREQUAL_VANTAGE4_TU
userVerificationIdStringUser verification id *** REQUIRED when creditReportSource is ARRAY_EQUIFAX_KBA

Response Type

Returns: PullCreditReportResponse!

PullCreditReportResponse

Pull Credit Report Response

FieldTypeDescription
dataPullCreditReportResponseResultSuccess message
errors[PullCreditReportResponseResponseError]List of error messages

PullCreditReportResponseResult

Pull Credit Report Response Result

FieldTypeDescription
creditReportIdString!Credit report ID
reqOrgContactIdStringRequesting organization contact ID
leadIdStringSigma lead ID
applicantResidenceStateStringState where customer resides
publicRecords[PublicRecord]Public records
sourceString!Credit Report Source
reportStatusString!Current status of the credit report: PENDING, IN_PROGRESS, COMPLETED, FAILED
fileStatusString!IN_PROGRESS, COMPLETED
debts[CreditReportDebt]List of debts on the credit report
PublicRecord

Public Record

FieldTypeDescription
bankruptcyCodeString!Bankruptcy code
bankruptcyDateFiledStringBankruptcy date filed
bankruptcyDispositionTypeStringBankruptcy disposition type
CreditReportDebt

Credit Report Debt

FieldTypeDescription
idID!Debt ID
creditorIdStringcreditor ID
externalDebtIdStringThis is replaced by accountNumber @deprecated Use accountNumber instead
accountNumberStringOriginal credit report account number
applicantStateStringApplicants state of residence.
ecoaCodeStringECOA code
creditorNameStringCreditor name from credit report
parentCreditorNameStringParent creditor name
parentCreditorIdStringParent creditor ID
originalCreditorNameStringOriginal creditor name from credit report
creditorTypeStringCreditor type
accountTypeStringAccount type
portfolioTypeStringPortfolio type
debtTypeStringDebt type
currentBalanceFloatCurrent debt balance
openDateStringDate the debt was opened
lastPaymentDateStringDate of last payment
hasLastPaymentBooleanTrue if the most recent payment has been made as of the date this credit report was pulled
narrativeCodes[String]Narrative codes that might include bankruptcy codes
bankruptcyDateFiledStringBankruptcy date filed
applicantIdStringApplicant Id
coApplicantIdStringCoApplicant Id
originalBalanceFloatOriginal debt balance
isCollectionBooleanFlag to show if the debt is in collection
delinquencyStringaccount rating /delinquency value
monthlyPaymentFloatMonthly payment
forthDebtTypeIdStringForth Debt Type ID
remarks[String]Remarks

PullCreditReportResponseResponseError

Pull Credit Report Response Response Error

FieldTypeDescription
messageStringError message

Additional Enums

CREDIT_REPORT_PULL_SOURCE

Credit report pull sources for the pullCreditReport mutation

ValueDescription
SPINWHEELProduct: EquifaxVantageScore3.0 | Data Provider: Spinwheel
CRS_TRANSUNIONProduct: basic/tu-prequal-vantage4 | Data Provider: CRS
CRS_EQUIFAXProduct: efx-prequal-vantage4 | Data Provider: CRS
ARRAY_EQUIFAXProduct: efx1bReportScore | Data Provider: Array
ARRAY_EQUIFAX_KBAProduct: efx1bReportScore | Data Provider: Array
CRS_STANDARD_PREQUAL_VANTAGE4_TUProduct: standard/tu-prequal-vantage4 | Data Provider: CRS

Error Types

The response may include the following error types:

PullCreditReportResponseResponseError

Pull Credit Report Response Response Error

FieldTypeDescription
messageStringError message

Common Errors

Error CodeDescriptionResolution
VALIDATION_ERRORInput validation failedCheck required fields and formats
UNAUTHORIZEDInvalid or expired tokenRe-authenticate and retry
NOT_FOUNDResource not foundVerify the ID or reference