{
  "opencollection": "1.0.0",
  "info": {
    "name": "TIAA Secure Income Account API",
    "version": "1.0"
  },
  "items": [
    {
      "info": {
        "name": "Participants",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List Plan Participants",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.tiaa.org/sia/v1/plans/:planId/participants",
            "params": [
              {
                "name": "planId",
                "value": "",
                "type": "path",
                "description": "Unique plan identifier"
              },
              {
                "name": "page",
                "value": "",
                "type": "query"
              },
              {
                "name": "pageSize",
                "value": "",
                "type": "query"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "https://auth.tiaa.org/oauth2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Returns participants enrolled in the SIA product for a given plan."
        },
        {
          "info": {
            "name": "Enroll Participant in SIA",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.tiaa.org/sia/v1/plans/:planId/participants",
            "params": [
              {
                "name": "planId",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "https://auth.tiaa.org/oauth2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Enrolls a new participant in the Secure Income Account product for the plan."
        },
        {
          "info": {
            "name": "Get Participant Details",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.tiaa.org/sia/v1/plans/:planId/participants/:participantId",
            "params": [
              {
                "name": "planId",
                "value": "",
                "type": "path"
              },
              {
                "name": "participantId",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "https://auth.tiaa.org/oauth2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Returns SIA account details for a specific participant."
        }
      ]
    },
    {
      "info": {
        "name": "Contributions",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Submit Contribution",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.tiaa.org/sia/v1/plans/:planId/contributions",
            "params": [
              {
                "name": "planId",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "https://auth.tiaa.org/oauth2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Submits a contribution or allocation to a participant's SIA account."
        }
      ]
    },
    {
      "info": {
        "name": "Projections",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get Income Projection",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.tiaa.org/sia/v1/plans/:planId/participants/:participantId/projections",
            "params": [
              {
                "name": "planId",
                "value": "",
                "type": "path"
              },
              {
                "name": "participantId",
                "value": "",
                "type": "path"
              },
              {
                "name": "retirementAge",
                "value": "",
                "type": "query",
                "description": "Target retirement age for projection"
              },
              {
                "name": "projectionDate",
                "value": "",
                "type": "query"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "https://auth.tiaa.org/oauth2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Returns projected lifetime income amounts for a participant based on current balance and future contributions."
        }
      ]
    },
    {
      "info": {
        "name": "Plans",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get Plan Details",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.tiaa.org/sia/v1/plans/:planId",
            "params": [
              {
                "name": "planId",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "https://auth.tiaa.org/oauth2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Returns SIA configuration and eligibility rules for a specific plan."
        }
      ]
    }
  ],
  "bundled": true
}