Developer Center›Guides

    Implementation Guides

    Guides cover the current public `/api/v1` contract and the related operational workflows available through the platform.

    Public API-Key Guides

    Your First Submission

    Current ingest flow using `/api/v1/submit-metro2-data`, batch status polling, and the file-upload pipeline.

    Batch Processing

    Chunking, partial-failure handling, and polling based on the routes that currently exist.

    Account Number Changes

    Use `l1_segments` or the `change_indicators` alias with the public ingest endpoint.

    Test vs Live Keys

    How `environment: test|live` works today, and which sandbox claims are not currently part of the public contract.

    RentVine Integration

    Implemented RentVine sync and ingest endpoints under `/api/v1/integrations/rentvine/*`.

    Pre-Validation

    Current supported pre-validation options without relying on non-existent `/api/v1/records/validate` routes.

    Operational APIs

    Webhooks

    Public routes under `/api/v1/webhooks`, with event subscriptions, test delivery, replay, and delivery logs.

    Consumer Disputes

    Public dispute intake, note, and resolution routes under `/api/v1/disputes`.

    CRA Responses

    Public CRA response upload and retrieval routes under `/api/v1/cra-responses`.

    Audit Trail

    Public record history and audit export routes under `/api/v1/records/{id}/history` and `/api/v1/audit/export`.

    Scheduling

    Public create/list/update/delete schedule routes under `/api/v1/schedules`.