Metro 2 API Developer Center

    This documentation reflects the current public `/api/v1` contract, including ingest, file operations, webhooks, disputes, CRA responses, scheduling, and audit-history access.

    Current Contract

    • Public API-key endpoints include ingest, file upload/process/status, webhooks, disputes, CRA responses, scheduling, audit history/export, data deletion, and the RentVine routes under `/api/v1`.
    • API key management is implemented at `/api/v1/api-keys`, but it uses authenticated admin dashboard sessions rather than API-key auth.
    • The dashboard still uses internal routes such as `/api/webhooks`, `/api/disputes`, `/api/cra-responses`, `/api/submission-schedules`, and `/api/audit-log`, but equivalent public integration routes now exist under `/api/v1`.

    Public API

    Getting Started

    Authentication, base URL, live vs test keys, and the current supported public API surface.

    API Reference

    Versioned `/api/v1` endpoints for ingest, file operations, webhooks, disputes, CRA responses, scheduling, audit exports, and RentVine.

    First Submission

    Submit records, poll batch status, and use the file-based ingest flow with the current handlers.

    Operational Guides

    Webhooks

    Public API routes under `/api/v1/webhooks`, including test delivery, replay, and recent-delivery retrieval.

    Consumer Disputes

    Public dispute lifecycle routes under `/api/v1/disputes` with notes and resolution handlers.

    CRA Responses

    Public CRA response upload, listing, and detail retrieval under `/api/v1/cra-responses`.

    Scheduling

    Per-bureau scheduling is available under `/api/v1/schedules` with create, update, list, and delete support.

    Reference Files