v2

latestOpenAPI 3.0.02026-08-0793108394.2 KB

Property Inspection

Get a property inspection by ID

get/v1/property_inspections/{property_inspection_id}

Headers

X-Encircle-Attributionstring

String used to internally identify which integrator made this request on behalf of their users.

Integrators should reuse the same 'X-Encircle-Attribution' value for all their users.

This attribution enables Encircle to provide better assistance to integrators if they encounter any issues.

If not specified, the request will not be associated with any integration services.

X-Encircle-Requeststring

Unique string used to identify each specific request.

Any retries due to connection failures should reuse the same 'X-Encircle-Request' value. This helps prevent duplicate requests from unintentionally being processed again.

If not specified, the request will be treated as unique and it will be processed normally.

Response

A single 'PropertyInspection' object corresponding to the given id.

organization_idstring uuid required

A RFC 4122 compliant UUID in lowercase hexadecimal.

brand_idinteger nullable required

idinteger required

permalink_urlstring required

insurer_identifierstring required

policyholder_namestring nullable required

full_addressstring nullable required

policyholder_email_addressstring nullable required

policyholder_phone_numberstring nullable required

inspection_datestring date required

A RFC 3339 compliant full-date string.

The provided date MUST be in the past.

underwriterstring nullable required

inspection_creatorstring nullable required

estimated_building_valueinteger required

Represents a monetary amount as an integer in hundredths of a dollar. For example, 550 would represent $5.50.

insurance_company_namestring nullable required

insurance_broker_namestring nullable required

policy_numberstring nullable required

policy_renewal_datestring date required

A RFC 3339 compliant full-date string.

Example response

{
  "organization_id": "f81d4fae-7dec-11d0-a765-00a0c91e6bf6",
  "inspection_date": "1969-07-20",
  "policy_renewal_date": "1969-07-20"
}