Send an invitation
osa_id is required. The adjuster sees the invitation in the OSA app and accepts or declines it. An invitation that isn’t answered expires after 7 days. The invitation shows the adjuster your firm’s name and invited_as. Nothing about your claims reaches them until they accept.
Your firm’s notes
Four optional fields record who an invitation is for and why. To send no note, leave the field out:null and an empty string are refused with 422 validation_failed.
- They are your firm’s own notes. Nothing is checked against the adjuster’s account, and no invitation is refused because of them. Whoever owns the OSAID can accept.
- The adjuster sees
invited_ason the invitation in the app. The other three are for your firm only. - They are returned whenever adjusters are listed. Each adjuster in
GET /v1/adjusterscarries all four, and so do the responses to sending and withdrawing an invitation. A note you didn’t send isnull. - Inviting again replaces them. A new invitation to the same adjuster replaces all four with whatever it sends. A note the new invitation leaves out becomes
null.
What the adjuster needs before accepting
The adjuster must have a first name, a last name and an email on their OSA profile before they can accept an invitation. If one is missing, the invitation can’t be accepted until they complete their profile in the app. If an adjuster tells you they can’t accept, ask them to check their profile in the OSA app.Follow the invitation
name and email are null until the adjuster accepts. After that they are the account’s own name and email. invited_as stays what your firm wrote, so it can differ from name: compare the two if you need to confirm that the person you meant to invite is the one who accepted.
An adjuster can leave your firm in the app. One who has left no longer appears in the list, under any status. Claims they had already accepted stay with them; new claims sent to them are refused with 422 adjuster_not_in_firm. Invite them again to bring them back.
Statuses are an open enum: handle values you don’t recognise without failing.
Inviting again and withdrawing
- You can invite someone again after they declined, after the invitation expired, or after you withdrew it.
- Inviting a current member returns
409 already_member. Inviting someone whose invitation is still pending returns409 invitation_pending. DELETE /v1/adjusters/invitations/{osa_id}withdraws a pending invitation.