curl --request POST \
--url https://api.osaconnection.com/v1/members/invitations \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"osa_id": "Hp2sK8dL4fJ6gA1zX9cV3bN7mQ5w",
"role": "adjuster"
}
'{
"osa_id": "Hp2sK8dL4fJ6gA1zX9cV3bN7mQ5w",
"status": "pending",
"roles": [
"adjuster"
],
"test": false,
"name": null,
"email": null,
"invited_at": "2026-09-28T13:02:45Z",
"expires_at": "2026-10-05T13:02:45Z",
"responded_at": null,
"invited_as": null,
"invited_by": null,
"purpose": null,
"note": null
}Invite a person to your organisation
Invites a person to your organisation by their OSAID, with a role. The person sees the
invitation in the OSA app, with your organisation’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.
Roles. role is OSA’s role kind, not your own title for the role. Which roles you
can invite depends on your partner type and your setup with OSA; today it is adjuster.
Any other value fails with 422 validation_failed.
Once they accept, an adjuster can receive claims from you, and their name and email
appear in GET /v1/members.
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 person 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 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 person sees invited_as on the
invitation; the other three are for you only. Inviting someone again replaces all four
with whatever the new invitation sends.
Test keys can only invite your 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.
curl --request POST \
--url https://api.osaconnection.com/v1/members/invitations \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"osa_id": "Hp2sK8dL4fJ6gA1zX9cV3bN7mQ5w",
"role": "adjuster"
}
'{
"osa_id": "Hp2sK8dL4fJ6gA1zX9cV3bN7mQ5w",
"status": "pending",
"roles": [
"adjuster"
],
"test": false,
"name": null,
"email": null,
"invited_at": "2026-09-28T13:02:45Z",
"expires_at": "2026-10-05T13:02:45Z",
"responded_at": null,
"invited_as": null,
"invited_by": null,
"purpose": null,
"note": null
}Authorizations
Send your API key as a bearer token: Authorization: Bearer osa_live_….
Keys are opaque; each belongs to exactly one partner. Keys starting with osa_test_
reach only test claims and test accounts. The scopes listed on each operation are the
permissions the key needs. A key's permissions are set when it is issued and can be
changed by OSA on request, never beyond what your plan and add-ons include.
GET /v1/me always shows the current set.
Body
The person to invite and their role.
The person to invite and their role. invited_as, invited_by, purpose and note
are your own notes: nothing is checked against the account, and no invitation is refused
because of them.
The role you are inviting the person to, as OSA's role kind: not your own title for
the role. Open list: more role kinds may be added; only adjuster today. Which roles
you can invite depends on your partner type and your setup with OSA; any other value
fails with 422 validation_failed.
adjuster "adjuster"
Response
The invitation was sent and is pending.
A member of your organisation, or an invitation you sent.
pending: invited, not yet answered. active: accepted and a member of your
organisation. declined: the person declined. expired: not answered within 7 days.
withdrawn: you withdrew the invitation. Open list: new values may be added; treat
an unknown value as an unknown state.
pending, active, declined, expired, withdrawn The role kinds the person holds in your organisation; empty when none of their roles has a kind. These are OSA's role kinds, not your own titles for the roles.
A role kind: adjuster today. Open list: new values may be added; treat an
unknown value as a role you don't specifically handle.
adjuster