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.
Xpansiv Retirements API is one of 43 APIs that Xpansiv publishes on the 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.
This API exposes 4 operations across 4 paths, and defines 51 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0-beta.
Requests are made against 3 base URLs: https://sandbox.preprod.connect.xpansiv.com/app/api/v1, https://uat.preprod.connect.xpansiv.com/app/api/v1, https://connect.xpansiv.com/app/api/v1.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Xpansiv Retirements API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (JWT) (bearerToken).
By default, every request must be authenticated.
Paths & Operations 4
Across 4 paths, the API surfaces 4 operations — 1 GET, 3 POST. Each is listed below with its method, path, parameters, and response codes.
The Retirements APIs allow users to take various actions, both read and write, for their retirement activity.
Schemas 51
The contract defines 51 schemas that model the data the API accepts and returns. The most detailed are TaxLot (14 properties), Retirement (12 properties), BaseInstrument (8 properties), Market (4 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Xpansiv 12
Other APIs Xpansiv publishes across the network.
This is an independent, third-party profile of Xpansiv Retirements API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.