Data Structure Summary
Note: You can mouse over the top right corner to copy the text in the Request and Response tabs.
ReportRequest {
endUserCode: String, /* maxLength 16 */
endUser: String, /* maxLength 30 */
softwareProviderId: String, /* maxLength 4 */
customerTraceNumber: String, /* maxLength 30 */
reportReferenceNumber: String,
productCode: String, /* maxLength 10 */
accessMethod: String, /* maxLength 2 */
permissiblePurposeCode: String, /* maxLength 2 */
originalInquiryDate: Date,
customerId: String, /* maxLength 16 */
applicants: Applicant[],
}
Applicant {
consumerAccessCode: String, /* maxLength 10 */
ssn: String, /* maxLength 9 */
dob: Date,
emailAddress: String, /* maxLength 80 */
consumerId: String, /* maxLength 16 */
applicantId: String, /* maxLength 2 */
names: Name[],
addresses: Address[],
phones: Phone[],
ipAddress: String
}
Name {
first: String, /* maxLength 30 */
middle: String, /* maxLength 30 */
last: String, /* maxLength 30 */
gen: String /* maxLength 1 */
}
Address {
addressIdentifier: String, /* maxLength 2 */
line1: String, /* maxLength 40 */
line2: String, /* maxLength 40 */
city: String, /* maxLength 30 */
state: String, /* maxLength 2 */
zip: String, /* maxLength 5 */
zip4: String /* maxLength 4 */
}
Phone {
phoneNumber: String, /* maxLength 10 */
phoneType: String /* maxLength 4 */
}
ReportResponse {
consumers: ConsumerReport[],
}
ConsumerReport {
names: ConsumerName[],
addresses: ConsumerAddress[],
ssns: ConsumerSsn[],
datesOfBirth: ConsumerDateOfBirth[],
phoneNumbers: ConsumerPhoneNumber[],
accounts: Account[],
statements: ConsumerStatement[],
messages: Message[],
directories: Directory[],
softwareProviderId: String,
softwareProviderVersion: String,
customerTraceNumber: String,
userId: String,
reportReferenceNumber: String,
productCode: String,
customerId: String,
applicantId: String,
consumerId: String,
returnCode: String,
returnReasonCode: String,
returnReasonDesc: String,
accessMethod: String,
}
ConsumerName {
first: String, /* maxLength 30 */
middle: String, /* maxLength 30 */
secondarySurname: String, /* maxLength 30 */
last: String, /* maxLength 30 */
generationCode: String, /* maxLength 1 */
firstReportedDate: Date,
lastReportedDate: Date,
totalOccurrences: Number, /* maxLength 3 */
activeOccurrences: Number, /* maxLength 3 */
refId: Number /* maxLength 3 */
}
ConsumerAddress {
addressSource: String, /* maxLength 1 */
countyCode: String, /* maxLength 8 */
countyCodeDesc: String, /* maxLength 30 */
countryCode: String, /* maxLength 2 */
street: String, /* maxLength 40 */
line2: String, /* maxLength 40 */
city: String, /* maxLength 30 */
state: String, /* maxLength 2 */
zip: String, /* maxLength 5 */
zip4: String, /* maxLength 4 */
firstReportedDate: Date,
lastReportedDate: Date,
totalOccurrences: Number, /* maxLength 3 */
activeOccurrences: Number, /* maxLength 3 */
refId: Number, /* maxLength 3 */
parsedAddress: ParsedAddress
}
ParsedAddress {
streetPreDirCode: String, /* maxLength 5 */
streetNumber: String, /* maxLength 10 */
streetName: String, /* maxLength 30 */
streetType: String, /* maxLength 10 */
streetPostDirCode: String, /* maxLength 5 */
unitType: String, /* maxLength 10 */
unitNumber: String, /* maxLength 10 */
poBox: String, /* maxLength 10 */
ruralRoute: String, /* maxLength 10 */
ruralRouteBox: String, /* maxLength 10 */
privateMailBox: String, /* maxLength 14 */
urbanization: String /* maxLength 65 */
}
ConsumerPhoneNumber {
phoneSource: String, /* maxLength 1 */
phone: String, /* maxLength 10 */
phoneExt: String, /* maxLength 6 */
phoneType: String, /* maxLength 4 */
phoneStatus: String, /* maxLength 4 */
firstReportedDate: Date,
lastReportedDate: Date,
totalOccurrences: Number, /* maxLength 3 */
activeOccurrences: Number, /* maxLength 3 */
refId: Number /* maxLength 3 */
}
ConsumerDateOfBirth {
dob: Date,
firstReportedDate: Date,
lastReportedDate: Date,
totalOccurrences: Number, /* maxLength 3 */
activeOccurrences: Number, /* maxLength 3 */
refId: Number /* maxLength 3 */
}
ConsumerSsn {
ssn: String, /* maxLength 9 */
firstReportedDate: Date,
lastReportedDate: Date,
totalOccurrences: Number, /* maxLength 3 */
activeOccurrences: Number, /* maxLength 3 */
refId: Number /* maxLength 3 */
}
ConsumerStatement {
contributorIdNumber: String, /* maxLength 9 */
contributorName: String, /* maxLength 30 */
date: Date,
type: String, /* maxLength 8 */
subCode: String, /* maxLength 4 */
subCodeDesc: String, /* maxLength 30 */
statement: String, /* maxLength 1000 */
refId: Number /* maxLength 3 */
}
Account {
contributorId: String, /* maxLength 9 */
contributor: String, /* maxLength 30 */
kob: String, /* maxLength 2 */
kobDesc: String, /* maxLength 30 */
coreId: String, /* maxLength 9 */
coreName: String, /* maxLength 30 */
accountNumber: String, /* maxLength 30 */
type: String, /* maxLength 2 */
typeDesc: String, /* maxLength 30 */
portfolioType: String, /* maxLength 1 */
ecoaCode: String, /* maxLength 1 */
termsFreqCode: String, /* maxLength 1 */
termsDuration: String, /* maxLength 3 */
statusCode: String, /* maxLength 2 */
statusCodeDesc: String, /* maxLength 30 */
paymentGrid1: String, /* maxLength 24 */
paymentGrid2: String, /* maxLength 57 */
commentCode: String, /* maxLength 2 */
commentCodeDesc: String, /* maxLength 30 */
complianceCode: String, /* maxLength 2 */
complianceCodeDesc: String, /* maxLength 60 */
consumerInfoInd: String, /* maxLength 2 */
consumerInfoIndDesc: String, /* maxLength 30 */
opened: Date,
reported: Date,
accountInfo: Date,
lastPayment: Date,
closed: Date,
creditLimit: Number, /* maxLength 9 */
highCreditOrig: Number, /* maxLength 9 */
origChargeOff: Number, /* maxLength 9 */
balance: Number, /* maxLength 9 */
schedPayment: Number, /* maxLength 9 */
actualPayment: Number, /* maxLength 9 */
pastDue: Number, /* maxLength 9 */
balloonPayment: Number, /* maxLength 9 */
balloonDue: Date,
deferredLoanStart: Date,
origCreditor: String, /* maxLength 30 */
origCreditorIndustryCode: String, /* maxLength 2 */
origCreditorIndustryDesc: String, /* maxLength 30 */
portfolioInd: Number, /* maxLength 1 */
portfolioIndDesc: String, /* maxLength 30 */
portfolioPurchSoldTo: String, /* maxLength 30 */
agencyIdentifier: String, /* maxLength 2 */
agencyIdentifierDesc: String, /* maxLength 30 */
mortgageAccount: String, /* maxLength 30 */
mortgageInfoNumber: String, /* maxLength 30 */
interestTypeIndicator: String, /* maxLength 1 */
disputeInd: String, /* maxLength 4 */
disputeIndDesc: String, /* maxLength 60 */
accountCrossReference: AccountCrossReference,
refId: Number, /* maxLength 3 */
}
AccountCrossReference {
consumerNameRefId: Number, /* maxLength 3 */
consumerAddressRefId: Number, /* maxLength 3 */
consumerSsnRefId: Number, /* maxLength 3 */
consumerDOBRefId: Number, /* maxLength 3 */
consumerPhoneNbrRefId: Number, /* maxLength 3 */
relatedAddressRefId: Number /* maxLength 3 */
}
Directory {
idNumber: String, /* maxLength 9 */
name: String, /* maxLength 50 */
address: String, /* maxLength 40 */
city: String, /* maxLength 30 */
state: String, /* maxLength 2 */
zip: String, /* maxLength 5 */
zip4: String, /* maxLength 4 */
phone: String, /* maxLength 10 */
ext: String, /* maxLength 6 */
fax: String, /* maxLength 10 */
email: String /* maxLength 80 */
}
Message {
type: String, /* maxLength 8 */
subType: String, /* maxLength 8 */
refId: Number, /* maxLength 3 */
msgNumber: Number, /* maxLength 6 */
desc: String /* maxLength 1000 */
}Updated 17 days ago