---
updatedAt: 2026-05-14T14:32:15.000Z
agentTools:
  projectIndex: https://docs.oysterhr.com/v0.1/llms.txt
---

# Request benefits

Provisions benefits for an engagement.

# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "info": {
    "title": "Endpoints",
    "version": "v0.1"
  },
  "components": {
    "securitySchemes": {
      "bearer_auth": {
        "type": "http",
        "scheme": "bearer"
      }
    },
    "schemas": {
      "benefitPackage": {
        "properties": {
          "id": {
            "type": "string"
          },
          "fee": {
            "type": "object",
            "nullable": true,
            "properties": {
              "currencyCode": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3
              },
              "decimal": {
                "type": "string",
                "pattern": "^\\d+([.]\\d+)?$"
              }
            }
          },
          "name": {
            "type": "string"
          },
          "plans": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/benefitPlan"
            }
          }
        }
      },
      "benefitPlan": {
        "properties": {
          "category": {
            "type": "string"
          },
          "estimatedPrice": {
            "type": "object",
            "nullable": true,
            "properties": {
              "currencyCode": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3
              },
              "decimal": {
                "type": "string",
                "pattern": "^\\d+([.]\\d+)?$"
              }
            },
            "required": [
              "currencyCode",
              "decimal"
            ]
          },
          "fee": {
            "type": "object",
            "nullable": true,
            "properties": {
              "currencyCode": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3
              },
              "decimal": {
                "type": "string",
                "pattern": "^\\d+([.]\\d+)?$"
              }
            },
            "required": [
              "currencyCode",
              "decimal"
            ]
          },
          "guideUrl": {
            "type": "string"
          },
          "id": {
            "type": "string"
          },
          "link": {
            "type": "string"
          },
          "name": {
            "type": "string"
          }
        }
      },
      "enrollment": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "state": {
            "type": "string"
          },
          "plan": {
            "$ref": "#/components/schemas/benefitPlan"
          },
          "package": {
            "$ref": "#/components/schemas/benefitPackage"
          },
          "employerContribution": {
            "nullable": true,
            "type": "object",
            "properties": {
              "dependents": {
                "nullable": true,
                "type": "number"
              },
              "max_dependents_covered": {
                "nullable": true,
                "type": "number"
              },
              "teamMember": {
                "nullable": true,
                "type": "number"
              }
            }
          },
          "totalCost": {
            "nullable": true,
            "type": "object",
            "properties": {
              "decimal": {
                "type": "string",
                "pattern": "^\\d+([.]\\d+)?$"
              },
              "currencyCode": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3
              }
            }
          },
          "totalEmployerContributionCost": {
            "nullable": true,
            "type": "object",
            "properties": {
              "decimal": {
                "type": "string",
                "pattern": "^\\d+([.]\\d+)?$"
              },
              "currencyCode": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3
              }
            }
          },
          "coveragePeriod": {
            "nullable": true,
            "type": "object",
            "properties": {
              "fromDate": {
                "nullable": true,
                "type": "string",
                "format": "date"
              },
              "toDate": {
                "nullable": true,
                "type": "string",
                "format": "date"
              }
            }
          }
        }
      }
    }
  },
  "paths": {
    "/v0.1/benefits/engagements/{engagement_id}/enrollments": {
      "post": {
        "summary": "Request benefits",
        "tags": [
          "Benefits"
        ],
        "description": "Provisions benefits for an engagement.",
        "security": [
          {
            "bearer_auth": [
              "manage"
            ]
          }
        ],
        "parameters": [
          {
            "name": "engagement_id",
            "in": "path",
            "description": "engagement ID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successfully requests benefits enrollment",
            "content": {
              "application/json": {
                "examples": {
                  "Successfully requests benefits enrollment": {
                    "value": {
                      "data": {
                        "id": "A8084119",
                        "plan": {
                          "id": "A4d58b0f",
                          "link": "http://example.com",
                          "name": "Pension",
                          "providerName": "Test nationale nederlanden",
                          "category": "PENSION",
                          "guideUrl": "http://example.com/guide",
                          "estimatedPrice": null,
                          "costSplitAllowed": true,
                          "dependentsConfig": "ALLOWED",
                          "maxDependents": 0,
                          "minEmployerContribution": 0,
                          "supportedEngagementTypes": [
                            "EMPLOYMENT",
                            "CONTRACT"
                          ],
                          "supportedEorTypes": [
                            "DIRECT",
                            "INDIRECT"
                          ],
                          "mandatory": false,
                          "fee": null
                        },
                        "package": null,
                        "state": "REQUESTED",
                        "employerContribution": {
                          "dependents": 0.35,
                          "maxDependentsCovered": 6,
                          "teamMember": 0.55
                        },
                        "totalCost": null,
                        "totalEmployerContributionCost": null,
                        "coveragePeriod": {
                          "fromDate": "2022-10-15",
                          "toDate": null
                        }
                      }
                    }
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "data": {
                      "$ref": "#/components/schemas/enrollment"
                    }
                  },
                  "required": [
                    "data"
                  ]
                }
              }
            }
          }
        },
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "planId": {
                    "type": "string",
                    "minLength": 1,
                    "pattern": "^[\\w+\\-]{8,9}$"
                  },
                  "employerContribution": {
                    "type": "object",
                    "properties": {
                      "teamMember": {
                        "type": "number",
                        "minimum": 0,
                        "maximum": 100
                      },
                      "dependents": {
                        "type": "number",
                        "minimum": 0,
                        "maximum": 100
                      },
                      "maxDependentsCovered": {
                        "type": "integer",
                        "minimum": 0
                      }
                    }
                  }
                },
                "required": [
                  "planId"
                ]
              },
              "examples": {
                "Successfully requests benefits enrollment": {
                  "summary": "Successfully requests benefits enrollment",
                  "value": {
                    "plan_id": "A4d58b0f",
                    "employer_contribution": {
                      "team_member": 0.55,
                      "max_dependents_covered": 6,
                      "dependents": 0.35
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  },
  "servers": [
    {
      "url": "https://api.oysterhr.com",
      "description": "Production server"
    },
    {
      "url": "https://api-sandbox.oysterhr.com",
      "description": "Sandbox server"
    }
  ]
}
```