Retrieve Benefits by Country | Deel

curl -G https://api.letsdeel.com/rest/v2/eor/benefits \
     -H "Authorization: Bearer <token>" \
     -d country_code=US \
     -d work_visa=true \
     -d work_hours_per_week=40 \
     -d employment_type=Full-time \
     -d team_id=123e4567-e89b-12d3-a456-426614174000 \
     -d legal_entity_id=123e4567-e89b-12d3-a456-426614174000

{
  "data": [
    {
      "name": "Health Insurance",
      "providers": [
        {
          "id": "5f4d1f3f-4b3b-4b1e-8f4f-3b1f4f1b3b4b",
          "name": "Provider A",
          "type": "Insurance",
          "plans": [
            {
              "id": "5f4d1f3f-4b3b-4b1e-8f4f-3b1f4f1b3b4b",
              "name": "Premium Employee Plan",
              "price": 1000,
              "attachments": [
                {
                  "id": "5f4d1f3f-4b3b-4b1e-8f4f-3b1f4f1b3b4b",
                  "url": "https://www.provider-a.com/attachments/Spain_Benefits_Snapshot.pdf",
                  "label": "Spain_Benefits_Snapshot.pdf"
                }
              ]
            }
          ],
          "country": "US",
          "currency": "USD",
          "is_unisure": true,
          "attachments": [
            {
              "id": "5f4d1f3f-4b3b-4b1e-8f4f-3b1f4f1b3b4b",
              "url": "https://www.provider-a.com/attachments/Spain_Benefits_Snapshot.pdf",
              "label": "Spain_Benefits_Snapshot.pdf"
            }
          ],
          "home_page_url": "https://www.provider-a.com",
          "contribution_options": [
            {
              "id": "5f4d1f3f-4b3b-4b1e-8f4f-3b1f4f1b3b4b",
              "amount": 1000
            }
          ],
          "client_info": "You're now offering this employee Flexible Retribution that includes meals, transport and daycare tax free.",
          "employee_info": "Your company is now offering supplemental benefits.",
          "max_contribution": 10,
          "min_contribution": 10
        }
      ],
      "description": "Provide a cost coverage or subsidy for employees relating to Meals or Grocery.",
      "is_mandatory": true,
      "is_discriminatory": true
    }
  ]
}

Retrieves list of benefits available in a specific country based work visa requirement, work hours, employment type, team, and legal entity. Token scopes: benefits:read

Authentication

AuthorizationBearer

Authentication

The Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.

1 curl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \
2   -H 'Authorization: Bearer YOUR-TOKEN-HERE'

Learn more about authentication

## Authentication The Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail. ```curl curl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \ -H 'Authorization: Bearer YOUR-TOKEN-HERE' ``` [Learn more about authentication](/api/authentication)

AuthorizationBearer

Standard OAuth2 security scheme based on https://swagger.io/docs/specification/authentication/

Query parameters

country_codestringRequiredformat: "^[A-Z]{2}$"=2 characters

Country code.

work_visabooleanRequired

Indicates if work visa is required.

work_hours_per_weekdoubleRequired0-168

Working hours per week

employment_typeenumRequired

Type of employment

Allowed values:

team_idstringRequiredformat: "uuid"

The ID of the team the worker belongs to.

legal_entity_idstringRequiredformat: "uuid"

The ID of the legal entity.

Response

Successful operation.

datalist of objects

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error

1	curl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \
2	-H 'Authorization: Bearer YOUR-TOKEN-HERE'