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 Enrollments API

The Enrollments API from Nayya — 2 operation(s) for enrollments.

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

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

This API exposes 4 operations across 2 paths, and defines 15 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.

4 operations 2 paths 15 schemas 1 DELETE1 GET1 POST1 PUT

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 Enrollments 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 4

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

Enrollments 4
POST
/employers/{employerId}/enrollments
Create Enrollments
create-enrollments 2 params body → 201403422500
GET
/employers/{employerId}/enrollments
List Enrollments of an Employee
get-paginated-enrollments-for-employee 5 params → 200403422500
PUT
/employers/{employerId}/enrollment
Update Enrollment
update-enrollment 2 params body → 403422500
DELETE
/employers/{employerId}/enrollment
Delete Enrollment
delete-enrollment 2 params body → 204403422500

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are BenefitResponseDto (18 properties), EnrollmentResponseDto (15 properties), UpdateEnrollmentRequestDto (12 properties), CreateEnrollmentItemDto (10 properties). Each schema is shown below with its type and property counts.

TierResponseDto
object
7 properties 6 required
CreateEnrollmentsRequestDto
object
3 properties 1 required
BenefitResponseDto
object
18 properties 9 required
BenefitDependencyResponseDto
object
6 properties 4 required
LabelResponseDto
object
5 properties 5 required
EnrollmentResponseDto
object
15 properties 6 required
DeleteEnrollmentRequestDto
object
4 properties 1 required
FeatureItemResponseDto
object
7 properties 3 required
UpdateEnrollmentRequestDto
object
12 properties 1 required
ThresholdResponseDto
object
6 properties 6 required
CreateEnrollmentItemDto
object
10 properties 2 required
NayyaRulePropertiesDto
object
2 properties 2 required
FeatureResponseDto
object
7 properties 6 required
PaginatedEnrollmentsResponseDto
object
4 properties 4 required
ThresholdItemResponseDto
object
6 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nayya-enrollments-api-openapi.yml Raw ↑

Other APIs Nayya publishes across the network.

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