Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Nayya Dependents API

The Dependents API from Nayya — 2 operation(s) for dependents.

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

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

This API exposes 5 operations across 2 paths, and defines 3 schemas. It is described by OpenAPI 3.0.0, at version 0.1.

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

5 operations 2 paths 3 schemas 1 DELETE2 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

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

Authentication & Security 1

Nayya Dependents 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 5

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

Dependents 5
POST
/employers/{employerId}/employees/{employeeId}/dependents
Create a Dependent
create-dependent 3 params body → 201400403404409422500
GET
/employers/{employerId}/employees/{employeeId}/dependents
Get all Employee Dependents
list-employee-dependents 3 params → 200403404500
PATCH
/employers/{employerId}/employees/{employeeId}/dependents/{dependentId}
Update a Dependent
update-dependent 4 params body → 200400403404409422500
GET
/employers/{employerId}/employees/{employeeId}/dependents/{dependentId}
Get Dependent by ID
get-dependent-by-id 4 params → 200403404500
DELETE
/employers/{employerId}/employees/{employeeId}/dependents/{dependentId}
Delete a Dependent
delete-dependent 4 params → 204400403404409500

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are DependentResponseDto (23 properties), UpdateDependentDto (19 properties), CreateDependentDto (19 properties). Each schema is shown below with its type and property counts.

CreateDependentDto
object
19 properties 2 required
DependentResponseDto
object
23 properties 14 required
UpdateDependentDto
object
19 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nayya-dependents-api-openapi.yml Raw ↑

Other APIs Nayya publishes across the network.

Nayya Benefits API
Nayya Carriers API
Nayya Connections API
Nayya Employees API
Nayya Employers API
Nayya Enrollments API
Nayya Recommendations API
Nayya Rule Templates API
Nayya Snapshots API
Nayya Token API