Create Your First Report

In AcuCheck, the first object you typically create is a customer report request. A report request initiates the collection of customer financial information and serves as the foundation for debt-to-income (DTI) calculation and affordability assessment.

Before creating a report request, you must authenticate using the login endpoint and include the issued access token in the Authorization header of all subsequent requests. You can optionally confirm that the session is active by calling the authentication status endpoint.

To generate a report, your integration performs the following high-level actions:
  • Authenticate and establish a session: Authentication is performed using POST /api/v1/auth/login which returns an access token representing the authenticated identity.
  • Create or reference a customer: Customers may be created or reused as part of the reporting workflow using the customer management endpoints. Customer records are reused across reports to maintain continuity and historical traceability.
  • Initiate a report request: A report request is created by submitting a request to the report creation endpoint. This generates a secure report request that is sent to the customer using the configured delivery channels.
  • Track report status and retrieve results: As the customer submits financial information, the report progresses through defined status states. Once completed, the consolidated report data and related outcomes can be retrieved through the report retrieval endpoints.