# Credit Data Access

.sc-doc-table table { table-layout: auto; width: 100%; }
table th, table td { word-break: keep-all; overflow-wrap: normal; padding: 8px 14px; vertical-align: top; }
table th:first-child, table td:first-child { white-space: nowrap; }
table td code, table th code { white-space: nowrap; }
How to retrieve credit scores, reports, alerts, and recommendations after enrollment.
| Method | Endpoint | Description |
|  --- | --- | --- |
| POST | `/direct/login` | Authenticate with API key and secret |
| GET | `/direct/preauth-token/{id}` | Get pre-auth token by user ID |
| GET | `/users/preauth-token/{preauthToken}` | Get user token |
| GET | `/users/efx-latest-scores` | Get latest scores |
| GET | `/users/efx-score-history` | Get score history |
| GET | `/users/efx-score-up` | Get score projections |
| GET | `/users/efx-latest-report` | Get latest report |
| GET | `/users/efx-latest-report/summary` | Get report summary |
| GET | `/users/credit-reports` | List reports |
| GET | `/users/credit-reports-metadata` | List report metadata |
| GET | `/users/credit-report` | Get credit report |
| GET | `/users/efx-latest-report-pdf` | Download report as PDF |
| GET | `/users/efx-alerts` | Get user alerts |
| GET | `/users/efx-alerts/{alertId}` | Get specific alert |
| GET | `/users/efx-alerts-details` | Get alert details |
| GET | `/users/efx-optimal-path` | Get optimal path recommendations |
| POST | `/users/efx-optimal-path` | Submit optimal path request |
| GET | `/users/efx-optimal-path/{config}` | Get optimal path by config |

 - [POST /direct/login](https://crsintegration.redocly.app/client-spec/credit-data-access/login.md): Authenticates a customer host using API key and secret credentials, returning a JWT access token and a refresh token. The access token must be included as a Bearer token in the `Authorization` header
 - [GET /direct/preauth-token/{id}](https://crsintegration.redocly.app/client-spec/credit-data-access/preauthtoken_1.md): Generates a short-lived pre-auth token for the specified user. **Parameters:** The `{id}` path parameter is the user's unique identifier (UUID). **Flow:** The returned token is used to establish a use
 - [GET /users/preauth-token/{preauthToken}](https://crsintegration.redocly.app/client-spec/credit-data-access/exchangepreauthtoken.md): Exchanges a pre-auth `{preauthToken}` for a full user session. This is how to obtain the `userToken` used for all `/users/*` endpoints. Returns the user profile along with JWT access and refresh token
 - [GET /users/efx-latest-scores](https://crsintegration.redocly.app/client-spec/credit-data-access/getefxlatestscores.md): Returns the most recent credit score for the authenticated user including score ranges and score factors. **Requirements:** The user must have passed identity verification. **Equifax only.** This endp
 - [GET /users/latest-scores](https://crsintegration.redocly.app/client-spec/credit-data-access/getlatestscores.md): Returns the user's latest credit score from every bureau enabled on their host - Equifax, TransUnion, Experian - in a single response. `bureaus` names the bureaus the payload contains and `scoreType`
 - [GET /users/efx-score-history](https://crsintegration.redocly.app/client-spec/credit-data-access/getefxscorehistory.md): Returns the credit score history for the authenticated user, showing how their score has changed over time. **Requirements:** The user must have passed identity verification. **Equifax only.** This en
 - [GET /users/efx-score-up](https://crsintegration.redocly.app/client-spec/credit-data-access/getscoreup.md): Returns personalized credit score improvement recommendations based on the user's current credit profile. Includes direct and possible pathways with projected score increase. **Parameters:** Pass `sco
 - [GET /users/efx-latest-report](https://crsintegration.redocly.app/client-spec/credit-data-access/efxlatestreport.md): Returns the most recent full credit report for the authenticated user. Reports are refreshed on a weekly or monthly cycle depending on the user's enrollment plan, and cached between updates. **Require
 - [GET /users/latest-report](https://crsintegration.redocly.app/client-spec/credit-data-access/getlatestreport.md): Returns the user's latest credit report from every bureau enabled on their host - Equifax, TransUnion, Experian - in a single response. `bureaus` names the bureaus the payload contains and `reportType
 - [GET /users/efx-latest-report/summary](https://crsintegration.redocly.app/client-spec/credit-data-access/efxlatestreportsummary.md): Returns a summarized view of the latest credit report including total open accounts, negative accounts, inquiries, collections, and credit history length. **Requirements:** The user must have passed i
 - [GET /users/credit-reports](https://crsintegration.redocly.app/client-spec/credit-data-access/getallencryptedreports.md): Returns all credit reports from history for the authenticated user including total report count. **Expiration:** Reports are stored for **3 months**.
 - [GET /users/credit-reports-metadata](https://crsintegration.redocly.app/client-spec/credit-data-access/getencryptedreportmetadata.md): Returns metadata for all credit reports without the report data itself. Useful for listing available reports and their dates before fetching full reports. **Expiration:** Reports are stored for **3 mo
 - [GET /users/credit-report](https://crsintegration.redocly.app/client-spec/credit-data-access/getencryptedreport.md): Returns a single credit report from history. **Parameters:** Use `reportId` to fetch a specific report, or `offset` to paginate through reports (0 = latest). **Expiration:** Reports are stored for **3
 - [GET /users/efx-latest-report-pdf](https://crsintegration.redocly.app/client-spec/credit-data-access/getreportpdf.md): Downloads the latest credit report in PDF format. Returns PDF bytes on success (`application/pdf`) or `application/json` error response on failure. **Equifax only.** The PDF is rendered from the Equif
 - [GET /users/efx-alerts](https://crsintegration.redocly.app/client-spec/credit-data-access/getefxalerts.md): Returns a list of credit monitoring alerts for the authenticated user. Each alert contains basic information such as type, category, and reported date. **Requirements:** The user must have passed iden
 - [GET /users/efx-alerts/{alertId}](https://crsintegration.redocly.app/client-spec/credit-data-access/getefxalert.md): Returns the full details of a specific credit monitoring alert including alert-specific details like creditor name and account type. **Parameters:** The `{alertId}` path parameter is the alert's uniqu
 - [GET /users/efx-alerts-details](https://crsintegration.redocly.app/client-spec/credit-data-access/getefxalertswithdetails.md): Returns all credit monitoring alerts for the authenticated user with full details for each alert. **Requirements:** The user must have passed identity verification. **Equifax only.** This endpoint ser
 - [GET /users/efx-optimal-path](https://crsintegration.redocly.app/client-spec/credit-data-access/getoptimalpathplan.md): Returns the user's current Optimal Path plan including score projections, recommendations, and progress tracking. **Flow:** A plan must have been previously generated via `POST /users/efx-optimal-path
 - [POST /users/efx-optimal-path](https://crsintegration.redocly.app/client-spec/credit-data-access/generateoptimalpathplan.md): Generates a new Optimal Path plan with the specified `targetScore` and `duration`. The previous plan will be deleted and progress tracking will reset for the new plan. **Parameters:** Valid `duration`
 - [GET /users/efx-optimal-path/{config}](https://crsintegration.redocly.app/client-spec/credit-data-access/getoptimalpathplanbyconfig.md): Returns a specific view of the Optimal Path plan. **Parameters:** The `{config}` path parameter controls the response detail. Use `op-simple` for the summary only, or `op-full` for the complete respon