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

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

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

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

This API exposes 5 operations across 3 paths, and defines 16 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/.

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

Paths & Operations 5

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

users 5
GET
/v1/users/deprecated
List joint users
users_list → 200
GET
/v1/users/{user_uuid}/
Retrieve a user
users_retrieve 1 param → 200404
PUT
/v1/users/{user_uuid}/
Update a user
users_update 1 param body → 200403404422
POST
/v1/users/{user_uuid}/estatements/
Sets user to receive estatements
users_estatements_create 1 param → 200404422
DELETE
/v1/users/{user_uuid}/estatements/
Sets user to receive paper statements
users_estatements_destroy 1 param → 200404422

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are Profile (40 properties), Address (7 properties), IncomeSource (6 properties), Phone (3 properties). Each schema is shown below with its type and property counts.

Address
object
7 properties 4 required
BusinessPermissionsField
object
3 properties 3 required
InvalidRequestError
object
2 properties
UserResponse
object
1 property 1 required
NotFoundError
object
2 properties 1 required
UsersResponse
object
1 property 1 required
Profile
object
40 properties
UserCategory4f2Enum
string
IncomeTypeEnum
string
employed - Employed parttime - Part time notemployed - Not employed selfemployed - Self employed retirement - Retirement other - Other
IncomeSource
object
6 properties 2 required
Phone
object
3 properties 1 required
PermissionDeniedError
object
2 properties
OrgRoleEnum
string
EstatementsResponse
object
1 property 1 required
PatchedProfileUpdateRequest
object
Write-serializer for updating paper statements.
1 property
NullEnum

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

narmi-users-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