Skip to main content
POST
/
v1
/
worker-beneficiaries
Create a worker beneficiary
curl --request POST \
  --url https://api.plane.com/v1/worker-beneficiaries \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "worker": "<string>",
  "name": {},
  "type": "<string>",
  "relationship": "<string>",
  "dob": "<string>",
  "status": "<string>"
}
'
{
  "worker": "wrkr_8oWZpQ2rL4sk",
  "name": { "first": "Amara", "last": "Okafor" },
  "dob": "1990-04-12",
  "relationship": "spouse"
}

Documentation Index

Fetch the complete documentation index at: https://docs.plane.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Parameters

​
worker
string
required
ID of the worker this beneficiary belongs to.
​
name
object
required
The beneficiary’s name.
​
type
string
Beneficiary type. One of individual, trust, estate, or organization. Defaults to individual.
​
relationship
string
Relationship to the worker. One of spouse, child, domestic_partner, step_child, adopted_child, foster_child, grandchild, civil_union, legal_guardianship, ex_spouse, or other.
​
dob
string
Date of birth for an individual beneficiary.
​
status
string
Beneficiary status. One of active or inactive. Defaults to active.

​
Returns

Returns the created Worker beneficiary object. 
{
  "worker": "wrkr_8oWZpQ2rL4sk",
  "name": { "first": "Amara", "last": "Okafor" },
  "dob": "1990-04-12",
  "relationship": "spouse"
}