creditReports

Query

Fetch Credit Reports with various filtering and pagination options.

Query Signature

query {
  creditReports(where: CreditReportWhereInput, order: [CreditReportOrder!], skip: Int, search: String, after: String, first: Int, before: String, last: Int): CreditReportsResponse
}

Example Request

GraphQL

query CreditReports($where: CreditReportWhereInput, $order: [CreditReportOrder!], $skip: Int, $search: String, $after: String, $first: Int, $before: String, $last: Int) {
  creditReports(where: $where, order: $order, skip: $skip, search: $search, after: $after, first: $first, before: $before, last: $last) {
    # Add fields you want to retrieve
  }
}

Example Variables:

{
  "where": {
    "reqOrgContactId": "contact-12345"
  },
  "first": 10,
  "order": [
    {
      "field": "createdAt",
      "direction": "DESC"
    }
  ]
}

Apollo Studio

Open in Apollo Studio Explorer →

Click the link above to open this query in Apollo Studio Explorer with the query pre-filled. You’ll need to authenticate with your sandbox credentials.

Example Response

{
  "data": {
    "creditReports": {
      "data": {
        "totalCount": 2,
        "pageInfo": {
          "hasNextPage": false,
          "hasPreviousPage": false,
          "startCursor": "cursor-1",
          "endCursor": "cursor-2"
        },
        "edges": [
          {
            "cursor": "cursor-1",
            "node": {
              "id": "cr-abc123def456",
              "reqOrgContactId": "contact-12345",
              "leadId": "lead-67890",
              "source": "CRS_EQUIFAX",
              "reportStatus": "COMPLETED",
              "createdAt": "2025-01-15T10:30:00.000Z"
            }
          },
          {
            "cursor": "cursor-2",
            "node": {
              "id": "cr-xyz789",
              "reqOrgContactId": "contact-12345",
              "leadId": "lead-67890",
              "source": "CRS_TRANSUNION",
              "reportStatus": "COMPLETED",
              "createdAt": "2025-01-10T14:20:00.000Z"
            }
          }
        ]
      },
      "errors": null
    }
  }
}

Arguments

Argument	Type	Description
where	CreditReportWhereInput	Filter conditions for credit reports
order	[CreditReportOrder!]	Ordering options for the results

Input Types

CreditReportWhereInput

Where conditions for filtering Credit Reports.

Optional Fields:

Field	Type	Description
reqOrgContactId	String	Filter by requesting organization contact ID
source	String	Filter by credit report source (e.g., CRS_TRANSUNION, CRS_EQUIFAX, SPINWHEEL)
creditReportIds	[String!]	List of credit report IDs to filter by. Maximum of 20 IDs allowed.

CreditReportOrder

Ordering options for Credit Reports.

Required Fields:

Field	Type	Description
field	CreditReportOrderField!	Field to order by
direction	OrderDirection!	Order direction (ASC or DESC)

Response Type

Returns: CreditReportsResponse

CreditReportsResponse

CreditReportsResponse

Field	Type	Description
data	CreditReportConnection	Credit Report Connection.
errors	[CreditReportsResponseError]	Error(s) mesage list

CreditReportConnection

Pagination connection for Credit Reports.

Field	Type	Description
pageInfo	PageInfo!	Pagination information
edges	[CreditReportEdge]!	List of credit report edges
totalCount	Int!	Total number of credit reports matching the query

PageInfo

Page information for navigating collections.

Field	Type	Description
hasNextPage	Boolean!	Whether there are more results after the current page
startCursor	String	Cursor pointing to the first item in the current page
endCursor	String	Cursor pointing to the last item in the current page

CreditReportEdge

Edge type for Credit Reports.

Field	Type	Description
node	CreditReportNode	The credit report data
cursor	String!	Cursor for pagination

CreditReportNode

Credit Report Node

Field	Type	Description
id	ID!	Credit report ID
reqOrgId	String	Requesting organization ID
reqOrgContactId	String	Requesting organization contact ID
leadId	String	Sigma lead ID
applicantResidenceState	String	State where customer resides
publicRecords	[PublicRecord]	Public records
creditReportUserId	String	Credit report user ID
debts	[CreditReportDebt]	Debts as JSON data
source	String	Source of the credit report, e.g., Spinwheel, CRS Equifax, or CRS TransUnion
fileMetadata	FileMetadata	File metadata.
reportStatus	String	Current status of the credit report: PENDING, IN_PROGRESS, COMPLETED, FAILED
fileStatus	String	IN_PROGRESS, COMPLETED
createdAt	Date	Date the credit report was created
applicantFirstName	String	Applicant’s first name
applicantMiddleName	String	Applicant’s middle name
applicantLastName	String	Applicant’s last name
applicantSsn	String	Applicant’s ssn name
applicantDob	String	Applicant’s dob
applicantAlternativeNames	[AlternativeName]	Applicant’s alternative names
scores	[Score]	Credit scores from various credit evaluation models
reportRequestedAt	Date	Date the credit report was requested

PublicRecord

Public Record

Field	Type	Description
bankruptcyCode	String!	Bankruptcy code
bankruptcyDateFiled	String	Bankruptcy date filed
bankruptcyDispositionType	String	Bankruptcy disposition type

CreditReportDebt

Credit Report Debt

Field	Type	Description
id	ID!	Debt ID
creditorId	String	creditor ID
externalDebtId	String	This is replaced by accountNumber @deprecated Use accountNumber instead
accountNumber	String	Original credit report account number
applicantState	String	Applicants state of residence.
ecoaCode	String	ECOA code
creditorName	String	Creditor name from credit report
parentCreditorName	String	Parent creditor name
parentCreditorId	String	Parent creditor ID
originalCreditorName	String	Original creditor name from credit report
creditorType	String	Creditor type
accountType	String	Account type
portfolioType	String	Portfolio type
debtType	String	Debt type
currentBalance	Float	Current debt balance
openDate	String	Date the debt was opened
lastPaymentDate	String	Date of last payment
hasLastPayment	Boolean	True 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
bankruptcyDateFiled	String	Bankruptcy date filed
applicantId	String	Applicant Id
coApplicantId	String	CoApplicant Id
originalBalance	Float	Original debt balance
isCollection	Boolean	Flag to show if the debt is in collection
delinquency	String	account rating /delinquency value
monthlyPayment	Float	Monthly payment
forthDebtTypeId	String	Forth Debt Type ID
remarks	[String]	Remarks

FileMetadata

File metadata

Field	Type	Description
reqOrgContactId	String	Requesting organization contact ID
creditReportUserId	String	Credit report user ID
source	String	Credit Report Vendor source e.g. SPINWHEEL, CRS Equifax, or CRS TransUnion
uploadDate	String	ISO 8601 format date string
fileName	String	Document name
contentType	String	File type
fileSize	String	Size in bytes
type	String	Document type

AlternativeName

Alternative name associated with the applicant

Field	Type	Description
firstName	String	Alternative first name
lastName	String	Alternative last name
unparsedName	String	Full alternative name (unparsed)

Score

Credit score information from credit evaluation models

Field	Type	Description
modelName	String	The name of a risk model as provided by the repository bureaus.
sourceType	String	This element describes the source of the credit file, Equifax, Experian, Trans Union or Unspecified if the specific sources are not specified.
scoreValue	String	Numeric credit score resulting from credit evaluation model.
scoreFactors	[ScoreFactor]	Factors of the borrower’s credit which give context to the referenced credit score.

ScoreFactor

Score Factor associated with a credit score

Field	Type	Description
scoreFactorCode	String	Factors of the borrower’s credit which give context to the referenced credit score. The factor is normally a numeric code.
scoreFactorText	String	The text remarks associated with a Score Factor.

CreditReportsResponseError

CreditReportsResponse Error

Field	Type	Description
message	String	Error message

Additional Enums

CreditReportOrderField

Fields that can be ordered in Credit Reports.

Value	Description
createdAt	Order by creation date
reqOrgContactId	Order by requesting organization contact ID

OrderDirection

Direction of ordering.

Value	Description
ASC	Ascending order (A-Z, 0-9, oldest first)
DESC	Descending order (Z-A, 9-0, newest first)

Error Types

The response may include the following error types:

CreditReportsResponseError

CreditReportsResponse Error

Field	Type	Description
message	String	Error message

Manual Error Documentation

Add service-specific error codes and their resolutions below.

Common Errors

Error Code	Description	Resolution
VALIDATION_ERROR	Input validation failed	Check required fields and formats
UNAUTHORIZED	Invalid or expired token	Re-authenticate and retry
NOT_FOUND	Resource not found	Verify the ID or reference

Related

• Back to Credit Reporting