{"items":[{"type":"link","label":"CRS Credit Monitoring API","link":"/client-spec","routeSlug":"/client-spec"},{"type":"separator","label":"Getting Started"},{"type":"group","label":"Getting Started","link":"/client-spec/getting-started","routeSlug":"/client-spec/getting-started","items":[{"type":"link","label":"What is CRS","link":"/client-spec/getting-started/what-is-crs","routeSlug":"/client-spec/getting-started/what-is-crs"},{"type":"link","label":"What you get","link":"/client-spec/getting-started/what-you-get","routeSlug":"/client-spec/getting-started/what-you-get"},{"type":"link","label":"How you integrate","link":"/client-spec/getting-started/how-you-integrate","routeSlug":"/client-spec/getting-started/how-you-integrate"},{"type":"link","label":"Drop in the widget","link":"/client-spec/getting-started/drop-in-the-widget","routeSlug":"/client-spec/getting-started/drop-in-the-widget"},{"type":"link","label":"Build on the API","link":"/client-spec/getting-started/build-on-the-api","routeSlug":"/client-spec/getting-started/build-on-the-api"}]},{"type":"separator","label":"Products"},{"type":"group","label":"Products","link":"/client-spec/products","routeSlug":"/client-spec/products","items":[{"type":"link","label":"Credit Scores","link":"/client-spec/products/credit-scores","routeSlug":"/client-spec/products/credit-scores"},{"type":"link","label":"Credit Reports","link":"/client-spec/products/credit-reports","routeSlug":"/client-spec/products/credit-reports"},{"type":"link","label":"Alerts","link":"/client-spec/products/alerts","routeSlug":"/client-spec/products/alerts"},{"type":"link","label":"Identity Verification","link":"/client-spec/products/identity-verification","routeSlug":"/client-spec/products/identity-verification"},{"type":"link","label":"Dormant users — verify now, activate later","link":"/client-spec/products/dormant-users-verify-now-activate-later","routeSlug":"/client-spec/products/dormant-users-verify-now-activate-later"},{"type":"link","label":"Score Up","link":"/client-spec/products/score-up","routeSlug":"/client-spec/products/score-up"},{"type":"link","label":"Optimal Path","link":"/client-spec/products/optimal-path","routeSlug":"/client-spec/products/optimal-path"},{"type":"link","label":"Offers IQ","link":"/client-spec/products/offers-iq","routeSlug":"/client-spec/products/offers-iq"},{"type":"link","label":"Prefill Products","link":"/client-spec/products/prefill-products","routeSlug":"/client-spec/products/prefill-products"},{"type":"link","label":"Push Notifications","link":"/client-spec/products/push-notifications","routeSlug":"/client-spec/products/push-notifications"}]},{"type":"separator","label":"Resources"},{"type":"group","label":"Webhooks","link":"/client-spec/webhooks","routeSlug":"/client-spec/webhooks","items":[{"type":"link","label":"What you'll receive","link":"/client-spec/webhooks/what-you'll-receive","routeSlug":"/client-spec/webhooks/what-you'll-receive"},{"type":"link","label":"Configure your endpoint","link":"/client-spec/webhooks/configure-your-endpoint","routeSlug":"/client-spec/webhooks/configure-your-endpoint"},{"type":"link","label":"Payload format","link":"/client-spec/webhooks/payload-format","routeSlug":"/client-spec/webhooks/payload-format"},{"type":"link","label":"Required response","link":"/client-spec/webhooks/required-response","routeSlug":"/client-spec/webhooks/required-response"},{"type":"link","label":"Use webhooks with the API","link":"/client-spec/webhooks/use-webhooks-with-the-api","routeSlug":"/client-spec/webhooks/use-webhooks-with-the-api"}]},{"type":"group","label":"Prefill-Onboarding SDK","link":"/client-spec/prefill-onboarding-sdk","routeSlug":"/client-spec/prefill-onboarding-sdk","items":[{"type":"link","label":"When to use it","link":"/client-spec/prefill-onboarding-sdk/when-to-use-it","routeSlug":"/client-spec/prefill-onboarding-sdk/when-to-use-it"},{"type":"link","label":"Web (JavaScript)","link":"/client-spec/prefill-onboarding-sdk/web-(javascript)","routeSlug":"/client-spec/prefill-onboarding-sdk/web-(javascript)"},{"type":"link","label":"iOS (Swift)","link":"/client-spec/prefill-onboarding-sdk/ios-(swift)","routeSlug":"/client-spec/prefill-onboarding-sdk/ios-(swift)"},{"type":"link","label":"Android (Kotlin)","link":"/client-spec/prefill-onboarding-sdk/android-(kotlin)","routeSlug":"/client-spec/prefill-onboarding-sdk/android-(kotlin)"},{"type":"link","label":"React Native","link":"/client-spec/prefill-onboarding-sdk/react-native","routeSlug":"/client-spec/prefill-onboarding-sdk/react-native"},{"type":"link","label":"Important notes","link":"/client-spec/prefill-onboarding-sdk/important-notes","routeSlug":"/client-spec/prefill-onboarding-sdk/important-notes"}]},{"type":"group","label":"Customer Portal","link":"/client-spec/customer-portal","routeSlug":"/client-spec/customer-portal","items":[{"type":"link","label":"Getting access","link":"/client-spec/customer-portal/getting-access","routeSlug":"/client-spec/customer-portal/getting-access"},{"type":"link","label":"Features","link":"/client-spec/customer-portal/features","routeSlug":"/client-spec/customer-portal/features"}]},{"type":"group","label":"Queues","link":"/client-spec/queues","routeSlug":"/client-spec/queues","items":[{"type":"link","label":"Why queues exist","link":"/client-spec/queues/why-queues-exist","routeSlug":"/client-spec/queues/why-queues-exist"},{"type":"link","label":"Two queues","link":"/client-spec/queues/two-queues","routeSlug":"/client-spec/queues/two-queues"},{"type":"link","label":"How processing works","link":"/client-spec/queues/how-processing-works","routeSlug":"/client-spec/queues/how-processing-works"},{"type":"link","label":"Rate limiting","link":"/client-spec/queues/rate-limiting","routeSlug":"/client-spec/queues/rate-limiting"},{"type":"link","label":"Validation","link":"/client-spec/queues/validation","routeSlug":"/client-spec/queues/validation"},{"type":"link","label":"What you'll see in the portal","link":"/client-spec/queues/what-you'll-see-in-the-portal","routeSlug":"/client-spec/queues/what-you'll-see-in-the-portal"}]},{"type":"group","label":"Test Cases","link":"/client-spec/test-cases","routeSlug":"/client-spec/test-cases","items":[{"type":"link","label":"How sandbox routing works","link":"/client-spec/test-cases/how-sandbox-routing-works","routeSlug":"/client-spec/test-cases/how-sandbox-routing-works"},{"type":"link","label":"Test credentials","link":"/client-spec/test-cases/test-credentials","routeSlug":"/client-spec/test-cases/test-credentials"},{"type":"link","label":"Digital Identity Trust + Secure Multi-Factor Authentication","link":"/client-spec/test-cases/digital-identity-trust-+-secure-multi-factor-authentication","routeSlug":"/client-spec/test-cases/digital-identity-trust-+-secure-multi-factor-authentication"},{"type":"link","label":"Digital Identity Trust + Customer OTP","link":"/client-spec/test-cases/digital-identity-trust-+-customer-otp","routeSlug":"/client-spec/test-cases/digital-identity-trust-+-customer-otp"},{"type":"link","label":"Prefill + Onboarding","link":"/client-spec/test-cases/prefill-+-onboarding","routeSlug":"/client-spec/test-cases/prefill-+-onboarding"},{"type":"link","label":"Partial credit data","link":"/client-spec/test-cases/partial-credit-data","routeSlug":"/client-spec/test-cases/partial-credit-data"},{"type":"link","label":"Offers IQ","link":"/client-spec/test-cases/offers-iq","routeSlug":"/client-spec/test-cases/offers-iq"},{"type":"link","label":"Prefill Products","link":"/client-spec/test-cases/prefill-products","routeSlug":"/client-spec/test-cases/prefill-products"}]},{"type":"group","label":"DIT Overview","link":"/client-spec/dit-overview","routeSlug":"/client-spec/dit-overview","items":[{"type":"link","label":"How a DIT decision is made","link":"/client-spec/dit-overview/how-a-dit-decision-is-made","routeSlug":"/client-spec/dit-overview/how-a-dit-decision-is-made"},{"type":"link","label":"How CRS treats the decision","link":"/client-spec/dit-overview/how-crs-treats-the-decision","routeSlug":"/client-spec/dit-overview/how-crs-treats-the-decision"},{"type":"link","label":"Response fields at a glance","link":"/client-spec/dit-overview/response-fields-at-a-glance","routeSlug":"/client-spec/dit-overview/response-fields-at-a-glance"},{"type":"link","label":"Identity Trust","link":"/client-spec/dit-overview/identity-trust","routeSlug":"/client-spec/dit-overview/identity-trust"},{"type":"link","label":"Address Trust","link":"/client-spec/dit-overview/address-trust","routeSlug":"/client-spec/dit-overview/address-trust"},{"type":"link","label":"Date of Birth (DOB) Trust","link":"/client-spec/dit-overview/date-of-birth-(dob)-trust","routeSlug":"/client-spec/dit-overview/date-of-birth-(dob)-trust"},{"type":"link","label":"SSN Trust","link":"/client-spec/dit-overview/ssn-trust","routeSlug":"/client-spec/dit-overview/ssn-trust"},{"type":"link","label":"Phone Trust","link":"/client-spec/dit-overview/phone-trust","routeSlug":"/client-spec/dit-overview/phone-trust"},{"type":"link","label":"Email Trust","link":"/client-spec/dit-overview/email-trust","routeSlug":"/client-spec/dit-overview/email-trust"},{"type":"link","label":"Device Trust","link":"/client-spec/dit-overview/device-trust","routeSlug":"/client-spec/dit-overview/device-trust"}]},{"type":"group","label":"Errors","link":"/client-spec/errors","routeSlug":"/client-spec/errors","items":[{"type":"link","label":"Error response shape","link":"/client-spec/errors/error-response-shape","routeSlug":"/client-spec/errors/error-response-shape"},{"type":"link","label":"Authentication & token errors","link":"/client-spec/errors/authentication-and-token-errors","routeSlug":"/client-spec/errors/authentication-and-token-errors"},{"type":"link","label":"User & account errors","link":"/client-spec/errors/user-and-account-errors","routeSlug":"/client-spec/errors/user-and-account-errors"},{"type":"link","label":"Identity verification & enrollment errors","link":"/client-spec/errors/identity-verification-and-enrollment-errors","routeSlug":"/client-spec/errors/identity-verification-and-enrollment-errors"},{"type":"link","label":"Credit data errors","link":"/client-spec/errors/credit-data-errors","routeSlug":"/client-spec/errors/credit-data-errors"},{"type":"link","label":"Host & validation errors","link":"/client-spec/errors/host-and-validation-errors","routeSlug":"/client-spec/errors/host-and-validation-errors"},{"type":"link","label":"Prefill Products errors","link":"/client-spec/errors/prefill-products-errors","routeSlug":"/client-spec/errors/prefill-products-errors"},{"type":"link","label":"Rate limiting & timing errors","link":"/client-spec/errors/rate-limiting-and-timing-errors","routeSlug":"/client-spec/errors/rate-limiting-and-timing-errors"},{"type":"link","label":"Webhook delivery errors","link":"/client-spec/errors/webhook-delivery-errors","routeSlug":"/client-spec/errors/webhook-delivery-errors"}]},{"type":"group","label":"MCP Server","link":"/client-spec/mcp-server","routeSlug":"/client-spec/mcp-server","items":[{"type":"link","label":"When to use it","link":"/client-spec/mcp-server/when-to-use-it","routeSlug":"/client-spec/mcp-server/when-to-use-it"},{"type":"link","label":"Setup","link":"/client-spec/mcp-server/setup","routeSlug":"/client-spec/mcp-server/setup"},{"type":"link","label":"Using it","link":"/client-spec/mcp-server/using-it","routeSlug":"/client-spec/mcp-server/using-it"},{"type":"link","label":"Security","link":"/client-spec/mcp-server/security","routeSlug":"/client-spec/mcp-server/security"},{"type":"link","label":"Updates","link":"/client-spec/mcp-server/updates","routeSlug":"/client-spec/mcp-server/updates"}]},{"type":"separator","label":"Widget"},{"type":"group","label":"Widget","link":"/client-spec/widget","routeSlug":"/client-spec/widget","items":[{"type":"link","label":"Two ways to integrate","link":"/client-spec/widget/two-ways-to-integrate","routeSlug":"/client-spec/widget/two-ways-to-integrate"},{"type":"link","label":"Embed the widget","link":"/client-spec/widget/embed-the-widget","routeSlug":"/client-spec/widget/embed-the-widget"},{"type":"link","label":"Identity verification flows","link":"/client-spec/widget/identity-verification-flows","routeSlug":"/client-spec/widget/identity-verification-flows"},{"type":"link","label":"PostMessage reference","link":"/client-spec/widget/postmessage-reference","routeSlug":"/client-spec/widget/postmessage-reference"}]},{"type":"separator","label":"API › Server-side (/direct)"},{"type":"group","label":"Direct - Authentication","link":"/client-spec/direct-authentication","routeSlug":"/client-spec/direct-authentication","items":[{"label":"Authenticate and obtain JWT tokens","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/client-spec/direct-authentication/login","routeSlug":"/client-spec/direct-authentication/login","metadata":{"seo":{"title":"Authenticate and obtain JWT tokens","description":"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 for all /direct/* endpoints."}},"httpPath":"/direct/login"},{"label":"Get pre-auth token by user ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/client-spec/direct-authentication/preauthtoken_1","routeSlug":"/client-spec/direct-authentication/preauthtoken_1","metadata":{"seo":{"title":"Get pre-auth token by user ID","description":"Generates a short-lived pre-auth token for the specified user."}},"httpPath":"/direct/preauth-token/{id}"},{"label":"Refresh JWT token","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/client-spec/direct-authentication/refreshtoken","routeSlug":"/client-spec/direct-authentication/refreshtoken","metadata":{"seo":{"title":"Refresh JWT token","description":"Exchanges a valid refresh token for a new access token and refresh token pair."}},"httpPath":"/direct/refresh-token"}]},{"type":"group","label":"Direct - User Registration","link":"/client-spec/direct-user-registration","routeSlug":"/client-spec/direct-user-registration","items":[{"label":"Register a new user","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/client-spec/direct-user-registration/register","routeSlug":"/client-spec/direct-user-registration/register","metadata":{"seo":{"title":"Register a new user","description":"Registers a new user under the authenticated host and returns the user data."}},"httpPath":"/direct/user-reg"}]},{"type":"group","label":"Direct - Profile Management","link":"/client-spec/direct-profile-management","routeSlug":"/client-spec/direct-profile-management","items":[{"label":"Confirm user verification","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/client-spec/direct-profile-management/confirmuserverification","routeSlug":"/client-spec/direct-profile-management/confirmuserverification","metadata":{"seo":{"title":"Confirm user verification","description":"Records that the customer has independently verified a user's identity (Digital Identity Trust + Customer OTP flow)."}},"httpPath":"/direct/verify-user"},{"label":"Get user details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/client-spec/direct-profile-management/getuser_1","routeSlug":"/client-spec/direct-profile-management/getuser_1","metadata":{"seo":{"title":"Get user details","description":"Returns the full profile for a user including enrollment status, notification preferences, and feature flags."}},"httpPath":"/direct/user/{id}"},{"label":"Change user email","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/client-spec/direct-profile-management/changeemail","routeSlug":"/client-spec/direct-profile-management/changeemail","metadata":{"seo":{"title":"Change user email","description":"Updates the email address for the specified user."}},"httpPath":"/direct/change-email/{id}"},{"label":"Change user mobile number","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/client-spec/direct-profile-management/changemobile","routeSlug":"/client-spec/direct-profile-management/changemobile","metadata":{"seo":{"title":"Change user mobile number","description":"Updates the mobile number for the specified user."}},"httpPath":"/direct/change-mobile/{id}"},{"label":"Change user name","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/client-spec/direct-profile-management/changename","routeSlug":"/client-spec/direct-profile-management/changename","metadata":{"seo":{"title":"Change user name","description":"Updates the first and last name for the specified user."}},"httpPath":"/direct/change-name/{id}"},{"label":"Pause user enrollment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/client-spec/direct-profile-management/pauseenrollment","routeSlug":"/client-spec/direct-profile-management/pauseenrollment","metadata":{"seo":{"title":"Pause user enrollment","description":"Pauses a single user by removing all Equifax features and marking them as paused. Paused users cannot pull credit data and are effectively disabled until resumed."}},"httpPath":"/direct/users/{userId}/pause-enrollment"},{"label":"Resume user enrollment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/client-spec/direct-profile-management/resumeenrollment","routeSlug":"/client-spec/direct-profile-management/resumeenrollment","metadata":{"seo":{"title":"Resume user enrollment","description":"Resumes a paused user by re-enrolling Equifax features and marking them as active. Once resumed, the user can pull credit data again."}},"httpPath":"/direct/users/{userId}/resume-enrollment"},{"label":"Batch pause user enrollments","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/client-spec/direct-profile-management/pauseenrollmentsbatch","routeSlug":"/client-spec/direct-profile-management/pauseenrollmentsbatch","metadata":{"seo":{"title":"Batch pause user enrollments","description":"Submits a batch request to pause multiple user enrollments. Users are added to the enrollment queue and processed asynchronously. Paused users cannot pull credit data and are effectively disabled until resumed."}},"httpPath":"/direct/users/pause-enrollments"},{"label":"Batch resume user enrollments","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/client-spec/direct-profile-management/resumeenrollmentsbatch","routeSlug":"/client-spec/direct-profile-management/resumeenrollmentsbatch","metadata":{"seo":{"title":"Batch resume user enrollments","description":"Submits a batch request to resume multiple paused user enrollments. Users are added to the enrollment queue and processed asynchronously. Once resumed, users can pull credit data again."}},"httpPath":"/direct/users/resume-enrollments"},{"label":"Move user to different host","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/client-spec/direct-profile-management/changehost","routeSlug":"/client-spec/direct-profile-management/changehost","metadata":{"seo":{"title":"Move user to different host","description":"Transfers a user to a different host within the same customer. Can be used to upgrade or downgrade a user's credit data access, for example moving from a 1-bureau host to a 3-bureau host or vice versa."}},"httpPath":"/direct/change-host/{id}"},{"label":"Close account by user ID","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/client-spec/direct-profile-management/closeaccount","routeSlug":"/client-spec/direct-profile-management/closeaccount","metadata":{"seo":{"title":"Close account by user ID","description":"Closes the user account and unenrolls from Equifax."}},"httpPath":"/direct/close-account/{id}"},{"label":"Close account by email","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/client-spec/direct-profile-management/closeaccountbyemail","routeSlug":"/client-spec/direct-profile-management/closeaccountbyemail","metadata":{"seo":{"title":"Close account by email","description":"Closes the user account identified by email address and unenrolls from Equifax."}},"httpPath":"/direct/close-account"},{"label":"Batch close accounts","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/client-spec/direct-profile-management/closeaccountsbatch","routeSlug":"/client-spec/direct-profile-management/closeaccountsbatch","metadata":{"seo":{"title":"Batch close accounts","description":"Submits a batch request to close multiple user accounts. Users are added to the unenrollment queue and processed asynchronously."}},"httpPath":"/direct/close-accounts"},{"label":"Store user identity","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/client-spec/direct-profile-management/storeidentity","routeSlug":"/client-spec/direct-profile-management/storeidentity","metadata":{"seo":{"title":"Store user identity","description":"Stores a user's PII — use it to add details for a user who has none stored, or to update what is already there."}},"httpPath":"/direct/users/{userId}/identity"}]},{"type":"group","label":"Direct - Data & Cache","link":"/client-spec/direct-data-and-cache","routeSlug":"/client-spec/direct-data-and-cache","items":[{"label":"Force credit data refresh","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/client-spec/direct-data-and-cache/updaterefresh","routeSlug":"/client-spec/direct-data-and-cache/updaterefresh","metadata":{"seo":{"title":"Force credit data refresh","description":"Triggers a refresh of the user's credit data from Equifax. Does not return the refreshed data, only triggers the refresh."}},"httpPath":"/direct/update-refresh/{id}"},{"label":"Clear user cache","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/client-spec/direct-data-and-cache/resetcache","routeSlug":"/client-spec/direct-data-and-cache/resetcache","metadata":{"seo":{"title":"Clear user cache","description":"Clears the cached credit report and score data for the specified user. The next data request will fetch fresh data from Equifax."}},"httpPath":"/direct/reset-cache/{id}"}]},{"type":"group","label":"Direct - Identity Monitoring","link":"/client-spec/direct-identity-monitoring","routeSlug":"/client-spec/direct-identity-monitoring","items":[{"label":"Get user identity flow status","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/client-spec/direct-identity-monitoring/getidentityflowstatus","routeSlug":"/client-spec/direct-identity-monitoring/getidentityflowstatus","metadata":{"seo":{"title":"Get user identity flow status","description":"Returns the current identity verification status and all completed steps for the specified user, filtered to the chosen identity-verification flow."}},"httpPath":"/direct/users/{userId}/identity-status"},{"label":"Get DIT trust components for a user","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/client-spec/direct-identity-monitoring/getditidentity","routeSlug":"/client-spec/direct-identity-monitoring/getditidentity","metadata":{"seo":{"title":"Get DIT trust components for a user","description":"Returns trust components from DIT identity verification."}},"httpPath":"/direct/users/{userId}/dit-identity"}]},{"type":"group","label":"Direct - Offers IQ","link":"/client-spec/direct-offers-iq","routeSlug":"/client-spec/direct-offers-iq","items":[{"label":"Perform Offers IQ","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/client-spec/direct-offers-iq/performprescreening","routeSlug":"/client-spec/direct-offers-iq/performprescreening","metadata":{"seo":{"title":"Perform Offers IQ","description":"Performs real-time Offers IQ by evaluating consumer information against configurable rule sets and Equifax credit data. The API retrieves credit information from Equifax OneView, applies business rules (credit score thresholds, debt-to-income ratios, etc.), and returns an instant approval decision. Supports NO HIT scenarios for consumers with no credit history."}},"httpPath":"/direct/credit-pre-screening"},{"label":"Get Offers IQ result","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/client-spec/direct-offers-iq/getprescreeningresult","routeSlug":"/client-spec/direct-offers-iq/getprescreeningresult","metadata":{"seo":{"title":"Get Offers IQ result","description":"Retrieves a previously completed Offers IQ result by its unique request ID."}},"httpPath":"/direct/credit-pre-screening/{requestId}"},{"label":"List supported rule-evaluation attributes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/client-spec/direct-offers-iq/getsupportedattributes","routeSlug":"/client-spec/direct-offers-iq/getsupportedattributes","metadata":{"seo":{"title":"List supported rule-evaluation attributes","description":"Returns the catalog of Equifax Credit Metrics (ECM) attributes that can be used as attributeCode values in Offers IQ rule sets. Each entry carries the value type (INTEGER/DOUBLE/BOOLEAN), unit (DOLLARS/PERCENT/COUNT/FLAG/SCORE/MONTHS), bucket, and a description — everything needed to render a rule-configuration UI."}},"httpPath":"/direct/credit-pre-screening/attributes"}]},{"type":"group","label":"Direct - Prefill Products","link":"/client-spec/direct-prefill-products","routeSlug":"/client-spec/direct-prefill-products","items":[{"label":"Address Prefill","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/client-spec/direct-prefill-products/unifiedreverse","routeSlug":"/client-spec/direct-prefill-products/unifiedreverse","metadata":{"seo":{"title":"Address Prefill","description":"Resolves a consumer's identity and postal address from minimal contact information. Send a phone number and/or email (optionally a first and last name) and receive the matching person + address records."}},"httpPath":"/direct/address-prefill"},{"label":"Data Prefill — retrieve by transaction id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/client-spec/direct-prefill-products/gettransaction","routeSlug":"/client-spec/direct-prefill-products/gettransaction","metadata":{"seo":{"title":"Data Prefill — retrieve by transaction id","description":"Retrieves a previously returned Prefill result by its transactionId. Returns the same response body the original lookup produced. The result is scoped to the requesting host."}},"httpPath":"/direct/data-prefill/{transactionId}"}]},{"type":"separator","label":"API › User-device (/users)"},{"type":"group","label":"User - Initialization & Authentication","link":"/client-spec/user-initialization-and-authentication","routeSlug":"/client-spec/user-initialization-and-authentication","items":[{"label":"Exchange pre-auth token for session","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/client-spec/user-initialization-and-authentication/exchangepreauthtoken","routeSlug":"/client-spec/user-initialization-and-authentication/exchangepreauthtoken","metadata":{"seo":{"title":"Exchange pre-auth token for session","description":"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 tokens."}},"httpPath":"/users/preauth-token/{preauthToken}"},{"label":"Get current user profile","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/client-spec/user-initialization-and-authentication/getuser","routeSlug":"/client-spec/user-initialization-and-authentication/getuser","metadata":{"seo":{"title":"Get current user profile","description":"Returns the full profile for the currently authenticated user including enrollment status, notification preferences, and feature flags."}},"httpPath":"/users"}]},{"type":"group","label":"User - Identity Verification","link":"/client-spec/user-identity-verification","routeSlug":"/client-spec/user-identity-verification","items":[{"label":"Submit identity data for DIT verification","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/client-spec/user-identity-verification/postditverifyidentity","routeSlug":"/client-spec/user-identity-verification/postditverifyidentity","metadata":{"seo":{"title":"Submit identity data for DIT verification","description":"Submits personal identity information (name, SSN, DOB, address) for Digital Identity Trust verification."}},"httpPath":"/users/dit-identity"},{"label":"Send SMFA verification link","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/client-spec/user-identity-verification/postsmfasendlink","routeSlug":"/client-spec/user-identity-verification/postsmfasendlink","metadata":{"seo":{"title":"Send SMFA verification link","description":"Sends a Secure Multi-Factor Authentication link to the user's mobile device or email."}},"httpPath":"/users/smfa-send-link/{ditToken}"},{"label":"Verify SMFA status and complete enrollment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/client-spec/user-identity-verification/postsmfaverifystatus","routeSlug":"/client-spec/user-identity-verification/postsmfaverifystatus","metadata":{"seo":{"title":"Verify SMFA status and complete enrollment","description":"Checks whether the user completed the SMFA link verification on their mobile device or email. On success, the user is enrolled in Equifax and credit monitoring features are activated."}},"httpPath":"/users/smfa-verify-status/{smfaToken}"},{"label":"Begin enrollment after customer verification","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/client-spec/user-identity-verification/beginenrollment","routeSlug":"/client-spec/user-identity-verification/beginenrollment","metadata":{"seo":{"title":"Begin enrollment after customer verification","description":"Initiates Equifax enrollment for a user who has passed DIT verification and been verified by the customer via OTP."}},"httpPath":"/users/begin-enrollment/{smfaToken}"},{"label":"Start identity prefill verification","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/client-spec/user-identity-verification/startidentityprefill","routeSlug":"/client-spec/user-identity-verification/startidentityprefill","metadata":{"seo":{"title":"Start identity prefill verification","description":"Initiates identity prefill verification. Submits the user's name and phone number for phone risk assessment. If SNA (Silent Network Authentication) succeeds, OTP is skipped and the user can proceed directly to onboarding. Otherwise, if otpRequired is true in the response, the user must complete OTP verification before onboarding."}},"httpPath":"/users/identity-prefill"},{"label":"Submit OTP for prefill verification","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/client-spec/user-identity-verification/submitidentityotp","routeSlug":"/client-spec/user-identity-verification/submitidentityotp","metadata":{"seo":{"title":"Submit OTP for prefill verification","description":"Submits the 6-digit OTP code sent to the user's phone during prefill verification. On successful verification, returns prefill data and marks the session as accepted."}},"httpPath":"/users/identity-submit-otp"},{"label":"Resend OTP for prefill verification","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/client-spec/user-identity-verification/resendidentityotp","routeSlug":"/client-spec/user-identity-verification/resendidentityotp","metadata":{"seo":{"title":"Resend OTP for prefill verification","description":"Resends the OTP code to the user's phone."}},"httpPath":"/users/identity-resend-otp"},{"label":"Complete onboarding with identity data","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/client-spec/user-identity-verification/submitidentityonboarding","routeSlug":"/client-spec/user-identity-verification/submitidentityonboarding","metadata":{"seo":{"title":"Complete onboarding with identity data","description":"Submits full identity data (SSN, DOB, address) to complete the onboarding process after prefill verification. On success, the user is enrolled in Equifax."}},"httpPath":"/users/identity-onboarding"}]},{"type":"group","label":"User - Feature Activation","link":"/client-spec/user-feature-activation","routeSlug":"/client-spec/user-feature-activation","items":[{"label":"Activate features for a dormant user","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/client-spec/user-feature-activation/activatefeatures","routeSlug":"/client-spec/user-feature-activation/activatefeatures","metadata":{"seo":{"title":"Activate features for a dormant user","description":"Turns on the host's credit-monitoring features (scores, reports, alerts) for a dormant user — one that was enrolled through identity verification but without any active features. This is the only endpoint that activates features for a dormant user; standard users receive their features automatically at enrollment."}},"httpPath":"/users/activate-features"}]},{"type":"group","label":"User - Credit Scores","link":"/client-spec/user-credit-scores","routeSlug":"/client-spec/user-credit-scores","items":[{"label":"Get latest credit scores","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/client-spec/user-credit-scores/getefxlatestscores","routeSlug":"/client-spec/user-credit-scores/getefxlatestscores","metadata":{"seo":{"title":"Get latest credit scores","description":"Returns the most recent credit score for the authenticated user including score ranges and score factors."}},"httpPath":"/users/efx-latest-scores"},{"label":"Get latest scores across the user's bureaus","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/client-spec/user-credit-scores/getlatestscores","routeSlug":"/client-spec/user-credit-scores/getlatestscores","metadata":{"seo":{"title":"Get latest scores across the user's bureaus","description":"Returns the user's latest credit score from every bureau enabled on their host - Equifax, TransUnion, Experian - in a single response."}},"httpPath":"/users/latest-scores"},{"label":"Get credit score history","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/client-spec/user-credit-scores/getefxscorehistory","routeSlug":"/client-spec/user-credit-scores/getefxscorehistory","metadata":{"seo":{"title":"Get credit score history","description":"Returns the credit score history for the authenticated user, showing how their score has changed over time."}},"httpPath":"/users/efx-score-history"}]},{"type":"group","label":"User - Score Up","link":"/client-spec/user-score-up","routeSlug":"/client-spec/user-score-up","items":[{"label":"Get Score Up recommendations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/client-spec/user-score-up/getscoreup","routeSlug":"/client-spec/user-score-up/getscoreup","metadata":{"seo":{"title":"Get Score Up recommendations","description":"Returns personalized credit score improvement recommendations based on the user's current credit profile. Includes direct and possible pathways with projected score increase."}},"httpPath":"/users/efx-score-up"}]},{"type":"group","label":"User - Credit Reports","link":"/client-spec/user-credit-reports","routeSlug":"/client-spec/user-credit-reports","items":[{"label":"Get latest credit report","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/client-spec/user-credit-reports/efxlatestreport","routeSlug":"/client-spec/user-credit-reports/efxlatestreport","metadata":{"seo":{"title":"Get latest credit report","description":"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."}},"httpPath":"/users/efx-latest-report"},{"label":"Get latest reports across the user's bureaus","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/client-spec/user-credit-reports/getlatestreport","routeSlug":"/client-spec/user-credit-reports/getlatestreport","metadata":{"seo":{"title":"Get latest reports across the user's bureaus","description":"Returns the user's latest credit report from every bureau enabled on their host - Equifax, TransUnion, Experian - in a single response."}},"httpPath":"/users/latest-report"},{"label":"Get credit report summary","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/client-spec/user-credit-reports/efxlatestreportsummary","routeSlug":"/client-spec/user-credit-reports/efxlatestreportsummary","metadata":{"seo":{"title":"Get credit report summary","description":"Returns a summarized view of the latest credit report including total open accounts, negative accounts, inquiries, collections, and credit history length."}},"httpPath":"/users/efx-latest-report/summary"},{"label":"Get all credit reports","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/client-spec/user-credit-reports/getallencryptedreports","routeSlug":"/client-spec/user-credit-reports/getallencryptedreports","metadata":{"seo":{"title":"Get all credit reports","description":"Returns all credit reports from history for the authenticated user including total report count."}},"httpPath":"/users/credit-reports"},{"label":"Get credit report metadata","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/client-spec/user-credit-reports/getencryptedreportmetadata","routeSlug":"/client-spec/user-credit-reports/getencryptedreportmetadata","metadata":{"seo":{"title":"Get credit report metadata","description":"Returns metadata for all credit reports without the report data itself. Useful for listing available reports and their dates before fetching full reports."}},"httpPath":"/users/credit-reports-metadata"},{"label":"Get credit report by ID or offset","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/client-spec/user-credit-reports/getencryptedreport","routeSlug":"/client-spec/user-credit-reports/getencryptedreport","metadata":{"seo":{"title":"Get credit report by ID or offset","description":"Returns a single credit report from history."}},"httpPath":"/users/credit-report"},{"label":"Download latest credit report as PDF","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/client-spec/user-credit-reports/getreportpdf","routeSlug":"/client-spec/user-credit-reports/getreportpdf","metadata":{"seo":{"title":"Download latest credit report as PDF","description":"Downloads the latest credit report in PDF format. Returns PDF bytes on success (application/pdf) or application/json error response on failure."}},"httpPath":"/users/efx-latest-report-pdf"}]},{"type":"group","label":"User - Alerts Monitoring","link":"/client-spec/user-alerts-monitoring","routeSlug":"/client-spec/user-alerts-monitoring","items":[{"label":"Get credit monitoring alerts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/client-spec/user-alerts-monitoring/getefxalerts","routeSlug":"/client-spec/user-alerts-monitoring/getefxalerts","metadata":{"seo":{"title":"Get credit monitoring alerts","description":"Returns a list of credit monitoring alerts for the authenticated user. Each alert contains basic information such as type, category, and reported date."}},"httpPath":"/users/efx-alerts"},{"label":"Get single alert by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/client-spec/user-alerts-monitoring/getefxalert","routeSlug":"/client-spec/user-alerts-monitoring/getefxalert","metadata":{"seo":{"title":"Get single alert by ID","description":"Returns the full details of a specific credit monitoring alert including alert-specific details like creditor name and account type."}},"httpPath":"/users/efx-alerts/{alertId}"},{"label":"Get all alerts with full details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/client-spec/user-alerts-monitoring/getefxalertswithdetails","routeSlug":"/client-spec/user-alerts-monitoring/getefxalertswithdetails","metadata":{"seo":{"title":"Get all alerts with full details","description":"Returns all credit monitoring alerts for the authenticated user with full details for each alert."}},"httpPath":"/users/efx-alerts-details"}]},{"type":"group","label":"User - Optimal Path","link":"/client-spec/user-optimal-path","routeSlug":"/client-spec/user-optimal-path","items":[{"label":"Get current optimal path plan","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/client-spec/user-optimal-path/getoptimalpathplan","routeSlug":"/client-spec/user-optimal-path/getoptimalpathplan","metadata":{"seo":{"title":"Get current optimal path plan","description":"Returns the user's current Optimal Path plan including score projections, recommendations, and progress tracking."}},"httpPath":"/users/efx-optimal-path"},{"label":"Generate a new optimal path plan","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/client-spec/user-optimal-path/generateoptimalpathplan","routeSlug":"/client-spec/user-optimal-path/generateoptimalpathplan","metadata":{"seo":{"title":"Generate a new optimal path plan","description":"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."}},"httpPath":"/users/efx-optimal-path"},{"label":"Get optimal path plan by config view","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/client-spec/user-optimal-path/getoptimalpathplanbyconfig","routeSlug":"/client-spec/user-optimal-path/getoptimalpathplanbyconfig","metadata":{"seo":{"title":"Get optimal path plan by config view","description":"Returns a specific view of the Optimal Path plan."}},"httpPath":"/users/efx-optimal-path/{config}"}]},{"type":"group","label":"User - Push Notifications","link":"/client-spec/user-push-notifications","routeSlug":"/client-spec/user-push-notifications","items":[{"label":"Update push notification settings","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/client-spec/user-push-notifications/updatepushsettings","routeSlug":"/client-spec/user-push-notifications/updatepushsettings","metadata":{"seo":{"title":"Update push notification settings","description":"Enables or disables push notifications for the authenticated user."}},"httpPath":"/users/push-settings"},{"label":"Register push notification token","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/client-spec/user-push-notifications/registerpushtoken","routeSlug":"/client-spec/user-push-notifications/registerpushtoken","metadata":{"seo":{"title":"Register push notification token","description":"Registers a device push notification token for the authenticated user. Supports iOS (APNs) and Android (FCM) platforms."}},"httpPath":"/users/push-token"},{"label":"Remove push notification token","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/client-spec/user-push-notifications/unregisterpushtoken","routeSlug":"/client-spec/user-push-notifications/unregisterpushtoken","metadata":{"seo":{"title":"Remove push notification token","description":"Removes the push notification token and unregisters the device from push notifications."}},"httpPath":"/users/push-token"},{"label":"Send test push notification","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/client-spec/user-push-notifications/sendtestpushnotification","routeSlug":"/client-spec/user-push-notifications/sendtestpushnotification","metadata":{"seo":{"title":"Send test push notification","description":"Sends a test push notification to the authenticated user's registered device. Optionally accepts a JSON body with title, message, and imageUrl fields."}},"httpPath":"/users/push-test"}]},{"type":"separator","label":"API › Integration Flows"},{"type":"group","label":"Identity Verification (Digital Identity Trust + Secure Multi-Factor Authentication)","link":"/client-spec/identity-verification-(digital-identity-trust-+-secure-multi-factor-authentication)","routeSlug":"/client-spec/identity-verification-(digital-identity-trust-+-secure-multi-factor-authentication)","items":[{"label":"Authenticate and obtain JWT tokens","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/client-spec/identity-verification-(digital-identity-trust-+-secure-multi-factor-authentication)/login","routeSlug":"/client-spec/identity-verification-(digital-identity-trust-+-secure-multi-factor-authentication)/login","metadata":{"seo":{"title":"Authenticate and obtain JWT tokens","description":"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 for all /direct/* endpoints."}},"httpPath":"/direct/login"},{"label":"Register a new user","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/client-spec/identity-verification-(digital-identity-trust-+-secure-multi-factor-authentication)/register","routeSlug":"/client-spec/identity-verification-(digital-identity-trust-+-secure-multi-factor-authentication)/register","metadata":{"seo":{"title":"Register a new user","description":"Registers a new user under the authenticated host and returns the user data."}},"httpPath":"/direct/user-reg"},{"label":"Get pre-auth token by user ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/client-spec/identity-verification-(digital-identity-trust-+-secure-multi-factor-authentication)/preauthtoken_1","routeSlug":"/client-spec/identity-verification-(digital-identity-trust-+-secure-multi-factor-authentication)/preauthtoken_1","metadata":{"seo":{"title":"Get pre-auth token by user ID","description":"Generates a short-lived pre-auth token for the specified user."}},"httpPath":"/direct/preauth-token/{id}"},{"label":"Exchange pre-auth token for session","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/client-spec/identity-verification-(digital-identity-trust-+-secure-multi-factor-authentication)/exchangepreauthtoken","routeSlug":"/client-spec/identity-verification-(digital-identity-trust-+-secure-multi-factor-authentication)/exchangepreauthtoken","metadata":{"seo":{"title":"Exchange pre-auth token for session","description":"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 tokens."}},"httpPath":"/users/preauth-token/{preauthToken}"},{"label":"Submit identity data for DIT verification","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/client-spec/identity-verification-(digital-identity-trust-+-secure-multi-factor-authentication)/postditverifyidentity","routeSlug":"/client-spec/identity-verification-(digital-identity-trust-+-secure-multi-factor-authentication)/postditverifyidentity","metadata":{"seo":{"title":"Submit identity data for DIT verification","description":"Submits personal identity information (name, SSN, DOB, address) for Digital Identity Trust verification."}},"httpPath":"/users/dit-identity"},{"label":"Send SMFA verification link","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/client-spec/identity-verification-(digital-identity-trust-+-secure-multi-factor-authentication)/postsmfasendlink","routeSlug":"/client-spec/identity-verification-(digital-identity-trust-+-secure-multi-factor-authentication)/postsmfasendlink","metadata":{"seo":{"title":"Send SMFA verification link","description":"Sends a Secure Multi-Factor Authentication link to the user's mobile device or email."}},"httpPath":"/users/smfa-send-link/{ditToken}"},{"label":"Verify SMFA status and complete enrollment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/client-spec/identity-verification-(digital-identity-trust-+-secure-multi-factor-authentication)/postsmfaverifystatus","routeSlug":"/client-spec/identity-verification-(digital-identity-trust-+-secure-multi-factor-authentication)/postsmfaverifystatus","metadata":{"seo":{"title":"Verify SMFA status and complete enrollment","description":"Checks whether the user completed the SMFA link verification on their mobile device or email. On success, the user is enrolled in Equifax and credit monitoring features are activated."}},"httpPath":"/users/smfa-verify-status/{smfaToken}"}]},{"type":"group","label":"Identity Verification (Digital Identity Trust + Customer OTP)","link":"/client-spec/identity-verification-(digital-identity-trust-+-customer-otp)","routeSlug":"/client-spec/identity-verification-(digital-identity-trust-+-customer-otp)","items":[{"label":"Authenticate and obtain JWT tokens","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/client-spec/identity-verification-(digital-identity-trust-+-customer-otp)/login","routeSlug":"/client-spec/identity-verification-(digital-identity-trust-+-customer-otp)/login","metadata":{"seo":{"title":"Authenticate and obtain JWT tokens","description":"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 for all /direct/* endpoints."}},"httpPath":"/direct/login"},{"label":"Register a new user","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/client-spec/identity-verification-(digital-identity-trust-+-customer-otp)/register","routeSlug":"/client-spec/identity-verification-(digital-identity-trust-+-customer-otp)/register","metadata":{"seo":{"title":"Register a new user","description":"Registers a new user under the authenticated host and returns the user data."}},"httpPath":"/direct/user-reg"},{"label":"Get pre-auth token by user ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/client-spec/identity-verification-(digital-identity-trust-+-customer-otp)/preauthtoken_1","routeSlug":"/client-spec/identity-verification-(digital-identity-trust-+-customer-otp)/preauthtoken_1","metadata":{"seo":{"title":"Get pre-auth token by user ID","description":"Generates a short-lived pre-auth token for the specified user."}},"httpPath":"/direct/preauth-token/{id}"},{"label":"Exchange pre-auth token for session","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/client-spec/identity-verification-(digital-identity-trust-+-customer-otp)/exchangepreauthtoken","routeSlug":"/client-spec/identity-verification-(digital-identity-trust-+-customer-otp)/exchangepreauthtoken","metadata":{"seo":{"title":"Exchange pre-auth token for session","description":"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 tokens."}},"httpPath":"/users/preauth-token/{preauthToken}"},{"label":"Submit identity data for DIT verification","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/client-spec/identity-verification-(digital-identity-trust-+-customer-otp)/postditverifyidentity","routeSlug":"/client-spec/identity-verification-(digital-identity-trust-+-customer-otp)/postditverifyidentity","metadata":{"seo":{"title":"Submit identity data for DIT verification","description":"Submits personal identity information (name, SSN, DOB, address) for Digital Identity Trust verification."}},"httpPath":"/users/dit-identity"},{"label":"Confirm user verification","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/client-spec/identity-verification-(digital-identity-trust-+-customer-otp)/confirmuserverification","routeSlug":"/client-spec/identity-verification-(digital-identity-trust-+-customer-otp)/confirmuserverification","metadata":{"seo":{"title":"Confirm user verification","description":"Records that the customer has independently verified a user's identity (Digital Identity Trust + Customer OTP flow)."}},"httpPath":"/direct/verify-user"},{"label":"Begin enrollment after customer verification","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/client-spec/identity-verification-(digital-identity-trust-+-customer-otp)/beginenrollment","routeSlug":"/client-spec/identity-verification-(digital-identity-trust-+-customer-otp)/beginenrollment","metadata":{"seo":{"title":"Begin enrollment after customer verification","description":"Initiates Equifax enrollment for a user who has passed DIT verification and been verified by the customer via OTP."}},"httpPath":"/users/begin-enrollment/{smfaToken}"}]},{"type":"group","label":"Identity Verification (Prefill + Onboarding)","link":"/client-spec/identity-verification-(prefill-+-onboarding)","routeSlug":"/client-spec/identity-verification-(prefill-+-onboarding)","items":[{"label":"Authenticate and obtain JWT tokens","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/client-spec/identity-verification-(prefill-+-onboarding)/login","routeSlug":"/client-spec/identity-verification-(prefill-+-onboarding)/login","metadata":{"seo":{"title":"Authenticate and obtain JWT tokens","description":"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 for all /direct/* endpoints."}},"httpPath":"/direct/login"},{"label":"Register a new user","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/client-spec/identity-verification-(prefill-+-onboarding)/register","routeSlug":"/client-spec/identity-verification-(prefill-+-onboarding)/register","metadata":{"seo":{"title":"Register a new user","description":"Registers a new user under the authenticated host and returns the user data."}},"httpPath":"/direct/user-reg"},{"label":"Get pre-auth token by user ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/client-spec/identity-verification-(prefill-+-onboarding)/preauthtoken_1","routeSlug":"/client-spec/identity-verification-(prefill-+-onboarding)/preauthtoken_1","metadata":{"seo":{"title":"Get pre-auth token by user ID","description":"Generates a short-lived pre-auth token for the specified user."}},"httpPath":"/direct/preauth-token/{id}"},{"label":"Exchange pre-auth token for session","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/client-spec/identity-verification-(prefill-+-onboarding)/exchangepreauthtoken","routeSlug":"/client-spec/identity-verification-(prefill-+-onboarding)/exchangepreauthtoken","metadata":{"seo":{"title":"Exchange pre-auth token for session","description":"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 tokens."}},"httpPath":"/users/preauth-token/{preauthToken}"},{"label":"Start identity prefill verification","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/client-spec/identity-verification-(prefill-+-onboarding)/startidentityprefill","routeSlug":"/client-spec/identity-verification-(prefill-+-onboarding)/startidentityprefill","metadata":{"seo":{"title":"Start identity prefill verification","description":"Initiates identity prefill verification. Submits the user's name and phone number for phone risk assessment. If SNA (Silent Network Authentication) succeeds, OTP is skipped and the user can proceed directly to onboarding. Otherwise, if otpRequired is true in the response, the user must complete OTP verification before onboarding."}},"httpPath":"/users/identity-prefill"},{"label":"Submit OTP for prefill verification","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/client-spec/identity-verification-(prefill-+-onboarding)/submitidentityotp","routeSlug":"/client-spec/identity-verification-(prefill-+-onboarding)/submitidentityotp","metadata":{"seo":{"title":"Submit OTP for prefill verification","description":"Submits the 6-digit OTP code sent to the user's phone during prefill verification. On successful verification, returns prefill data and marks the session as accepted."}},"httpPath":"/users/identity-submit-otp"},{"label":"Resend OTP for prefill verification","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/client-spec/identity-verification-(prefill-+-onboarding)/resendidentityotp","routeSlug":"/client-spec/identity-verification-(prefill-+-onboarding)/resendidentityotp","metadata":{"seo":{"title":"Resend OTP for prefill verification","description":"Resends the OTP code to the user's phone."}},"httpPath":"/users/identity-resend-otp"},{"label":"Complete onboarding with identity data","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/client-spec/identity-verification-(prefill-+-onboarding)/submitidentityonboarding","routeSlug":"/client-spec/identity-verification-(prefill-+-onboarding)/submitidentityonboarding","metadata":{"seo":{"title":"Complete onboarding with identity data","description":"Submits full identity data (SSN, DOB, address) to complete the onboarding process after prefill verification. On success, the user is enrolled in Equifax."}},"httpPath":"/users/identity-onboarding"}]},{"type":"group","label":"Credit Data Access","link":"/client-spec/credit-data-access","routeSlug":"/client-spec/credit-data-access","items":[{"label":"Authenticate and obtain JWT tokens","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/client-spec/credit-data-access/login","routeSlug":"/client-spec/credit-data-access/login","metadata":{"seo":{"title":"Authenticate and obtain JWT tokens","description":"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 for all /direct/* endpoints."}},"httpPath":"/direct/login"},{"label":"Get pre-auth token by user ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/client-spec/credit-data-access/preauthtoken_1","routeSlug":"/client-spec/credit-data-access/preauthtoken_1","metadata":{"seo":{"title":"Get pre-auth token by user ID","description":"Generates a short-lived pre-auth token for the specified user."}},"httpPath":"/direct/preauth-token/{id}"},{"label":"Exchange pre-auth token for session","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/client-spec/credit-data-access/exchangepreauthtoken","routeSlug":"/client-spec/credit-data-access/exchangepreauthtoken","metadata":{"seo":{"title":"Exchange pre-auth token for session","description":"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 tokens."}},"httpPath":"/users/preauth-token/{preauthToken}"},{"label":"Get latest credit scores","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/client-spec/credit-data-access/getefxlatestscores","routeSlug":"/client-spec/credit-data-access/getefxlatestscores","metadata":{"seo":{"title":"Get latest credit scores","description":"Returns the most recent credit score for the authenticated user including score ranges and score factors."}},"httpPath":"/users/efx-latest-scores"},{"label":"Get latest scores across the user's bureaus","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/client-spec/credit-data-access/getlatestscores","routeSlug":"/client-spec/credit-data-access/getlatestscores","metadata":{"seo":{"title":"Get latest scores across the user's bureaus","description":"Returns the user's latest credit score from every bureau enabled on their host - Equifax, TransUnion, Experian - in a single response."}},"httpPath":"/users/latest-scores"},{"label":"Get credit score history","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/client-spec/credit-data-access/getefxscorehistory","routeSlug":"/client-spec/credit-data-access/getefxscorehistory","metadata":{"seo":{"title":"Get credit score history","description":"Returns the credit score history for the authenticated user, showing how their score has changed over time."}},"httpPath":"/users/efx-score-history"},{"label":"Get Score Up recommendations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/client-spec/credit-data-access/getscoreup","routeSlug":"/client-spec/credit-data-access/getscoreup","metadata":{"seo":{"title":"Get Score Up recommendations","description":"Returns personalized credit score improvement recommendations based on the user's current credit profile. Includes direct and possible pathways with projected score increase."}},"httpPath":"/users/efx-score-up"},{"label":"Get latest credit report","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/client-spec/credit-data-access/efxlatestreport","routeSlug":"/client-spec/credit-data-access/efxlatestreport","metadata":{"seo":{"title":"Get latest credit report","description":"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."}},"httpPath":"/users/efx-latest-report"},{"label":"Get latest reports across the user's bureaus","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/client-spec/credit-data-access/getlatestreport","routeSlug":"/client-spec/credit-data-access/getlatestreport","metadata":{"seo":{"title":"Get latest reports across the user's bureaus","description":"Returns the user's latest credit report from every bureau enabled on their host - Equifax, TransUnion, Experian - in a single response."}},"httpPath":"/users/latest-report"},{"label":"Get credit report summary","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/client-spec/credit-data-access/efxlatestreportsummary","routeSlug":"/client-spec/credit-data-access/efxlatestreportsummary","metadata":{"seo":{"title":"Get credit report summary","description":"Returns a summarized view of the latest credit report including total open accounts, negative accounts, inquiries, collections, and credit history length."}},"httpPath":"/users/efx-latest-report/summary"},{"label":"Get all credit reports","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/client-spec/credit-data-access/getallencryptedreports","routeSlug":"/client-spec/credit-data-access/getallencryptedreports","metadata":{"seo":{"title":"Get all credit reports","description":"Returns all credit reports from history for the authenticated user including total report count."}},"httpPath":"/users/credit-reports"},{"label":"Get credit report metadata","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/client-spec/credit-data-access/getencryptedreportmetadata","routeSlug":"/client-spec/credit-data-access/getencryptedreportmetadata","metadata":{"seo":{"title":"Get credit report metadata","description":"Returns metadata for all credit reports without the report data itself. Useful for listing available reports and their dates before fetching full reports."}},"httpPath":"/users/credit-reports-metadata"},{"label":"Get credit report by ID or offset","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/client-spec/credit-data-access/getencryptedreport","routeSlug":"/client-spec/credit-data-access/getencryptedreport","metadata":{"seo":{"title":"Get credit report by ID or offset","description":"Returns a single credit report from history."}},"httpPath":"/users/credit-report"},{"label":"Download latest credit report as PDF","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/client-spec/credit-data-access/getreportpdf","routeSlug":"/client-spec/credit-data-access/getreportpdf","metadata":{"seo":{"title":"Download latest credit report as PDF","description":"Downloads the latest credit report in PDF format. Returns PDF bytes on success (application/pdf) or application/json error response on failure."}},"httpPath":"/users/efx-latest-report-pdf"},{"label":"Get credit monitoring alerts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/client-spec/credit-data-access/getefxalerts","routeSlug":"/client-spec/credit-data-access/getefxalerts","metadata":{"seo":{"title":"Get credit monitoring alerts","description":"Returns a list of credit monitoring alerts for the authenticated user. Each alert contains basic information such as type, category, and reported date."}},"httpPath":"/users/efx-alerts"},{"label":"Get single alert by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/client-spec/credit-data-access/getefxalert","routeSlug":"/client-spec/credit-data-access/getefxalert","metadata":{"seo":{"title":"Get single alert by ID","description":"Returns the full details of a specific credit monitoring alert including alert-specific details like creditor name and account type."}},"httpPath":"/users/efx-alerts/{alertId}"},{"label":"Get all alerts with full details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/client-spec/credit-data-access/getefxalertswithdetails","routeSlug":"/client-spec/credit-data-access/getefxalertswithdetails","metadata":{"seo":{"title":"Get all alerts with full details","description":"Returns all credit monitoring alerts for the authenticated user with full details for each alert."}},"httpPath":"/users/efx-alerts-details"},{"label":"Get current optimal path plan","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/client-spec/credit-data-access/getoptimalpathplan","routeSlug":"/client-spec/credit-data-access/getoptimalpathplan","metadata":{"seo":{"title":"Get current optimal path plan","description":"Returns the user's current Optimal Path plan including score projections, recommendations, and progress tracking."}},"httpPath":"/users/efx-optimal-path"},{"label":"Generate a new optimal path plan","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/client-spec/credit-data-access/generateoptimalpathplan","routeSlug":"/client-spec/credit-data-access/generateoptimalpathplan","metadata":{"seo":{"title":"Generate a new optimal path plan","description":"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."}},"httpPath":"/users/efx-optimal-path"},{"label":"Get optimal path plan by config view","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/client-spec/credit-data-access/getoptimalpathplanbyconfig","routeSlug":"/client-spec/credit-data-access/getoptimalpathplanbyconfig","metadata":{"seo":{"title":"Get optimal path plan by config view","description":"Returns a specific view of the Optimal Path plan."}},"httpPath":"/users/efx-optimal-path/{config}"}]},{"type":"group","label":"Account Lifecycle Management","link":"/client-spec/account-lifecycle-management","routeSlug":"/client-spec/account-lifecycle-management","items":[{"label":"Authenticate and obtain JWT tokens","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/client-spec/account-lifecycle-management/login","routeSlug":"/client-spec/account-lifecycle-management/login","metadata":{"seo":{"title":"Authenticate and obtain JWT tokens","description":"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 for all /direct/* endpoints."}},"httpPath":"/direct/login"},{"label":"Confirm user verification","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/client-spec/account-lifecycle-management/confirmuserverification","routeSlug":"/client-spec/account-lifecycle-management/confirmuserverification","metadata":{"seo":{"title":"Confirm user verification","description":"Records that the customer has independently verified a user's identity (Digital Identity Trust + Customer OTP flow)."}},"httpPath":"/direct/verify-user"},{"label":"Get user details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/client-spec/account-lifecycle-management/getuser_1","routeSlug":"/client-spec/account-lifecycle-management/getuser_1","metadata":{"seo":{"title":"Get user details","description":"Returns the full profile for a user including enrollment status, notification preferences, and feature flags."}},"httpPath":"/direct/user/{id}"},{"label":"Change user email","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/client-spec/account-lifecycle-management/changeemail","routeSlug":"/client-spec/account-lifecycle-management/changeemail","metadata":{"seo":{"title":"Change user email","description":"Updates the email address for the specified user."}},"httpPath":"/direct/change-email/{id}"},{"label":"Change user mobile number","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/client-spec/account-lifecycle-management/changemobile","routeSlug":"/client-spec/account-lifecycle-management/changemobile","metadata":{"seo":{"title":"Change user mobile number","description":"Updates the mobile number for the specified user."}},"httpPath":"/direct/change-mobile/{id}"},{"label":"Change user name","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/client-spec/account-lifecycle-management/changename","routeSlug":"/client-spec/account-lifecycle-management/changename","metadata":{"seo":{"title":"Change user name","description":"Updates the first and last name for the specified user."}},"httpPath":"/direct/change-name/{id}"},{"label":"Pause user enrollment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/client-spec/account-lifecycle-management/pauseenrollment","routeSlug":"/client-spec/account-lifecycle-management/pauseenrollment","metadata":{"seo":{"title":"Pause user enrollment","description":"Pauses a single user by removing all Equifax features and marking them as paused. Paused users cannot pull credit data and are effectively disabled until resumed."}},"httpPath":"/direct/users/{userId}/pause-enrollment"},{"label":"Resume user enrollment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/client-spec/account-lifecycle-management/resumeenrollment","routeSlug":"/client-spec/account-lifecycle-management/resumeenrollment","metadata":{"seo":{"title":"Resume user enrollment","description":"Resumes a paused user by re-enrolling Equifax features and marking them as active. Once resumed, the user can pull credit data again."}},"httpPath":"/direct/users/{userId}/resume-enrollment"},{"label":"Batch pause user enrollments","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/client-spec/account-lifecycle-management/pauseenrollmentsbatch","routeSlug":"/client-spec/account-lifecycle-management/pauseenrollmentsbatch","metadata":{"seo":{"title":"Batch pause user enrollments","description":"Submits a batch request to pause multiple user enrollments. Users are added to the enrollment queue and processed asynchronously. Paused users cannot pull credit data and are effectively disabled until resumed."}},"httpPath":"/direct/users/pause-enrollments"},{"label":"Batch resume user enrollments","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/client-spec/account-lifecycle-management/resumeenrollmentsbatch","routeSlug":"/client-spec/account-lifecycle-management/resumeenrollmentsbatch","metadata":{"seo":{"title":"Batch resume user enrollments","description":"Submits a batch request to resume multiple paused user enrollments. Users are added to the enrollment queue and processed asynchronously. Once resumed, users can pull credit data again."}},"httpPath":"/direct/users/resume-enrollments"},{"label":"Move user to different host","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/client-spec/account-lifecycle-management/changehost","routeSlug":"/client-spec/account-lifecycle-management/changehost","metadata":{"seo":{"title":"Move user to different host","description":"Transfers a user to a different host within the same customer. Can be used to upgrade or downgrade a user's credit data access, for example moving from a 1-bureau host to a 3-bureau host or vice versa."}},"httpPath":"/direct/change-host/{id}"},{"label":"Force credit data refresh","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/client-spec/account-lifecycle-management/updaterefresh","routeSlug":"/client-spec/account-lifecycle-management/updaterefresh","metadata":{"seo":{"title":"Force credit data refresh","description":"Triggers a refresh of the user's credit data from Equifax. Does not return the refreshed data, only triggers the refresh."}},"httpPath":"/direct/update-refresh/{id}"},{"label":"Clear user cache","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/client-spec/account-lifecycle-management/resetcache","routeSlug":"/client-spec/account-lifecycle-management/resetcache","metadata":{"seo":{"title":"Clear user cache","description":"Clears the cached credit report and score data for the specified user. The next data request will fetch fresh data from Equifax."}},"httpPath":"/direct/reset-cache/{id}"},{"label":"Close account by user ID","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/client-spec/account-lifecycle-management/closeaccount","routeSlug":"/client-spec/account-lifecycle-management/closeaccount","metadata":{"seo":{"title":"Close account by user ID","description":"Closes the user account and unenrolls from Equifax."}},"httpPath":"/direct/close-account/{id}"},{"label":"Close account by email","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/client-spec/account-lifecycle-management/closeaccountbyemail","routeSlug":"/client-spec/account-lifecycle-management/closeaccountbyemail","metadata":{"seo":{"title":"Close account by email","description":"Closes the user account identified by email address and unenrolls from Equifax."}},"httpPath":"/direct/close-account"},{"label":"Batch close accounts","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/client-spec/account-lifecycle-management/closeaccountsbatch","routeSlug":"/client-spec/account-lifecycle-management/closeaccountsbatch","metadata":{"seo":{"title":"Batch close accounts","description":"Submits a batch request to close multiple user accounts. Users are added to the unenrollment queue and processed asynchronously."}},"httpPath":"/direct/close-accounts"},{"label":"Store user identity","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/client-spec/account-lifecycle-management/storeidentity","routeSlug":"/client-spec/account-lifecycle-management/storeidentity","metadata":{"seo":{"title":"Store user identity","description":"Stores a user's PII — use it to add details for a user who has none stored, or to update what is already there."}},"httpPath":"/direct/users/{userId}/identity"}]},{"type":"group","label":"Offers IQ Flow","link":"/client-spec/offers-iq-flow","routeSlug":"/client-spec/offers-iq-flow","items":[{"label":"Authenticate and obtain JWT tokens","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/client-spec/offers-iq-flow/login","routeSlug":"/client-spec/offers-iq-flow/login","metadata":{"seo":{"title":"Authenticate and obtain JWT tokens","description":"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 for all /direct/* endpoints."}},"httpPath":"/direct/login"},{"label":"Perform Offers IQ","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/client-spec/offers-iq-flow/performprescreening","routeSlug":"/client-spec/offers-iq-flow/performprescreening","metadata":{"seo":{"title":"Perform Offers IQ","description":"Performs real-time Offers IQ by evaluating consumer information against configurable rule sets and Equifax credit data. The API retrieves credit information from Equifax OneView, applies business rules (credit score thresholds, debt-to-income ratios, etc.), and returns an instant approval decision. Supports NO HIT scenarios for consumers with no credit history."}},"httpPath":"/direct/credit-pre-screening"},{"label":"Get Offers IQ result","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/client-spec/offers-iq-flow/getprescreeningresult","routeSlug":"/client-spec/offers-iq-flow/getprescreeningresult","metadata":{"seo":{"title":"Get Offers IQ result","description":"Retrieves a previously completed Offers IQ result by its unique request ID."}},"httpPath":"/direct/credit-pre-screening/{requestId}"},{"label":"List supported rule-evaluation attributes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/client-spec/offers-iq-flow/getsupportedattributes","routeSlug":"/client-spec/offers-iq-flow/getsupportedattributes","metadata":{"seo":{"title":"List supported rule-evaluation attributes","description":"Returns the catalog of Equifax Credit Metrics (ECM) attributes that can be used as attributeCode values in Offers IQ rule sets. Each entry carries the value type (INTEGER/DOUBLE/BOOLEAN), unit (DOLLARS/PERCENT/COUNT/FLAG/SCORE/MONTHS), bucket, and a description — everything needed to render a rule-configuration UI."}},"httpPath":"/direct/credit-pre-screening/attributes"}]},{"type":"group","label":"Prefill Products Flow","link":"/client-spec/prefill-products-flow","routeSlug":"/client-spec/prefill-products-flow","items":[{"label":"Authenticate and obtain JWT tokens","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/client-spec/prefill-products-flow/login","routeSlug":"/client-spec/prefill-products-flow/login","metadata":{"seo":{"title":"Authenticate and obtain JWT tokens","description":"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 for all /direct/* endpoints."}},"httpPath":"/direct/login"},{"label":"Address Prefill","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/client-spec/prefill-products-flow/unifiedreverse","routeSlug":"/client-spec/prefill-products-flow/unifiedreverse","metadata":{"seo":{"title":"Address Prefill","description":"Resolves a consumer's identity and postal address from minimal contact information. Send a phone number and/or email (optionally a first and last name) and receive the matching person + address records."}},"httpPath":"/direct/address-prefill"},{"label":"Data Prefill — retrieve by transaction id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/client-spec/prefill-products-flow/gettransaction","routeSlug":"/client-spec/prefill-products-flow/gettransaction","metadata":{"seo":{"title":"Data Prefill — retrieve by transaction id","description":"Retrieves a previously returned Prefill result by its transactionId. Returns the same response body the original lookup produced. The result is scoped to the requesting host."}},"httpPath":"/direct/data-prefill/{transactionId}"}]}]}