v2

latestOpenAPI 3.0.02026-08-0793108394.2 KB

Property Claim

Get a property claim by ID

get/v1/property_claims/{property_claim_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 'PropertyClaim' 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

type_of_lossstring nullable required

locale'en' | 'es' | 'fr' required

A BCP47 language tag without any subtags.

Encircle currently only supports a subset of the languages of the world, the allowed values are expected to expand in the future.

adjuster_namestring nullable required

assignment_identifierstring nullable required

Empty strings get coerced to null

cat_codestring nullable required

contents_estimateinteger required

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

contractor_identifierstring nullable required

Empty strings get coerced to null

date_claim_createdstring date required

A RFC 3339 compliant full-date string.

date_of_lossstring date required

A RFC 3339 compliant full-date string.

The provided date MUST be in the past.

default_depreciationnumber nullable required

Represents a percentage value like sales tax or depreciation.

Must be a number greater or equal to 0.

For example, 0.05 represents 5%.

emergency_estimateinteger required

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

full_addressstring nullable required

insurer_identifierstring nullable required

Empty strings get coerced to null

loss_detailsstring nullable required

max_depreciationnumber nullable required

Represents a percentage value like sales tax or depreciation.

Must be a number greater or equal to 0.

For example, 0.05 represents 5%.

policyholder_email_addressstring nullable required

policyholder_namestring nullable required

policyholder_phone_numberstring nullable required

project_manager_namestring nullable required

repair_estimateinteger required

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

sales_taxnumber nullable required

Represents a percentage value like sales tax or depreciation.

Must be a number greater or equal to 0.

For example, 0.05 represents 5%.

broker_or_agent_namestring nullable required

insurance_company_namestring nullable required

policy_numberstring nullable required

Example response

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