Run Profile(s)

post

https://api.betterview.net/api/properties

Send an array of addresses to the profile system to receive insights on the property including the RSI (Roof Spotlight Index), Peril Risks, Flags, and Partner Connect data (third party data).

Account and Policy Management: Properties can now include optional policy and account objects to integrate property-level insights with insurance information.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Property Addresses that should be evaluated.

Either callback or isSyncResponse must be provided.

isSyncResponse

boolean

When true, the endpoint will wait to respond until the property has completed processing, and responds with the full details of the property. A callback URL cannot be provided as the results are sent immediately. Only one property can be sent, per request, when using this option. The default is false, where the expectation is to use a callback URL and receive the results on a separate web request.

batchReference

string

A unique identifer that can be set for the bulk order. When navigating Tower, this name could be used to filter certain screens.

properties

array of objects

required

length ≥ 1

properties*

A property on which to produce a Property Profile. Either a streetAddress, city, state, postalCode OR a latitude and longitude combination is required. Custom fields set up for your workspace are sent as extra string properties named x_ followed by the field's key (for example x_region). Unknown custom fields and missing required ones are rejected.

latitude

number

If provided, geocoding of the address will be skipped and these coordinates will be used when a centroid is needed. The address may still be used in some cases.

longitude

number

If provided, geocoding of the address will be skipped and these coordinates will be used when a centroid is needed. The address may still be used in some cases.

reference

string

length ≤ 100

The id assigned to this property upon creation by the client system. Usually an identifier from the client system. Translates to "External ID" in Tower and external_id in the EDW. Can be used to search for the property in Tower.

reference2

string

length ≤ 100

A secondary id that can be provided by the client to differentiate orders. Translates to "Secondary ID" in Tower and seconday_external_id in the EDW. Can be used to search for the property in Tower.

claimNumber

string

A claim number for reference.

asOfDate

string

A generic date that Betterview will use to pull the most recent imagery prior to said date. This date takes precedence over "dateOfLoss".

dateOfLoss

string

If a loss occurred on the property, and it is included here, Betterview will run the property as of the loss date and will pull the most recent imagery prior to the loss. This logic is superseded by "asOfDate".

renewalDate

string

The date the policy is set to renew. Stored with the property; it does not change which imagery is used. Required when the product requires a renewal date.

causeOfLoss

string

The peril that caused the loss, i.e. fire.

policyNumber

string

A policy number for reference.

assignToEmail

string

One or more comma-separated emails of Betterview accounts to assign the property to (i.e. receive notifications and have access to the property), or "none" to remove the property's assignments. Each email must match an account in your client org exactly, ignoring case; add the person to your client org in MyAccount first. An invalid email returns a 400 and an email with no account in your client org returns a 404.

address

object

productIdentifier

string

The name of the product you wish to order. Blank indicates the default product. Contact us for the names of the products that we have configured for you

insuredName

string

The name of the insured.

isClaim

boolean

Whether this order is for a claim.

lossValue

number

The value of the loss, in dollars.

premiumValue

number

The policy premium, in dollars.

agentName

string

The name of the agent for the policy.

agentCode

string

The code of the agent for the policy.

programCode

string

The insurance program code.

additionalAsOfDates

array of dates

More dates to score the property for, in addition to the main one. For each date, Betterview scores the most recent imagery from the same provider on or before that date. Invalid dates are skipped.

additionalAsOfDates

resourceId

string

A Nearmap capture (survey resource) ID. When provided, Betterview uses only that capture's imagery for the property.

total_square_footage

number

(e2Value Integration) The total square footage of the structure, including all floors. Useful to determine more accurate replacement costs.

structure_type

string

enum

(e2Value Integration) The kind of building or structure. Useful to determine more accurate replacement costs.

transmitPDF

boolean

If true, and an FTP integration is configured on the account, a PDF will be generated and transferred via FTP. If false, no PDF will be generated and sent to configured FTP integrations. Contact us to adjust the default.

parcelOverrideLngLat

string

A wkt string that represents the parcel boundary. This is used to manually determine the desired boundary

policy

object

Policy information for Account and Policy Management integration.

account

object

Account information for Account and Policy Management integration. All fields are optional, but providing any of them requires policy.policy_number.

callback

object

An endpoint to which data for scored properties will be sent. Scores and results will be sent back as the properties are finished, rather than waiting until all properties are complete. Must be omitted if isSyncResponse=true.

200The endpoint responds with either an AsyncResponse, SyncResponseProductive or SyncResponseNonProductive. AsyncResponse is sent when "isSyncResponse: false" (default), while one of the "Sync" responses are sent when "isSyncResponse: true"

400Invalid input

404Not found

500Internal Server Error