Skip to main content
GET
Get a claim

Authorizations

Authorization
string
header
required

Send your API key as a bearer token: Authorization: Bearer osa_live_…. Keys are opaque; each belongs to exactly one firm and one purpose. Keys starting with osa_test_ reach only test claims and test accounts. The scopes listed on each operation are the permissions the key needs; GET /v1/me shows the ones your key has.

Path Parameters

id
string<uuid>
required

OSA's claim id, as returned in the claim's id.

Response

The claim.

A claim as you sent it, with OSA's id, your external_id, and the current assignment. Optional fields you didn't send are omitted. Adjusters' later edits in the app don't change these fields.

id
string<uuid>
required

OSA's id for the claim.

external_id
string
required

Your own id for the claim.

claim_number
string
required

The carrier's claim number.

test
boolean
required

true for a test claim: one sent with a test key to a test account. Test claims are never billed. The value never changes.

created_at
string<date-time>
required

When the claim was created.

updated_at
string<date-time>
required

When something you can see last changed: creation, an offer, an acceptance or a rejection. This is the field updated_since filters on.

assignment
object
required

The latest offer of the claim to an adjuster. When you offer the claim to someone else, this describes the new offer and the earlier response is no longer shown.

loss
object
required

The loss being claimed.

policy
object
required

The insurance policy, as you sent it.

carrier
object
required

The insurance carrier, as you sent it.

loss_location
object
required

The address of the insured property, as you sent it.

policyholder
object
required

The policyholder, as you sent it.

file_number
string

Your firm's file number.

instructions
string

Your notes for the adjuster.

reported_date
string<date>

The date the loss was reported to the carrier.

contact_date
string<date>

The date the policyholder was contacted, as you sent it.

inspection_date
string<date>

The date of the inspection, as you sent it.

additional_contacts
object[]

Other people or companies involved in the claim.

agent
object

The agent, as you sent it.

mortgagee
object

The mortgage company, as you sent it.

building
object

The building details, as you sent them.

coverages
object

Coverage limits and deductibles, as you sent them.

estimate
object

The estimate figures, as you sent them.