{"templateId":"api_docs","sharedDataIds":{"apiDocsStore":"api-docs-client-spec.yaml","sidebar":"sidebar-sidebars.yaml"},"props":{"definitionId":"client-spec.yaml","settings":{"baseUrlPath":"/client-spec"},"disableAutoScroll":true,"seo":{"title":"CRS Credit Monitoring API"},"dynamicMarkdocComponents":[],"metadata":{"type":"openapi","title":"CRS Credit Monitoring API","version":"v3","description":"<style>\n.sc-doc-table table { table-layout: auto; width: 100%; }\ntable th, table td { word-break: keep-all; overflow-wrap: normal; padding: 8px 14px; vertical-align: top; }\ntable th:first-child, table td:first-child { white-space: nowrap; }\ntable td code, table th code { white-space: nowrap; }\n</style>\n\nWelcome to the **CRS Credit Monitoring API** — the platform for embedding credit monitoring, identity verification, score improvement, and pre-screening into your product. CRS handles the parts you don't want to build: credit-bureau enrollment, secure consumer-data storage, regulatory compliance, identity verification, and the day-to-day operational machinery of running a credit product.\n\nYou focus on the product surface your users see; we power the credit infrastructure underneath. Whether you ship our pre-built widget, build a fully custom UI on our API, or mix the two, the same set of products, flows, and lifecycle events is available to you.\n\n**How to integrate.** Five steps from sign-up to live traffic:\n\n1. **Find the implementation type you need.** Browse the [Products](/client-spec/products) section to see what we offer (Credit Scores, Reports, Alerts, Identity Verification, Score Up, Optimal Path, Offers IQ, Push Notifications). Pick the products that match your product roadmap.\n2. **Request credentials.** Contact your account manager to provision a customer + host and issue API credentials. You'll receive an **API key** and **API secret** for the development environment.\n3. **Integration.** Build against the development environment. Most integrations land somewhere on the spectrum from \"drop the [Widget](/client-spec/widget) into a page\" (zero backend) to \"use the Direct API + your own UI\" (full control). Test scenarios are in [Test Cases](/client-spec/test-cases); error codes in [Errors](/client-spec/errors).\n4. **Get Approved.** Once your integration is working in development, request production credentials. We review the integration for compliance, security, and feature configuration before issuing prod keys.\n5. **Go live.** Switch to production credentials, point your hosts at the production base URL, and start serving real users.\n\n**Test credentials.** While you're waiting on your own credentials in step 2, pre-provisioned hosts on the **DEV** environment let you start exploring the API right away. The two credit hosts have all features enabled — one configured for Equifax 1-bureau coverage, the other for the Equifax 3-bureau product — so you can compare response shapes and behavior between the two.\n\n***Redocly Documentation — EFX 1B With All Features***\n\n- **Host ID:** `89070aac-9542-44c4-bd58-0abe444edfea`\n- **API Key:** `dd12e2b3-7504-461b-be48-fe6ef5ae7c1b`\n- **Secret:** `4fc8400b-4024-4ef6-8e80-f7797583a5c2`\n\n***Redocly Documentation — EFX 3B With All Features***\n\n- **Host ID:** `fdf44557-815d-462d-b3fa-23561e4d4be8`\n- **API Key:** `68f7e668-78ab-4d17-97e6-4139f6c0069a`\n- **Secret:** `d6b53763-0798-40dd-b6ec-abfa56a0236f`\n\n***Redocly Documentation — Offers IQ***\n\n- **API Key:** `f66fccbd-4cf7-4915-9850-09f00fccc7d0`\n- **Secret:** `a9f0241f-f3e8-4c71-a842-90521da87afb`\n- **Rule Set ID:** `PROD_0E28CFE2`\n\nUse the API Key and Secret with `POST /direct/login` to obtain a host token, then pass the **Rule Set ID** in the `POST /direct/credit-pre-screening` request body to exercise the Offers IQ flow against the pre-configured test rule set.\n\n***Redocly Documentation — Prefill Products***\n\n- **Host ID:** `ca0266eb-7fcb-44eb-81b6-103793880b74`\n- **API Key:** `7c7d4228-c9dc-491b-93b3-09541b8dc8f9`\n- **Secret:** `a07686de-9f1b-4c95-8b19-6b21ae6a34d2`\n\nUse the API Key and Secret with `POST /direct/login` to obtain a host token, then call the Prefill Products endpoints (e.g. `POST /direct/address-prefill`).\n\n***Redocly Documentation — All 3 Bureaus***\n\n- **Host ID:** `f0e7f995-e080-4d0a-9d60-d270e2739435`\n- **API Key:** `4fc5bb84-a389-49ff-888c-e953f5271c36`\n- **Secret:** `bdc8a319-0984-45a5-b1bf-2d094d843453`\n\nA host enrolled with Equifax, TransUnion and Experian together. Credit data comes back merged, one key per bureau — read it from `GET /users/latest-report` / `GET /users/latest-scores` (user token) or `GET /direct/latest-report/{id}` / `GET /direct/latest-scores/{id}` (host token), not the `efx-*` endpoints.\n\nThese credentials are for **DEV-environment exploration only** — do not use them in production code. Authenticate with `POST /direct/login`, then use the [test SSNs and scenarios](/client-spec/test-cases) to exercise the full identity-verification and credit-data flows.\n\n**Support.** Questions, integration issues, or anything not covered in these docs — email [support@crscreditapi.com](mailto:support@crscreditapi.com).\n\nFor deeper integration patterns, see [Getting Started](/client-spec/getting-started). API spec last updated `2026-10-16`.\n"},"compilationErrors":[],"markdown":{"partials":{},"variables":{"rbac":{"teams":["anonymous"]},"user":{},"remoteAddr":{"hostname":"crsintegration.redocly.app","port":4000,"ipAddress":"216.73.216.21"},"lang":"default_locale","env":{"PUBLIC_REDOCLY_BRANCH_NAME":"main"}}},"pagePropGetterError":{"message":"","name":""}},"slug":"/client-spec","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}