The US Consumer Reports API provides access to comprehensive credit information for individual consumers in the United States. This service allows you to retrieve consumer credit reports, trade lines, negative information (collections, bankruptcies), and employment details.
Use the data dictionary to understand all fields available in US Consumer Reports:
| Report Type | Data Dictionary Files | View Online | Download |
|---|---|---|---|
| US Consumer Report | Standard | View Online | Download PDF |
The data dictionary provides detailed information about:
- All available fields in the response
- Field descriptions and data types
- Possible values for enumerated fields
- Nested object structures
US Consumer Reports are available through the /consumers/tryReport endpoint with two template options that determine the type and depth of information returned:
- Purpose: Pre-screening and preliminary assessments
- Credit Score: Not included
- Footprint: No inquiry left on consumer's credit file
- Use Cases:
- Pre-qualification checks
- Marketing and offer targeting
- Initial credit evaluations that don't require a full hard inquiry
Key Benefit: Does not impact the consumer's credit score or leave a record of the inquiry on their credit file.
- Purpose: Credit decisioning and formal credit applications
- Credit Score: Included in response
- Footprint: Leaves an inquiry on the consumer's credit file
- Use Cases:
- Formal credit applications (loans, mortgages, credit cards)
- Employment background checks
- Tenant screening (when credit score is required)
- Any credit decision requiring a full credit assessment
Important: This template leaves a record (footprint) on the consumer's credit file that other lenders can see. Use only when making an actual credit decision.
Specify the template using the template query parameter:
GET /v1/consumers/tryReport?countries=US&template=basic&firstName=John&lastName=Doe...Values:
basic(default) - Returns report without credit score, no footprinthardcheck- Returns report with credit score, leaves footprint
If no template is specified, basic is used by default.
To retrieve a US Consumer Report, provide:
Mandatory:
countries=US- Country codefirstName- Consumer's first namelastName- Consumer's last name
Highly Recommended (for accurate matching): At least one of the following to ensure unique consumer identification:
personNumber- Social Security Number (SSN)dateOfBirth- Date of birth (YYYY-MM-DD format)- Complete address (
street,city,postalCode,province)
Optional:
telephone- Telephone number
The response includes:
- Consumer Information - Name, date of birth, gender, consumer ID, current address
- Contact Information - Current and previous addresses with dates
- Credit Score (HardCheck only) - Current credit rating information
- Negative Information - Collections, bankruptcies, delinquencies, charge-offs, repossessions
- Trade Lines - Account history including credit cards, loans, mortgages with payment history
- Additional Information:
- Active account summaries (revolving, installment, other accounts)
- Employment information
- Inquiry history
- Search criteria used
Use the /consumers/tryReport/searchcriteria endpoint to discover available search parameters and validation rules for US consumer reports:
GET /v1/consumers/tryReport/searchcriteria?countries=USThis endpoint returns the complete list of supported search criteria fields, their types, and validation requirements.
Choose the Right Template:
- Use
basicfor pre-screening and marketing purposes - Use
hardcheckonly when making actual credit decisions
- Use
Provide Sufficient Search Criteria:
- Always include SSN or date of birth for accurate matching
- Include full address when SSN is not available
Handle Missing Data:
- Not all fields are available for every consumer
- Implement your integration to gracefully handle missing or partial data
- Check for field presence before accessing nested properties
Regulatory Compliance:
- Ensure you have proper consent before running a
hardcheckreport - Comply with the Fair Credit Reporting Act (FCRA) requirements
- Maintain records of consumer consent and permissible purpose
- Ensure you have proper consent before running a
- Basic Template:
csc_con_rep_US - HardCheck Template:
csc_con_rep_US_hardcheck
Ensure your account has the appropriate service line enabled for the template you wish to use.
- GET /consumers/tryReport - Retrieve US consumer report
- GET /consumers/tryReport/searchcriteria - Discover available search criteria
For questions about US Consumer Reports or to enable this service on your account, contact your Creditsafe account manager.