How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Nayya Benefits API

The Benefits API from Nayya — 4 operation(s) for benefits.

Nayya Benefits API is one of 11 APIs that Nayya publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Benefits. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 7 operations across 4 paths, and defines 19 schemas. It is described by OpenAPI 3.2.0, at version 0.1.

Requests are made against 2 base URLs: https://integrate.nayya.com/accounts, https://integrate.partners.nayya.com/accounts.

7 operations 4 paths 19 schemas 2 DELETE3 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
0.1
Base URL
https://integrate.nayya.com/accounts
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Nayya Benefits API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — JWT token

Paths & Operations 7

Across 4 paths, the API surfaces 7 operations — 2 DELETE, 3 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Benefits 7
GET
/employers/{employerId}/benefits/{benefitId}
Get a Benefit by ID
get-benefit-by-id 3 params → 200403404429500
DELETE
/employers/{employerId}/benefits/{benefitId}
Delete a Benefit by ID
delete-benefit-by-id 3 params → 204403404429500
GET
/employers/{employerId}/benefits
List Benefits for Employer
list-benefits-for-employer 4 params → 200403429500
POST
/employers/{employerId}/benefits
Create or Update a Benefit
create-or-update-benefit 2 params body → 201403422429500
GET
/employers/{employerId}/benefits/employees/{employeeId}/enrolled-benefits
List Enrolled Benefits for Employee
list-enrolled-benefits-for-employee 5 params → 200403429500
POST
/employers/{employerId}/benefits/{benefitId}/benefit-dependencies
Add Benefit Dependencies to Benefit
add-benefit-dependencies-to-benefit 3 params body → 201403404422429500
DELETE
/employers/{employerId}/benefits/{benefitId}/benefit-dependencies
Delete Benefit Dependencies from Benefit
delete-benefit-dependencies-from-benefit 3 params → 204403404429500

Schemas 19

The contract defines 19 schemas that model the data the API accepts and returns. The most detailed are BenefitResponseDto (18 properties), CreateOrUpdateChooseBenefitRequestDto (14 properties), TierResponseDto (7 properties), FeatureItemResponseDto (7 properties). Each schema is shown below with its type and property counts.

PaginatedBenefitsResponseDto
object
4 properties 4 required
CreateTierRequestDto
object
4 properties 3 required
LabelResponseDto
object
5 properties 5 required
TierResponseDto
object
7 properties 6 required
CreateOrUpdateChooseBenefitRequestDto
object
14 properties 7 required
CreateFeatureRequestDto
object
5 properties 2 required
ThresholdItemResponseDto
object
6 properties 3 required
FeatureResponseDto
object
7 properties 6 required
AddBenefitDependencyRequestDto
object
1 property 1 required
NayyaRulePropertiesDto
object
2 properties 2 required
BenefitDependencyResponseDto
object
6 properties 4 required
CreateBenefitDependencyDto
object
3 properties 1 required
FeatureItemResponseDto
object
7 properties 3 required
CreateEntityRuleRequestDto
object
3 properties
InputValuesItem
object
CreateRuleFromTemplateDTO
object
3 properties
ThresholdResponseDto
object
6 properties 6 required
CreateThresholdRequestDto
object
4 properties 2 required
BenefitResponseDto
object
18 properties 9 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nayya-benefits-api-openapi.yml Raw ↑

Other APIs Nayya publishes across the network.

Nayya Carriers API
Nayya Connections API
Nayya Dependents API
Nayya Employees API
Nayya Employers API
Nayya Enrollments API
Nayya Recommendations API
Nayya Rule Templates API
Nayya Snapshots API
Nayya Token API
Where this information came from

This is an independent, third-party profile of Nayya Benefits API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.