# Xpansiv Retirements API

**Canonical:** https://apis.io/apis/xpansiv/xpansiv-retirements-api/  
**Provider:** Xpansiv — https://apis.io/providers/xpansiv/  
**Base URL:** https://connect.xpansiv.com/app/api/v1  
**Documentation:** https://developer.xpansiv.com/developer-portal/xpansiv-connect

Xpansiv Retirements API is one of 43 APIs that [Xpansiv](https://apis.io/providers/xpansiv/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include Retirements. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, authentication docs, a quickstart, and an API reference.

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.

## Operations (4)

| Method | Path | Summary |
|---|---|---|
| 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 |

## Machine-readable artifacts (15)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/xpansiv/refs/heads/main/openapi/xpansiv-retirements-api-openapi.yml
- **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
- **Postman** — https://developer.xpansiv.com/developer-portal/xpansiv-power/rest_api/postman

## Other Xpansiv APIs (12)

- [Xpansiv Data API](https://apis.io/apis/xpansiv/xpansiv-data/)
- [Xpansiv Marketplace FIX API](https://apis.io/apis/xpansiv/xpansiv-marketplace-fix/)
- [Xpansiv Account API](https://apis.io/apis/xpansiv/xpansiv-account-api/)
- [Xpansiv Building types API](https://apis.io/apis/xpansiv/xpansiv-building-types-api/)
- [Xpansiv Clean Transportation API](https://apis.io/apis/xpansiv/xpansiv-clean-transportation-api/)
- [Xpansiv Corporate Entity API](https://apis.io/apis/xpansiv/xpansiv-corporateentity-api/)
- [Xpansiv Exchange API](https://apis.io/apis/xpansiv/xpansiv-exchange-api/)
- [Xpansiv Facilities API](https://apis.io/apis/xpansiv/xpansiv-facilities-api/)
- [Xpansiv Facility import error handling API](https://apis.io/apis/xpansiv/xpansiv-facility-import-error-handling-api/)
- [Xpansiv File Type V1 API](https://apis.io/apis/xpansiv/xpansiv-file-type-v1-api/)
- [Xpansiv /file Registry API](https://apis.io/apis/xpansiv/xpansiv-fileregistry-api/)
- [Xpansiv Forward Deals API](https://apis.io/apis/xpansiv/xpansiv-forward-deals-api/)

## Tags

Retirements

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/xpansiv/xpansiv-retirements-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/xpansiv/.