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

Narmi automatic savings enrollment API

The automatic savings enrollment API from Narmi — 1 operation(s) for automatic savings enrollment.

Narmi automatic savings enrollment API is one of 44 APIs that Narmi publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include automatic savings enrollment. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 3 operations across 1 path, and defines 8 schemas. It is described by OpenAPI 3.0.3, at version v1.

Requests are made against a single base URL, https://api.sandbox.narmi.dev/.

3 operations 1 paths 8 schemas 1 DELETE1 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
v1
Base URL
https://api.sandbox.narmi.dev/
Authentication
OAuth 2.0
Terms of Service
Resource Areas
1

Authentication & Security 1

Narmi automatic savings enrollment API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (oauth2) using the authorizationCode flow, exposing 9 scopes.

Paths & Operations 3

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

automatic savings enrollment 3
GET
/v1/automatic_savings_enrollment/
Get automatic savings enrollment
automatic_savings_enrollment_retrieve → 200422
POST
/v1/automatic_savings_enrollment/
Create automatic savings enrollment
automatic_savings_enrollment_list body → 200422
DELETE
/v1/automatic_savings_enrollment/
Delete automatic savings enrollment
automatic_savings_enrollment_destroy → 200422

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are Account (25 properties), AccountBalance (6 properties), AutomaticSavingsEnrollment (4 properties), Product (3 properties). Each schema is shown below with its type and property counts.

State973Enum
string
AutomaticSavingsEnrollment
object
4 properties
LoanDetails
object
3 properties
AccountBalance
object
A representation of an account with respect to its balance totals.
6 properties
AutomaticSavingsEnrollmentDeserializerRequest
object
2 properties 2 required
SourceEnum
string
institution - institution external - external
Account
object
A representation of either an account or an external account.
25 properties 1 required
Product
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

narmi-automatic-savings-enrollment-api-openapi.yml Raw ↑

Other APIs Narmi publishes across the network.

Narmi account balances API
Narmi accounts API
Narmi ach companies API
Narmi ach destinations API
Narmi ach import API
Narmi ach payments API
Narmi ach transfers API
Narmi alerts API
Narmi card linked offers API
Narmi cards API
Narmi data access management API
Narmi deposits API