REremihq
HIC

Homeowner Contract Details

Get homeowner contract status and related dates for a bid request. Returns signature status, sent date, signed date, and other contract-related information.

get/v0/homeowner-contract

Request

  • Base URL
    https://api.remihq.com
  • URL
    https://api.remihq.com/v0/homeowner-contract
  • Auth
    API key in header x-remi-key

Query parameters

idstring required

Unique identifier of the bid request

Example:XXXX1234
organizationIdstring

Organization to which the bid request belongs

Example:remi

Response

Contract status retrieved successfully

status'completed' | 'voided' | 'draft' | 'sent' | 'viewed' | 'uploaded' | 'declined' required

Status of the Home Improvement Contract (HIC) - whether it has been signed or not

sentDatestring nullable required

The date and time the HIC was sent to the homeowner

signedDatestring nullable required

The date and time the HIC was signed by the homeowner

lastViewedDatestring nullable required

The date and time the HIC was last viewed by the homeowner

createdDatestring required

The date and time the resource was created

expiresDatestring nullable required

The date and time the HIC will expire

Example response

{
  "status": "completed",
  "sentDate": "2024-01-01T00:00:00.000Z",
  "signedDate": "2024-01-01T12:30:00.000Z",
  "lastViewedDate": "2024-01-01T00:00:00.000Z",
  "createdDate": "2024-01-01T00:00:00.000Z",
  "expiresDate": "2024-01-01T00:00:00.000Z"
}

Changes

No recorded changes to this operation across all 3 revisions of this API.