{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-connect-apis-catalog/product-catalog/Consumer&Misc/sidebars.yaml","current-catalog-info":"current-catalog-info-/connect-apis-catalog/product-catalog/consumermisc/consumerandmisc"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"US Consumer Reports","llmstxt":{"hide":true}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"us-consumer-reports","__idx":0},"children":["US Consumer Reports"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["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."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"data-dictionary","__idx":1},"children":["Data Dictionary"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use the data dictionary to understand all fields available in US Consumer Reports:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Report Type"},"children":["Report Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Data Dictionary Files"},"children":["Data Dictionary Files"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"View Online"},"children":["View Online"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Download"},"children":["Download"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["US Consumer Report"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Standard"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://doc.creditsafe.com/dataDictionaries/USA/Consumer%20Data%20Dictionary%20CSUS.pdf","target":"_blank","rel":"noopener noreferrer","title":"View this data dictionary PDF in a new tab","aria-label":"View this data dictionary PDF in a new tab"},"children":["View Online"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://doc.creditsafe.com/dataDictionaries/USA/Consumer%20Data%20Dictionary%20CSUS.pdf","download":"Consumer_Data_Dictionary_CSUS.pdf","title":"Download this data dictionary PDF","aria-label":"Download this data dictionary PDF"},"children":["Download PDF"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The data dictionary provides detailed information about:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["All available fields in the response"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Field descriptions and data types"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Possible values for enumerated fields"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Nested object structures"]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"overview","__idx":2},"children":["Overview"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["US Consumer Reports are available through the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/consumers/tryReport"]}," endpoint with two template options that determine the type and depth of information returned:"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"report-templates","__idx":3},"children":["Report Templates"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"basic-template","__idx":4},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Basic Template"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Purpose:"]}," Pre-screening and preliminary assessments"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Credit Score:"]}," Not included"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Footprint:"]}," No inquiry left on consumer's credit file"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Use Cases:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Pre-qualification checks"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Marketing and offer targeting"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Initial credit evaluations that don't require a full hard inquiry"]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Key Benefit:"]}," Does not impact the consumer's credit score or leave a record of the inquiry on their credit file."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"hardcheck-template","__idx":5},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["HardCheck Template"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Purpose:"]}," Credit decisioning and formal credit applications"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Credit Score:"]}," Included in response"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Footprint:"]}," Leaves an inquiry on the consumer's credit file"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Use Cases:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Formal credit applications (loans, mortgages, credit cards)"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Employment background checks"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Tenant screening (when credit score is required)"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Any credit decision requiring a full credit assessment"]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["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."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"selecting-a-template","__idx":6},"children":["Selecting a Template"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Specify the template using the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["template"]}," query parameter:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"GET /v1/consumers/tryReport?countries=US&template=basic&firstName=John&lastName=Doe...\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Values:"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["basic"]}," (default) - Returns report without credit score, no footprint"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["hardcheck"]}," - Returns report with credit score, leaves footprint"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If no template is specified, ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["basic"]}," is used by default."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"required-search-criteria","__idx":7},"children":["Required Search Criteria"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To retrieve a US Consumer Report, provide:"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Mandatory:"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["countries=US"]}," - Country code"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["firstName"]}," - Consumer's first name"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["lastName"]}," - Consumer's last name"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Highly Recommended (for accurate matching):"]}," ","At least one of the following to ensure unique consumer identification:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["personNumber"]}," - Social Security Number (SSN)"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["dateOfBirth"]}," - Date of birth (YYYY-MM-DD format)"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Complete address (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["street"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["city"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["postalCode"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["province"]},")"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Optional:"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["telephone"]}," - Telephone number"]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"response-structure","__idx":8},"children":["Response Structure"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The response includes:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Consumer Information"]}," - Name, date of birth, gender, consumer ID, current address"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Contact Information"]}," - Current and previous addresses with dates"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Credit Score"]}," (HardCheck only) - Current credit rating information"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Negative Information"]}," - Collections, bankruptcies, delinquencies, charge-offs, repossessions"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Trade Lines"]}," - Account history including credit cards, loans, mortgages with payment history"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Additional Information"]},":",{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Active account summaries (revolving, installment, other accounts)"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Employment information"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Inquiry history"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Search criteria used"]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"search-criteria-discovery","__idx":9},"children":["Search Criteria Discovery"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/consumers/tryReport/searchcriteria"]}," endpoint to discover available search parameters and validation rules for US consumer reports:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"GET /v1/consumers/tryReport/searchcriteria?countries=US\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This endpoint returns the complete list of supported search criteria fields, their types, and validation requirements."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"best-practices","__idx":10},"children":["Best Practices"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Choose the Right Template:"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["basic"]}," for pre-screening and marketing purposes"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["hardcheck"]}," only when making actual credit decisions"]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Provide Sufficient Search Criteria:"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Always include SSN or date of birth for accurate matching"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Include full address when SSN is not available"]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Handle Missing Data:"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Not all fields are available for every consumer"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Implement your integration to gracefully handle missing or partial data"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Check for field presence before accessing nested properties"]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Regulatory Compliance:"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Ensure you have proper consent before running a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["hardcheck"]}," report"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Comply with the Fair Credit Reporting Act (FCRA) requirements"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Maintain records of consumer consent and permissible purpose"]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"service-lines","__idx":11},"children":["Service Lines"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Basic Template:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["csc_con_rep_US"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["HardCheck Template:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["csc_con_rep_US_hardcheck"]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Ensure your account has the appropriate service line enabled for the template you wish to use."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"related-endpoints","__idx":12},"children":["Related Endpoints"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/connect-apis-catalog/product-catalog/consumermisc/consumerandmisc"},"children":["GET /consumers/tryReport"]}]}," - Retrieve US consumer report"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/connect-apis-catalog/product-catalog/consumermisc/consumerandmisc"},"children":["GET /consumers/tryReport/searchcriteria"]}]}," - Discover available search criteria"]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"support","__idx":13},"children":["Support"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For questions about US Consumer Reports or to enable this service on your account, contact your Creditsafe account manager."]}]},"headings":[{"value":"US Consumer Reports","id":"us-consumer-reports","depth":1},{"value":"Data Dictionary","id":"data-dictionary","depth":2},{"value":"Overview","id":"overview","depth":2},{"value":"Report Templates","id":"report-templates","depth":3},{"value":"Basic Template","id":"basic-template","depth":4},{"value":"HardCheck Template","id":"hardcheck-template","depth":4},{"value":"Selecting a Template","id":"selecting-a-template","depth":2},{"value":"Required Search Criteria","id":"required-search-criteria","depth":2},{"value":"Response Structure","id":"response-structure","depth":2},{"value":"Search Criteria Discovery","id":"search-criteria-discovery","depth":2},{"value":"Best Practices","id":"best-practices","depth":2},{"value":"Service Lines","id":"service-lines","depth":2},{"value":"Related Endpoints","id":"related-endpoints","depth":2},{"value":"Support","id":"support","depth":2}],"frontmatter":{"seo":{"title":"US Consumer Reports"}},"lastModified":"2026-06-29T07:58:14.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/connect-apis-catalog/product-catalog/consumermisc/documentation/us-consumer-reports","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}