Credit Report Request and Response

Credit Report Products

The following products use the standard Credit Report request/response structure:

  • CR (Credit Report)
  • PREQUAL (Prequalification Credit Report)
  • PREAPP (Pre-Approval Credit Report)
  • PRECLOSE (Pre-Close Credit Report)
  • ACCTRVW (Account Review Credit Report)
  • REFUPD (Reference Update Credit Report)
    • Request structure follows standard Credit Report, variances exist in the response structure.
    • See REFUPD response differences below

All products use identical request and response formats. The only difference is the productCode value, which determines:

  • How the inquiry is reported to the consumer
  • The permissible purpose associated with the request
  • Compliance requirements for your use case

Request Structure

Endpoint: POST /InnovisGateway/orest/grs_v001/request Minimum Required Fields for Credit Report Products:

{
  "customerId": "string",
  "customerTraceNumber": "string",
  "endUserCode": "string",
  "productCode": "string",
  "permissiblePurposeCode": "string",
  "softwareProviderId": "string",
  "applicants": [
    {
      "applicantId": "string",
      "names": [
        {
          "first": "string",
          "last": "string"
        }
      ],
      "ssn": "string",
      "dob": "YYYY-MM-DD",
      "phones": [
        {
          "phoneNumber": "string"
        }
      ],
      "emailAddress": "string",
      "ipAddress": "string",
      "addresses": [
        {
          "addressIdentifier": "string",
          "line1": "string",
          "city": "string",
          "state": "string",
          "zip": "string"
        }
      ]
    }
  ]
}

Field Definitions - Credit Report Request

Field NameTypeLengthRequiredDescription
customerIdAN16YesYour House Number Customer ID assigned by Innovis
customerTraceNumberAN30YesYour unique transaction identifier for tracking and troubleshooting
endUserCodeAN16YesEnd User Code for the customer on whose behalf you are requesting the report
productCodeAN10YesCode specifying the Innovis product being requested. ex. CR
permissiblePurposeCodeAN2YesFCRA permissible purpose code (see Appendix)
softwareProviderIdAN4YesYour software/company identifier
applicants[]Array-YesArray of applicant objects (typically 1-2 for joint applications)
applicants[].applicantIdAN2YesUnique identifier for this applicant within your system
applicants[].names[]Array-YesArray of name objects
applicants[].names[].firstAN30YesFirst name
applicants[].names[].middleAN30NoMiddle name or initial
applicants[].names[].lastAN30YesLast name
applicants[].names[].genAN1NoGenerational suffix (Jr, Sr, III, etc.)
applicants[].ssnN9YesSocial Security Number (9 digits, no dashes)
applicants[].dobDatedateYesDate of birth in YYYY-MM-DD format
applicants[].phones[]Array-YesArray of phone objects
applicants[].phones[].phoneNumberN10Yes10-digit phone number (no formatting)
applicants[].phones[].phoneTypeAN4NoPhone type (HOME, MOBL, WORK)
applicants[].emailAddressAN80YesEmail address
applicants[].ipAddressAN45YesIP address of the consumer's device
applicants[].addresses[]Array-YesArray of address objects
applicants[].addresses[].addressIdentifierAN1YesAddress type (C, P)
applicants[].addresses[].line1AN40YesStreet address line 1
applicants[].addresses[].line2AN40NoStreet address line 2 (apt, unit, etc.)
applicants[].addresses[].cityAN30YesCity name
applicants[].addresses[].stateAN2YesTwo-letter state code (see Appendix B)
applicants[].addresses[].zipAN5YesZIP code (5 or 9 digits)
applicants[].addresses[].zip4AN4NoZIP+4 extension

Example Credit Report Request

{
  "customerId": "1234567890",
  "customerTraceNumber": "TXN-2026-0001-ABC123",
  "endUserCode": "9876543210",
  "productCode": "CR",
  "permissiblePurposeCode": "17",
  "softwareProviderId": "TEST",
  "applicants": [
    {
      "applicantId": "1A",
      "names": [
        {
          "first": "John",
          "middle": "Michael",
          "last": "Smith"
        }
      ],
      "ssn": "900991234",
      "dob": "1985-06-15",
      "phones": [
        {
          "phoneNumber": "5551234567",
          "phoneType": "MOBL"
        }
      ],
      "emailAddress": "[email protected]",
      "ipAddress": "192.168.1.100",
      "addresses": [
        {
          "addressIdentifier": "C",
          "line1": "123 Main Street",
          "line2": "Apt 4B",
          "city": "Springfield",
          "state": "VA",
          "zip": "22150"
        }
      ]
    }
  ]
}

Response Structure

A successful Credit Report response includes:

  • returnCode: Status code indicating success or error
  • reportReferenceNumber: Unique Innovis report identifier (STORE THIS for SECONDUSE requests)
  • applicants[]: Array containing consumer data
    • consumerId: Unique Innovis consumer identifier (STORE THIS for SECONDUSE requests)
    • consumer: Complete consumer credit report data including:
      • Personal information
      • Credit accounts (tradelines)

Critical Fields to Store

IMPORTANT: You must store these values from the Credit Report response for potential SECONDUSE requests:

  • reportReferenceNumber (top-level field)
  • applicants[].consumerId (for each applicant)
  • Original inquiry date/time (when you made the request)

Example Credit Report Response (Abbreviated)

{
  "returnCode": "Record",
  "reportReferenceNumber": "INNV-2026-001234567",
  "applicants": [
    {
      "consumerId": "9876543210",
      "consumer": {
        "names": [
          {
            "first": "JOHN",
            "middle": "MICHAEL",
            "last": "SMITH"
          }
        ],
        "ssn": "900991234",
        "dob": "1985-06-15",
        "addresses": [
          {
            "line1": "123 MAIN STREET",
            "line2": "APT 4B",
            "city": "SPRINGFIELD",
            "state": "VA",
            "zip": "22150"
          }
        ],
        "accounts": [
          {
            "contributor": "ABC BANK",
            "accountNumber": "****1234",
            "type": "15",
            "opened": "2020-01-15",
            "balance": "5000",
            "creditLimit": "10000",
            "statusCode": "11"
          }
        ]
      }
    }
  ]
}

Key Difference on Response Structure for REFUPD

In addition to the information returned on a standard Credit Report Response, the REFUPD product will return data about the consumer’s identification information reported on each account. These are the additional fields returned. See the Appendix for details.

Fields are located under the Account Cross Reference section:

  • consumerNameRefId
  • consumerAddressRefId
  • consumerSsnRefId
  • consumerDOBRefId
  • consumerPhoneNbrRefId
  • relatedAddressRefId

Example Credit Report Response for REFUPD (Abbreviated)

"names" : [ {
      "first" : "JOHN",
      "last" : "SMITH",
      "firstReportedDate" : "2025-04-13",
      "totalOccurrences" : 2,
      "activeOccurrences" : 2,
      "refId" : 2
        ],
        "accounts": [
          {
            "contributor": "ABC BANK",
            "accountNumber": "****1234",
            "type": "15",
            "opened": "2020-01-15",
            "balance": "5000",
            "creditLimit": "10000",
            "statusCode": "11"
         "accountCrossReference" : {
        "consumerNameRefId" : 2,
        "consumerAddressRefId" : 1,
        "consumerSsnRefId" : 1,
        "consumerDOBRefId" : 1,
        "consumerPhoneNbrRefId" : 0,
        "relatedAddressRefId" : 0
      },
     ]