Skip to main content

Get a credit file

Get a credit file that has been previously pulled (requested) from a bureau provider using the dealer credentials. This endpoint should be called after the Request a Credit File Endpoint (POST /applications/:applicationId/credit-file/:applicantId/request)

Path Parameters
applicationId string — REQUIRED
applicantId string — REQUIRED
Header Parameters
X-CreditApp-Retailer-ID uuid
Responses
200

Pulling credit file, poll for result

Schema — OPTIONAL
source string

Possible values: [CREDIT_APP, EQUIFAX, TRANSUNION, null]

Provider recorded for this credit file; null when provenance is unknown.

id string — OPTIONAL
signedPdfUrl string — OPTIONAL
customerNumber string — OPTIONAL
language string — OPTIONAL

Possible values: [EN, FR]

fileSinceDate date — OPTIONAL
lastActivityDate date — OPTIONAL
requestedDate date — OPTIONAL
bureau object — OPTIONAL
id string — OPTIONAL
name string — OPTIONAL
hitType string — OPTIONAL

Possible values: [NO_CREDIT_FILE_REQUESTED, HIT, NO_HIT, MANUAL_FILE, CONSUMER_DECLARATION, REFERRED_FILE, CONTACT_BUREAU_COLLECTION_DEPARTMENT, CREDIT_LOCK]

subject object — OPTIONAL
firstName string — OPTIONAL
middleName string — OPTIONAL
lastName string — OPTIONAL
suffix string — OPTIONAL
sin string — OPTIONAL
dateOfBirth date — OPTIONAL
dateOfDeath date — OPTIONAL
otherNames object[] — OPTIONAL
type string — OPTIONAL

Possible values: [ALSO_KNOWN_AS, FORMER_NAME, LEGAL_NAME_CHANGE]

firstName string — OPTIONAL
middleName string — OPTIONAL
lastName string — OPTIONAL
suffix string — OPTIONAL
addressHistory object[] — OPTIONAL
dateReported date — OPTIONAL
streetNo string — OPTIONAL
streetName string — OPTIONAL
city string — OPTIONAL
province string — OPTIONAL

Possible values: [AB, BC, MB, NB, NL, NS, NT, NU, ON, PE, QC, SK, YT]

postalCode string — OPTIONAL
employmentHistory object[] — OPTIONAL
dateEmployed date — OPTIONAL
dateLeft date — OPTIONAL
employerName string — OPTIONAL
occupation string — OPTIONAL
city string — OPTIONAL
province string — OPTIONAL

Possible values: [AB, BC, MB, NB, NL, NS, NT, NU, ON, PE, QC, SK, YT]

monthlyIncome number — OPTIONAL
bankruptcies object[] — OPTIONAL
dateFiled date — OPTIONAL
court object — OPTIONAL
id string — OPTIONAL
name string — OPTIONAL
caseNumber string — OPTIONAL
type string — OPTIONAL

Possible values: [INDIVIDUAL, BUSINESS]

filer string — OPTIONAL

Possible values: [SUBJECT, JOINT]

disposition object — OPTIONAL
type string — OPTIONAL

Possible values: [DISCHARGED, UNDISCHARGED, VOLUNTARY_DEPOSIT, VOLUNTARY_DEPOSIT_CLOSED, BANKRUPTCY_RECEIVING_ORDER, BANKRUPTCY_ASSIGNMENT, PROPOSAL_TO_CREDITORS, DEBTOR_ASSISTANCE_POOL_ACT, INVOLUNTARY, PROPOSAL_UNDER_BANKRUPTCY_ACT_PAID, DEBTOR_ASSISTANCE_POOL_ACT_PAID, COURT_CONSOLIDATIONS_PAID, COURT_CONSOLIDATIONS, ORDERLY_PAYMENT_OF_DEBT, ORDERLY_PAYMENT_OF_DEBT_DEFAULT, ORDERLY_PAYMENT_OF_DEBT_PAID, ORDERLY_PAYMENT_OF_DEBT_SETTLED, VOLUNTARY, CONSUMER_DEBT_COUNSELING, CONSUMER_DEBT_COUNSELING_CLOSED]

date date — OPTIONAL
liabilityAmount number — OPTIONAL
assetAmount number — OPTIONAL
narratives string[] — OPTIONAL

Possible values: [ABSOLUTE_DISCHARGE, ASSIGNMENT, SUMMARY_ASSIGNMENT, PROPOSAL, DISPOSITION_UNKNOWN, DEFAULTED_PAYMENT_DEEMED_ANNULMENT, NOTICE_OF_INTENTION]

collections object[] — OPTIONAL
type string — OPTIONAL

Possible values: [PAID, UNPAID]

assignedDate date — OPTIONAL
agency object — OPTIONAL
id string — OPTIONAL
name string — OPTIONAL
agencyAccountNumber string — OPTIONAL
creditor object — OPTIONAL
accountNumberAndOrName string — OPTIONAL
industry string — OPTIONAL
reason string — OPTIONAL

Possible values: [CHECKED, OTHER, PAID, SETTLED, UNKNOWN]

originalAmount number — OPTIONAL
balanceAmount number — OPTIONAL
dateOfLastPayment date — OPTIONAL
datePaid date — OPTIONAL
narratives string[] — OPTIONAL

Possible values: [INCLUDED_IN_BANKRUPTCY, INCLUDED_IN_OPD, SUBJECT_DISPUTES_THIS_ACCOUNT, SETTLEMENT_MADE, INCLUDED_IN_VOLUNTARY_DEPOSIT, CREDIT_COUNSELING, INCLUDED_IN_CONSUMER_PROPOSAL, INCLUDED_IN_CO_APPLICANTS_BANKRUPTCY, CHILD_OR_FAMILY_SUPPORT_OBLIGATION]

legalItems object[] — OPTIONAL
type string — OPTIONAL

Possible values: [UNSETTLED_JUDGMENT, SATISFIED_JUDGMENT]

dateFiled date — OPTIONAL
court object — OPTIONAL
id string — OPTIONAL
name string — OPTIONAL
caseNumber string — OPTIONAL
status string — OPTIONAL

Possible values: [DISMISSED, SATISFIED, SETTLED]

dateSatisfied date — OPTIONAL
amount number — OPTIONAL
defendant string — OPTIONAL
plaintiff string — OPTIONAL
lawyerNameAddress string — OPTIONAL
narratives string[] — OPTIONAL

Possible values: [INCLUDED_IN_BANKRUPTCY, INCLUDED_IN_OPD, SETTLEMENT_MADE, DISPOSITION_UNKNOWN, CREDIT_COUNSELING, INCLUDED_IN_CONSUMER_PROPOSAL, INCLUDED_IN_CO_APPLICANTS_BANKRUPTCY]

securedLoans object[] — OPTIONAL
dateFiled date — OPTIONAL
court object — OPTIONAL
id string — OPTIONAL
name string — OPTIONAL
creditor object — OPTIONAL
nameAddressAndAmount string — OPTIONAL
industry string — OPTIONAL
maturityDate date — OPTIONAL
narratives string[] — OPTIONAL

Possible values: [INCLUDED_IN_BANKRUPTCY, MORTGAGE, SECURITY_DISPOSITION_UNKNOWN, SECURITY_DISCHARGED]

trades object[] — OPTIONAL
dateReported date — OPTIONAL
creditor object — OPTIONAL
id string — OPTIONAL
name string — OPTIONAL
phoneNumber string — OPTIONAL
accountNumber string — OPTIONAL
association string — OPTIONAL

Possible values: [INDIVIDUAL, JOINT, UNDESIGNATED, HAS_CO_SIGNER, IS_CO_SIGNER, TERMINATED]

highCreditAmount number — OPTIONAL
paymentTermAmount number — OPTIONAL
balanceAmount number — OPTIONAL
pastDueAmount number — OPTIONAL
monthsReviewed number — OPTIONAL
dateOpened date — OPTIONAL
dateLastActivityOrPayment date — OPTIONAL
portfolioType string — OPTIONAL

Possible values: [REVOLVING_OR_OPTION, INSTALMENT, OPEN_ACCOUNT, LEASE_ACCOUNT, LINE_OF_CREDIT, MORTGAGE]

paymentRate string — OPTIONAL

Possible values: [TOO_NEW_TO_RATE, PAID_AS_AGREED_AND_UP_TO_DATE, NOT_MORE_THAN_ONE_PAYMENT_PAST_DUE, NOT_MORE_THAN_TWO_PAYMENTS_PAST_DUE, THREE_OR_MORE_PAYMENTS_PAST_DUE, AT_LEAST_120_DAYS_OVERDUE_BUT_NOT_RATED_9, MAKING_REGULAR_PAYMENTS_UNDER_CONSOLIDATION_ORDER, REPOSSESSION, BAD_DEBT_PLACED_FOR_COLLECTION]

status string — OPTIONAL

Possible values: [ACCOUNT_IS_INACTIVE, LOST_OR_STOLEN_CARD, CONTACT_MEMBER_FOR_RATE, ADJUSTMENT_PENDING, DISPUTE_RESOLUTION_PENDING]

count30DaysPastDue number — OPTIONAL
count60DaysPastDue number — OPTIONAL
count90DaysPastDue number — OPTIONAL
previousHighPaymentRates object[] — OPTIONAL
date date — OPTIONAL
rate string — OPTIONAL

Possible values: [TOO_NEW_TO_RATE, PAID_AS_AGREED_AND_UP_TO_DATE, NOT_MORE_THAN_ONE_PAYMENT_PAST_DUE, NOT_MORE_THAN_TWO_PAYMENTS_PAST_DUE, THREE_OR_MORE_PAYMENTS_PAST_DUE, AT_LEAST_120_DAYS_OVERDUE_BUT_NOT_RATED_9, MAKING_REGULAR_PAYMENTS_UNDER_CONSOLIDATION_ORDER, REPOSSESSION, BAD_DEBT_PLACED_FOR_COLLECTION]

narratives string[] — OPTIONAL

Possible values: [BUSINESS_VENTURE_SUBJECT_LIABLE, AMOUNT_IN_PAYMENT_COLUMN_IS_ON_A_WEEKLY_BASIS, INCLUDED_IN_BANKRUPTCY, INCLUDED_IN_OPD, VOLUNTARY_REPOSSESSION, INVOLUNTARY_REPOSSESSION, AUTO_LOAN, COMMERCIAL_LOAN_ACCOUNT, ACCOUNT_ASSIGNED_TO_THIRD_PARTY_FOR_COLLECTION, HOME_IMPROVEMENT_LOAN, CLOSED_AT_CONSUMERS_REQUEST, PERSONAL_LOAN, CLOSED_BY_CREDIT_GRANTOR, SECURED_LOAN, PERSONAL_LINE_OF_CREDIT, AMOUNT_IN_HC_COLUMN_IS_CREDIT_LIMIT, NO_ACTIVITY_UPDATE_SINCE_DATE_REPORTED, SUBJECT_DISPUTES_THIS_ACCOUNT, TRANSFERRED_OR_SOLD, PAID_CREDIT_LINE_CLOSED, CREDIT_LINE_CLOSED, NOTE_LOAN, INACTIVE_ACCOUNT, SETTLEMENT_MADE, ACCOUNT_BEING_PAID_ON_REDUCED_PAYMENT, LEASE_ACCOUNT, SUBJECT_HAS_AN_ENDORSER_GUARANTOR, STUDENT_LOAN, CONDITIONAL_SALES, LOAN_WAS_PAID_OUT_BY_A_THIRD_PARTY, HAS_CO_SIGNER, IS_A_CO_SIGNER, WRITTEN_OFF, SUBJECT_IS_AN_ENDORSER_GUARANTOR, REGULAR_PAYMENTS_PRESENTLY_BEING_MADE, DEMAND_LOAN, FARM_AGRI_LOAN, INCLUDED_IN_VOLUNTARY_DEPOSIT, PAID_OUT_IN_FULL_BY_CO_SIGNER, PAYMENTS_ASSUMED_BY_THIRD_PARTY, INTERNAL_COLLECTION, CREDIT_COUNSELING, CUSTOMER_UNABLE_TO_LOCATE_CONSUMER, PROMISSORY_NOTE, DUE_TO_NSF_CHEQUES, PREPAID, ACCOUNT_PAID, MORTGAGE, BALANCE_PAID_BY_INSURANCE_COMPANY, PAYMENT_BEING_MADE_BY_INSURANCE, PAID_BY_GOVERNMENT, REFINANCED, SEMI_ANNUAL_PAYMENTS, MONTHLY_PAYMENTS, BI_WEEKLY_PAYMENTS, WEEKLY_PAYMENTS, QUARTERLY_PAYMENTS, ANNUAL_PAYMENTS, REDEEMED_REPOSSESSION, DISPUTE_RESOLUTION_PENDING, LEASE_EARLY_TERMINATION_BY_DEFAULT, RSP_LOAN, FORECLOSURE, POWER_OF_SALE, QUIT_CLAIM, FORFEIT_OF_DEED_IN_LIEU_OF_FORECLOSURE, US_DOLLAR_ACCOUNT, SUBJECT_NO_LONGER_ASSOCIATED_WITH_ACCOUNT, UPDATE_FREEZE_REQUESTED_BY_CREDIT_GRANTOR, NOT_INCLUDED_IN_BANKRUPTCY, INTEREST_PAYMENT_ONLY, SEMI_MONTHLY_PAYMENTS, BI_MONTHLY_PAYMENTS, SINGLE_PAYMENT_LOAN, DEFERRED_PAYMENT, STUDENT_LINE_OF_CREDIT, SECOND_MORTGAGE, ACCOUNT_CLOSED, MONTHS_REVIEWED_IS_GREATER_THAN_24, FORECLOSURE_PROCEEDING_STARTED, INCLUDED_IN_CONSUMER_PROPOSAL, INCLUDED_IN_CO_APPLICANTS_BANKRUPTCY, AFFECTED_BY_NATURAL_OR_DECLARED_DISASTER, CORPORATE_CREDIT_CARD, CHILD_FAMILY_SUPPORT_OBLIGATION, CONSOLIDATION_LOAN, ACTIVE_MILITARY_DUTY, A_PORTION_OF_THE_BALANCE_MAY_REVOLVE, FIXED_PAYMENT_AMOUNT, HYBRID_ACCOUNT, HOME_EQUITY, CREDIT_LINE_SUSPENDED, ACCOUNT_ASSUMED_BY_ANOTHER_PARTY, OVER_LIMIT_PAYMENT_RECEIVED, GUARANTEED_STUDENT_LOAN, INTEREST_RELIEF, INTEREST_RELIEF_PAID_BY_GOVERNMENT, UNSECURED, INSURED, UNINSURED, COLLATERAL_MORTGAGE, REAL_ESTATE_SECURED, REVERSE_MORTGAGE, RENTAL_AGREEMENT]

localInquiries object[] — OPTIONAL
date date — OPTIONAL
customer object — OPTIONAL
id string — OPTIONAL
name string — OPTIONAL
phoneNumber string — OPTIONAL
foreignInquiries object[] — OPTIONAL
date date — OPTIONAL
memberNameAndNumber string — OPTIONAL
industry string — OPTIONAL
specialServices object[] — OPTIONAL
type string — OPTIONAL

Possible values: [LOCATE, INQUIRY_ALERT, CONSUMER_INTERVIEW, ALERT_SERVICE, FILE_INCOMPLETE, LOCAL_LOCATE, CONTACT_BUREAU, LOST_OR_STOLEN_WALLET]

dateReported date — OPTIONAL
customer object — OPTIONAL
id string — OPTIONAL
name string — OPTIONAL
phoneNumber string — OPTIONAL
consumerStatements object[] — OPTIONAL
dateReported date — OPTIONAL
dateToBePurged date — OPTIONAL
statement string — OPTIONAL
scores object[] — OPTIONAL
number number — OPTIONAL
sign string — OPTIONAL
value string — OPTIONAL
narratives string[] — OPTIONAL
reasons string[] — OPTIONAL
rejectCodes string[] — OPTIONAL
400

Bad Request

Schema — OPTIONAL
status integer — OPTIONAL
message string — OPTIONAL
401

Unauthorized

Schema — OPTIONAL
status integer — OPTIONAL
404

Not Found

Schema — OPTIONAL
status integer — OPTIONAL
message string — OPTIONAL