# Cove Data Furnishing API

## Docs

- [Create Consumer](https://new.cove.dev/api-reference/consumers/create.md): Register a new consumer with PII. The SSN is encrypted at rest using PGP symmetric encryption and is **never returned** in any API response.
- [Delete Consumer](https://new.cove.dev/api-reference/consumers/delete.md): Soft-deletes the consumer by setting `deleted_at` to the current timestamp. All related tradelines are deactivated (`is_active = false`). The consumer will no longer appear in list results or be accessible by ID.
- [Get Consumer](https://new.cove.dev/api-reference/consumers/get.md): Returns a single consumer by ID. Returns 404 if the consumer does not exist, belongs to a different partner, or has been soft-deleted.
- [List Consumers](https://new.cove.dev/api-reference/consumers/list.md): Returns a paginated list of consumers for the authenticated partner. Soft-deleted consumers are excluded.
- [Update Consumer](https://new.cove.dev/api-reference/consumers/update.md): Partially update a consumer's fields. Only include the fields you want to change. If `ssn` is provided, it will be re-encrypted. At least one field must be provided.
- [API Reference](https://new.cove.dev/api-reference/introduction.md): Complete API reference for the Cove Data Furnishing API
- [List Payments](https://new.cove.dev/api-reference/payments/list.md): Returns a paginated list of payment records for a specific tradeline, ordered by `payment_date` descending. The `tradeline_id` query parameter is required.
- [Report Payment](https://new.cove.dev/api-reference/payments/report.md): Submit a payment against an active tradeline. This automatically updates the tradeline's `account_status`, `current_balance`, `amount_past_due`, `highest_balance`, `payment_history` (24-month rolling string), and `date_of_first_delinquency`.
- [Get Submission](https://new.cove.dev/api-reference/submissions/get.md): Returns a single bureau submission by ID. Returns 404 if the submission does not exist or its tradeline belongs to a different partner.
- [List Submissions](https://new.cove.dev/api-reference/submissions/list.md): Returns a paginated list of bureau submissions for the authenticated partner. Submissions are scoped to the partner via the tradeline's `partner_id`.
- [Trigger Submission](https://new.cove.dev/api-reference/submissions/trigger.md): Manually trigger bureau submission for a specific tradeline. Intended for partners with `submission_frequency = "on_demand"`.
- [Close Tradeline](https://new.cove.dev/api-reference/tradelines/close.md): Closes the tradeline by setting `account_status` to `"closed"`, `is_active` to `false`, and `account_closed_date` to today's date. The tradeline is still returned and visible in list results, but will no longer accept new payments. This is not a hard delete.
- [Create Tradeline](https://new.cove.dev/api-reference/tradelines/create.md): Create a tradeline (ongoing payment obligation) for a consumer.
- [Get Tradeline](https://new.cove.dev/api-reference/tradelines/get.md): Returns a single tradeline by ID. Returns 404 if the tradeline does not exist or belongs to a different partner.
- [List Tradelines](https://new.cove.dev/api-reference/tradelines/list.md): Returns a paginated list of tradelines for the authenticated partner.
- [Update Tradeline](https://new.cove.dev/api-reference/tradelines/update.md): Update mutable fields of a tradeline. Fields that cannot be changed after creation include `consumer_id`, `payment_type`, and `account_opened_date`. At least one field must be provided.
- [Submission Accepted](https://new.cove.dev/api-reference/webhooks/submission-accepted.md)
- [Submission Pending](https://new.cove.dev/api-reference/webhooks/submission-pending.md)
- [Submission Rejected](https://new.cove.dev/api-reference/webhooks/submission-rejected.md)
- [Submission Submitted](https://new.cove.dev/api-reference/webhooks/submission-submitted.md)
- [Tradeline Updated](https://new.cove.dev/api-reference/webhooks/tradeline-updated.md)
- [Authentication](https://new.cove.dev/guides/authentication.md): API key format, environments, and authentication errors
- [Consumers](https://new.cove.dev/guides/consumers.md): Manage consumer records (PII) for credit bureau reporting
- [Base URL & Conventions](https://new.cove.dev/guides/conventions.md): API base URL, data formats, and general conventions
- [Enum Reference](https://new.cove.dev/guides/enums.md): All payment types, status codes, and Metro 2 mappings
- [Error Handling](https://new.cove.dev/guides/errors.md): Error response format, error codes, and troubleshooting tips
- [FAQ & Best Practices](https://new.cove.dev/guides/faq.md): Frequently asked questions and recommended integration patterns
- [Migration Guide](https://new.cove.dev/guides/migration.md): Migrate from the legacy SupportPay API to the Cove Data Furnishing API
- [Pagination](https://new.cove.dev/guides/pagination.md): How pagination works for all list endpoints
- [Payments](https://new.cove.dev/guides/payments.md): Report monthly payments and understand auto-computed tradeline updates
- [Submissions](https://new.cove.dev/guides/submissions.md): Track bureau submission status and trigger on-demand submissions
- [Tradelines](https://new.cove.dev/guides/tradelines.md): Manage tradelines — ongoing payment obligations reported to credit bureaus
- [Webhooks](https://new.cove.dev/guides/webhooks.md): Receive real-time notifications for bureau submission status changes
- [Cove Data Furnishing API](https://new.cove.dev/index.md): Report recurring payments to credit bureaus in Metro 2 format
- [Quick Start](https://new.cove.dev/quickstart.md): Go from zero to a reported payment in 4 steps

## OpenAPI Specs

- [openapi](https://new.cove.dev/api-reference/openapi.yaml)

## Optional

- [GitHub](https://github.com/adyantanver)