Skip to main content
GET
/
tradelines
/
{id}
Get a tradeline
curl --request GET \
  --url https://vvdufluovypptsnkihyv.supabase.co/functions/v1/tradelines/{id} \
  --header 'x-api-key: <api-key>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "consumer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "partner_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "payment_type": "rent",
  "payment_type_label": "<string>",
  "external_account_id": "<string>",
  "account_opened_date": "2023-12-25",
  "account_closed_date": "2023-12-25",
  "payment_amount": 123,
  "payment_frequency": "<string>",
  "credit_limit": 123,
  "highest_balance": 123,
  "original_loan_amount": 123,
  "account_status": "current",
  "current_balance": 123,
  "amount_past_due": 123,
  "ecoa_code": "<string>",
  "metro2_account_type": "<string>",
  "payment_history": "<string>",
  "date_of_first_delinquency": "2023-12-25",
  "report_to_bureaus": [
    "<string>"
  ],
  "is_active": true,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
x-api-key
string
header
required

API key in the format sk_live_<token> (production) or sk_test_<token> (sandbox). Contact Cove to obtain your API key.

Path Parameters

​
id
string<uuid>
required

Resource UUID

Response

Tradeline details

​
id
string<uuid>
​
consumer_id
string<uuid>
​
partner_id
string<uuid>
​
payment_type
enum<string>

Type of recurring payment being reported

Available options:
rent,
child_support,
alimony,
utility,
medical,
insurance,
subscription,
bill_pay,
loan,
custom
​
payment_type_label
string | null
​
external_account_id
string | null
​
account_opened_date
string<date>
​
account_closed_date
string<date> | null
​
payment_amount
integer

In cents

​
payment_frequency
string
​
credit_limit
integer | null

In cents

​
highest_balance
integer | null

In cents

​
original_loan_amount
integer | null

In cents

​
account_status
enum<string>

Current status of the tradeline account (auto-computed from payment reports)

Available options:
current,
late_30,
late_60,
late_90,
late_120,
late_150,
late_180_plus,
paid_in_full,
closed,
transferred,
account_in_dispute
​
current_balance
integer

In cents

​
amount_past_due
integer

In cents

​
ecoa_code
string
​
metro2_account_type
string
​
payment_history
string

24-char Metro 2 payment history (newest first). 0=current, 1=30d, 2=60d, 3=90d, 4=120d, 5=150d, 6=180d+

​
date_of_first_delinquency
string<date> | null

Set on first non-current payment

​
report_to_bureaus
string[]
​
is_active
boolean
​
created_at
string<date-time>
​
updated_at
string<date-time>