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

The alerts API from Narmi — 6 operation(s) for alerts.

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

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

This API exposes 15 operations across 6 paths, and defines 13 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/.

15 operations 6 paths 13 schemas 3 DELETE6 GET3 POST3 PUT

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 alerts API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (oauth2) using the authorizationCode flow, exposing 9 scopes.

Paths & Operations 15

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

alerts 15
GET
/v1/alerts/account/
List account alerts
account_alert_list 1 param → 200
POST
/v1/alerts/account/
Create an account alert
account_alert_create body → 201403400
GET
/v1/alerts/account/{uuid}/
Retrieve an account alert
account_alert_retrieve 1 param → 200403404
PUT
/v1/alerts/account/{uuid}/
Update an account alert
account_alert_update 1 param body → 200404403400
DELETE
/v1/alerts/account/{uuid}/
Delete an account alert
account_alert_delete 1 param → 204404403
GET
/v1/alerts/loan/
List loan alerts
loan_alert_list 1 param → 200
POST
/v1/alerts/loan/
Create a loan alert
loan_alert_create body → 201403400
GET
/v1/alerts/loan/{uuid}/
Retrieve a loan alert
loan_alert_retrieve 1 param → 200403404
PUT
/v1/alerts/loan/{uuid}/
Update a loan alert
loan_alert_update 1 param body → 200404403400
DELETE
/v1/alerts/loan/{uuid}/
Delete a loan alert
loan_alert_delete 1 param → 204404403
GET
/v1/alerts/transaction/
List transaction alerts
transaction_alert_list 1 param → 200
POST
/v1/alerts/transaction/
Create a transaction alert
transaction_alert_create body → 201403400
GET
/v1/alerts/transaction/{uuid}/
Retrieve a transaction alert
transaction_alert_retrieve 1 param → 200403404
PUT
/v1/alerts/transaction/{uuid}/
Update a transaction alert
transaction_alert_update 1 param body → 200404403400
DELETE
/v1/alerts/transaction/{uuid}/
Delete a transaction alert
transaction_alert_delete 1 param → 204404403

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are AccountAlertRule (10 properties), LoanAlertRule (7 properties), TransactionAlertRule (7 properties), AccountAlertRuleRequest (5 properties). Each schema is shown below with its type and property counts.

DeliveryChannelsEnum
string
sms - sms push - push email - email
LoanAlertRuleRequest
object
3 properties 2 required
TransactionAlertRule
object
7 properties 3 required
PaginatedTransactionAlertRuleList
object
4 properties 2 required
AccountAlertRule
object
10 properties 3 required
AlertKey61cEnum
string
credit - credit debit - debit
TransactionAlertRuleRequest
object
3 properties 3 required
PaginatedLoanAlertRuleList
object
4 properties 2 required
AccountAlertRuleAlertKeyEnum
string
availablebalance - availablebalance lowavailablebalance - lowavailablebalance
LoanAlertRuleAlertKeyEnum
string
loanreminder - loanreminder loanoverdue - loanoverdue
PaginatedAccountAlertRuleList
object
4 properties 2 required
AccountAlertRuleRequest
object
5 properties 3 required
LoanAlertRule
object
7 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

narmi-alerts-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 automatic savings enrollment API
Narmi card linked offers API
Narmi cards API
Narmi data access management API
Narmi deposits API