Company access / API reference

Cancel Invitation

Request and response reference for POST /v1/console/invitations/{invitation}/cancel.

POST/v1/console/invitations/{invitation}/cancel

Authentication: Console sessionPermission: members.manage

Use the base URL and access configuration provided to your institution. Examples are request templates, not transaction results. Field tables focus on client fields; preserve additional metadata returned by the configured service.

Request

This interface uses an approved institutional session, not a financial API key. Session writes also need Origin and CSRF protection. Use the JavaScript sample within an authorized browser integration.

Request templatecURL

curl -X POST "$OSAI_CONSOLE_BASE_URL/v1/console/invitations/$INVITATION_ID/cancel" \
  -H "Content-Type: application/json" \
  -H "Origin: $OSAI_APP_ORIGIN" \
  -H "X-CSRF-Token: $OSAI_CSRF_TOKEN" \
  --cookie "$OSAI_SESSION_COOKIE_FILE" \
  --data '{
  "expected_version": "1",
  "reason": "<reason>"
}'

Parameters

Name	Location	Requirement	Description
`invitation`	path · string	Required	Use the value defined for this resource.
`Origin`	header · string	Required	Use the value defined for this resource.
`X-CSRF-Token`	header · string	Required	Use the value defined for this resource.

Request body

Send JSON with Content-Type: application/json. Nested field names identify their parent object; required markers apply within that object. Replace template values using the relevant resource and configured instrument rules.

Field	Type	Description & constraints
`expected_version`Required in parent object	`string`	Exact nonnegative base-10 integer; never a JSON number.Pattern: `^(0\|[1-9][0-9]*)$`
`reason`Required in parent object	`string`	Defined by the resource contract.

Responses

Inspect HTTP status before parsing a body. These tables describe client response fields rather than invented successful transaction payloads.

200 · HTTP 200 response

Field	Type	Description & constraints
`invitation_id`Required in parent object	`string`	Defined by the resource contract.
`institution_id`Required in parent object	`string`	Defined by the resource contract.
`masked_email`Required in parent object	`string`	Defined by the resource contract.
`role_ids`Required in parent object	`array`	Defined by the resource contract.
`status`Required in parent object	`string`	Defined by the resource contract.
`version`Required in parent object	`string`	Exact nonnegative base-10 integer; never a JSON number.Pattern: `^(0\|[1-9][0-9]*)$`
`created_at`Required in parent object	`string`date-time	Defined by the resource contract.
`expires_at`Required in parent object	`string`date-time	Defined by the resource contract.
`delivery_status`Required in parent object	`string`	Defined by the resource contract.

400 · Invalid bounded instruction