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

The mfa API from Narmi — 3 operation(s) for mfa.

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

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

This API exposes 4 operations across 3 paths, 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/.

4 operations 3 paths 8 schemas 1 DELETE2 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 mfa API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (oauth2) using the authorizationCode flow, exposing 9 scopes.

Paths & Operations 4

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

mfa 4
GET
/v1/mfa/
List MFA devices
mfa_list 2 params → 200
DELETE
/v1/mfa/{id}/
Delete MFA device
mfa_destroy 1 param → 204400403404422
GET
/v1/sudo/
Retrieve sudo status
sudo_retrieve → 200404
POST
/v1/sudo/
Elevate sudo permissions
sudo_create body → 200400403

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are MFA (4 properties), CreateSudoErrorResponse (4 properties), Device (3 properties), PaginatedMFAList (3 properties). Each schema is shown below with its type and property counts.

RetrieveSudoResponse
object
1 property
MFATypeEnum
string
phone - phone email - email totp - totp static - static
MFA
object
Serializer for two-factor authorization devices.
4 properties
Device
object
Serializer for two-factor authorization devices.
3 properties
PaginatedMFAList
object
3 properties 3 required
CreateSudo
object
1 property
CreateSudoErrorResponse
object
4 properties 4 required
CreateSudoRequest
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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