Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

TIAA Participants API

Participant account management

TIAA Participants API is one of 11 APIs that TIAA publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Participants. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.

This API exposes 3 operations across 2 paths, and defines 3 schemas. It is described by OpenAPI 3.0.3, at version 6.0.

Requests are made against a single base URL, https://api.tiaa.org/fdx/v6.

3 operations 2 paths 3 schemas 2 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
6.0
Base URL
https://api.tiaa.org/fdx/v6
Authentication
OAuth 2.0
Terms of Service
Resource Areas
1

Authentication & Security 1

TIAA Participants API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (OAuth2) using the authorizationCode flow, exposing 6 scopes.

Paths & Operations 3

Across 2 paths, the API surfaces 3 operations — 2 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Participants 3

Participant account management

GET
/plans/{planId}/participants
List Plan Participants
listParticipants 3 params → 200401403
POST
/plans/{planId}/participants
Enroll Participant in SIA
enrollParticipant 1 param body → 201400
GET
/plans/{planId}/participants/{participantId}
Get Participant Details
getParticipant 2 params → 200404

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are Participant (9 properties), ParticipantEnrollment (6 properties), ParticipantList (4 properties). Each schema is shown below with its type and property counts.

Participant
object
9 properties
ParticipantEnrollment
object
6 properties 4 required
ParticipantList
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

tiaa-participants-api-openapi.yml Raw ↑

Other APIs TIAA publishes across the network.

TIAA Gateway API
TIAA Payroll360 API
TIAA Accounts API
TIAA Contributions API
TIAA Customer API
TIAA Investments API
TIAA Plans API
TIAA Projections API
TIAA Tax API
TIAA Transactions API