Xpansiv

Xpansiv Retirements API

The Retirements APIs allow users to take various actions, both read and write, for their retirement activity. The Create Retirements API allows users of Xpansiv Connect to retire one or more positions from their linked registry accounts and/or other Xpansiv Connect accounts that have granted their API user with that access. The Get Registry Rules API call provides the user with the information required to pass the correct rule attributes specific to each registry with each retirement attempt. The Check Retirement Status API allows users to query the status of their retirements. The Search retirements API allows users search their retirement history. Note - this call has a number of optional fields that the user needs to include if desired in the output.

GitHub OpenAPI

Operations 4

POST /retirements/account/{AccountIdentifier}/action/check-status Check retirements status #
POST /retirements/account/{AccountIdentifier}/action/search Search retirements #
POST /retirements/account/{AccountIdentifier}/program/{RetirementProgramCode}/action/create Create retirements #
GET /retirements/program/{RetirementProgramCode}/rules Get registry rules #

Documentation

📖
Documentation
https://developer.xpansiv.com/developer-portal/xpansiv-connect
📖
GettingStarted
https://developer.xpansiv.com/developer-portal/xpansiv-connect/getting-started
📖
Documentation
https://developer.xpansiv.com/developer-portal/xpansiv-managed-solutions
📖
Authentication
https://developer.xpansiv.com/developer-portal/xpansiv-managed-solutions/authorization
📖
Documentation
https://developer.xpansiv.com/developer-portal/nar-registry
📖
Authentication
https://developer.xpansiv.com/developer-portal/nar-registry/authentication
📖
Documentation
https://developer.xpansiv.com/developer-portal/tigr-registry
📖
Authentication
https://developer.xpansiv.com/developer-portal/tigr-registry/authentication
📖
Documentation
https://developer.xpansiv.com/developer-portal/optimal-outcomes
📖
Quickstart
https://developer.xpansiv.com/developer-portal/optimal-outcomes/quickstart
📖
Documentation
https://developer.xpansiv.com/developer-portal/xpansiv-power/rest_api
📖
APIReference
https://developer.xpansiv.com/developer-portal/xpansiv-power/rest_api/apiendpoints
📖
Authentication
https://developer.xpansiv.com/developer-portal/xpansiv-power/rest_api/authentication

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/xpansiv/refs/heads/main/openapi/xpansiv-retirements-api-openapi.yml

Other Resources

🔗
Postman
https://developer.xpansiv.com/developer-portal/xpansiv-power/rest_api/postman

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/xpansiv-retirements-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

xpansiv-retirements-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  description: 'This is the OpenAPI spec for Xpansiv Connect API. Documentation: https://developer.xpansiv.com/developer-portal/'
  title: Xpansiv Connect Retirements API
  version: 1.0.0-beta
servers:
- url: https://sandbox.preprod.connect.xpansiv.com/app/api/v1
  description: SANDBOX
- url: https://uat.preprod.connect.xpansiv.com/app/api/v1
  description: UAT
- url: https://connect.xpansiv.com/app/api/v1
  description: PROD
security:
- bearerToken: []
tags:


# --- truncated at 32 KB (36 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/xpansiv/refs/heads/main/openapi/xpansiv-retirements-api-openapi.yml