Get Benefit

Get Benefit

Use this endpoint to retrieve the full details of a single benefit by its ID.

Key Points

• Depends on — a benefit_id from POST /benefits or GET /benefits.
• mdv_pre — for an mdv_pre benefit, insurance_type is also included in the response.

GET benefits/{benefit_id} 

Header Parameters

Field	Type	Description
Authorization	string	Required. Bearer token obtained from the Auth endpoint. Format: Bearer <access_token>.
X-TaxBandits-Version	string	API version string. Use 1.0.0.

Query Parameters

Field	Type	Description
entity_ids	string	The organization ID. Must be exactly one UUID.

Path Parameters

Field	Type	Description
benefit_id	string	The benefit UUID from the create or list endpoints.

Response Body

Field	Type	Description
status	string	SUCCESS or FAILURE.
status_code	number	HTTP-style status code (e.g. 200, 400).
message	string	Human-readable status message.
response	object	The benefit details.
benefit_id	string	Benefit UUID.
type	string	The benefit type value (see Supported Benefit Types).
description	string	Human-readable description of the benefit.
frequency	string	Deduction frequency (e.g. every_paycheck).
effective_date	string	Effective date of the benefit (YYYY-MM-DD).
insurance_type	string	Included only for mdv_pre benefits. One of MEDICAL, DENTAL, VISION.

Payload

Request

GET benefits/e8b90071-0c11-471c-86e8-e303ef2f6782?entity_ids=519a84f4-5e56-496a-82f3-18f51fdf3d75
Header: X-TaxBandits-Version: 1.0.0

Response Json

Sample	Description	Action
200	Success Response - This is a sample response for successful API requests.
400	Bad Request Response - You'll get the below response when entity_ids or benefit_id is missing or invalid.
404	Not Found Response - You'll get the below response when no benefit matches the supplied benefit_id.

{
  "status": "SUCCESS",
  "status_code": 200,
  "message": "Request processed successfully",
  "response": {
    "benefit_id": "e8b90071-0c11-471c-86e8-e303ef2f6782",
    "type": "401k",
    "description": "Employee Retirement Plan",
    "frequency": "every_paycheck",
    "effective_date": "2025-01-01"
  }
}