Invite an adjuster to your firm
Invites an adjuster to your firm by their OSAID. The adjuster sees the invitation in
the OSA app, with your firm’s name and invited_as, and accepts or declines it.
Nothing about your claims reaches them until they accept. An invitation that isn’t
answered expires after 7 days.
Once they accept, the adjuster can receive claims from you, and their name and email
appear in GET /v1/adjusters.
You can invite someone again after they declined, after the invitation expired, or
after you withdrew it. Inviting a current member fails with 409 already_member, and
inviting someone whose invitation is still pending fails with 409 invitation_pending.
An OSAID exists only once the adjuster has signed in to the OSA app. An OSAID that OSA
doesn’t know fails with 422 unknown_osaid.
Your notes. invited_as, invited_by, purpose and note are your firm’s own
notes on the invitation. Nothing is checked against the account and no invitation is
refused because of them: whoever owns the OSAID can accept. The adjuster sees
invited_as on the invitation; the other three are for your firm only. Inviting someone
again replaces all four with whatever the new invitation sends.
Test keys can only invite your firm’s test accounts. Any other OSAID fails with
422 unknown_osaid, exactly as if it didn’t exist.
Live keys can’t invite test accounts: a live key naming a test account fails with
422 environment_mismatch. Invite test accounts with a test key.
Authorizations
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.
Body
The adjuster to invite.
The adjuster to invite. invited_as, invited_by, purpose and note are your
firm's own notes: nothing is checked against the account, and no invitation is refused
because of them.
The OSAID of the adjuster to invite. The adjuster can read it in the OSA app.
1 - 128"Xk3pQ9vT2mN8rL5wB7yC1dF4gH6j"
Who your firm believes it is inviting, for example the adjuster's name. Your firm's own note: nothing is checked against the account. It is shown to the adjuster on the invitation.
1 - 200"Todd Rivera"
Who at your firm sent the invitation. Your firm's own note: nothing is checked against the account, and the adjuster doesn't see it.
1 - 200What the invitation is for. Your firm's own note: nothing is checked against the account, and the adjuster doesn't see it.
1 - 500Anything else your firm wants to record with the invitation. Your firm's own note: nothing is checked against the account, and the adjuster doesn't see it.
1 - 1000Response
The invitation was sent and is pending.
An adjuster in your firm, or an invitation you sent.
The adjuster's OSAID.
pending: invited, not yet answered. active: accepted and a member of your firm.
declined: the adjuster declined. expired: not answered within 7 days.
withdrawn: you withdrew the invitation.
pending, active, declined, expired, withdrawn true for one of your firm's OSA-created test accounts.
The adjuster's name; null until they accept.
The adjuster's email; null until they accept.
When the invitation was sent; null for members added without an invitation record.
When a pending invitation expires; null unless pending.
When the adjuster accepted or declined; null otherwise.
Who your firm said it was inviting; null when not sent. This is your firm's own
note, so after acceptance it can differ from the account's real name.
Who at your firm sent the invitation, as you sent it; null when not sent.
What the invitation is for, as you sent it; null when not sent.
Your firm's note on the invitation, as you sent it; null when not sent.