POST
/
v1
/
rent-reporting
/
report
curl --request POST \
  --url https://sandbox-api.getcove.co/v1/rent-reporting/report \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "leaseStartDate": "<string>",
  "leaseEndDate": "<string>",
  "rentAmount": "<string>",
  "rentPaid": "<string>",
  "currentBalanceDue": 123,
  "amountPastDue": 123,
  "accountStatus": "ACCOUNT_STATUS_UNSPECIFIED",
  "paymentHistoryProfile": "<string>",
  "dateOfFirstDelinquency": "<string>",
  "lastName": "<string>",
  "firstName": "<string>",
  "middleName": "<string>",
  "dateOfBirth": "<string>",
  "phone": "<string>",
  "email": "<string>",
  "ecoaCode": "ECOA_CODE_UNSPECIFIED",
  "address": {
    "street": "<string>",
    "city": "<string>",
    "provinceState": "<string>",
    "country": "<string>",
    "postalCode": "<string>"
  }
}'
{
  "message": "<string>",
  "id": "<string>"
}

Authorizations

Authorization
string
header
required

API authentication token

Body

application/json
leaseStartDate
string
leaseEndDate
string
rentAmount
string
rentPaid
string
currentBalanceDue
number
amountPastDue
number
accountStatus
enum<string>
default:ACCOUNT_STATUS_UNSPECIFIED
Available options:
ACCOUNT_STATUS_UNSPECIFIED,
ACCOUNT_STATUS_IN_GOOD_STANDING,
ACCOUNT_STATUS_30_DAYS_PAST_DUE,
ACCOUNT_STATUS_60_DAYS_PAST_DUE,
ACCOUNT_STATUS_90_DAYS_PAST_DUE,
ACCOUNT_STATUS_120_DAYS_PAST_DUE,
ACCOUNT_STATUS_150_DAYS_PAST_DUE,
ACCOUNT_STATUS_180_DAYS_PAST_DUE
paymentHistoryProfile
string
dateOfFirstDelinquency
string
lastName
string
firstName
string
middleName
string
dateOfBirth
string
phone
string
email
string
ecoaCode
enum<string>
default:ECOA_CODE_UNSPECIFIED
Available options:
ECOA_CODE_UNSPECIFIED,
ECOA_CODE_INDIVIDUAL,
ECOA_CODE_JOINT
address
object

Response

200
application/json
A successful response.
message
string
id
string