Skip to content
Docs
Select language:English

/api/v1/reports/insurance

POST
/api/v1/reports/insurance
curl --request POST \
  --url https://example.com/api/v1/reports/insurance \
  --header 'Content-Type: application/json' \
  --data '{ "scope": { "locationId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" }, "asOf": "2026-04-15", "reportCurrency": "example", "include": { "photos": true }, "locale": "en", "digits": "western", "email": true }'

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
scope
required
Any of:
object
locationId
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
asOf
string format: date
/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$/
reportCurrency
string
/^[A-Z]{3}$/
include
object
photos
boolean
locale
string
Allowed values: en ar fr de it
digits
string
Allowed values: western eastern
email
boolean

Responses

Section titled “Responses”

202

Section titled “202”

Default Response

Media typeapplication/json
object
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
status
required
string
Allowed values: queued
expiresAt
required
string
Example
{
  "status": "queued"
}