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

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

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

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

This API exposes 3 operations across 3 paths, and defines 7 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 3 paths 7 schemas 2 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 documents 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 3 paths, the API surfaces 3 operations — 2 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

documents 3
GET
/v1/documents/
List documents
documents_list 2 params → 200404
GET
/v1/documents/{document_id}/
Retrieve a document
documents_retrieve 2 params → 200404503
POST
/v1/documents/download/
Create zip file of selected documents
documents_download_zip 1 param → 200400403202413503

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are DocumentWithData (8 properties), Document (7 properties), PaginatedDocumentList (4 properties), ServiceFailureError (2 properties). Each schema is shown below with its type and property counts.

DocumentResponse
object
1 property 1 required
DocumentWithData
object
8 properties
ServiceFailureError
object
2 properties
UserDocument
Document
object
7 properties
PaginatedDocumentList
object
4 properties 1 required
DocumentWithDataResponse
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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