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

The accounts API from Narmi — 10 operation(s) for accounts.

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

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

This API exposes 14 operations across 10 paths, and defines 42 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/.

14 operations 10 paths 42 schemas 1 DELETE7 GET5 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 accounts API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (oauth2) using the authorizationCode flow, exposing 9 scopes.

Paths & Operations 14

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

accounts 14
GET
/v1/accounts/
List accounts
accounts_list → 200500
POST
/v1/accounts/
Create external account
accounts_create body → 201422
GET
/v1/accounts/{account_uuids}/transactions/
List user transactions
transactions_list 11 params → 200404422500
GET
/v1/accounts/{account_uuid}/documents/{document_id}/
Retrieve a document
accounts_documents_retrieve 3 params → 200404503
GET
/v1/accounts/{account_uuid}/holds/
List holds for account
accounts_holds_list 1 param → 200404500
GET
/v1/accounts/{account_uuid}/stops/
List stop payments
accounts_stops_list 1 param → 200404503
POST
/v1/accounts/{account_uuid}/stops/
Create a stop payment
accounts_stops_create 1 param body → 201422404500503
GET
/v1/accounts/{account_uuid}/transactions_download/
Get transactions download
accounts_transactions_download_retrieve 5 params → 200404422
GET
/v1/accounts/{uuid}/
Retrieve an account
accounts_retrieve 1 param → 200403404
PUT
/v1/accounts/{uuid}/
Update an account
accounts_update 1 param body → 200403404
DELETE
/v1/accounts/{uuid}/
Remove user from an account
accounts_destroy 1 param → 200403404422
POST
/v1/accounts/{uuid}/verify/
Run account verification
account_verify 1 param body → 200403404422
POST
/v1/accounts/{uuid}/withdrawals/
Create account withdrawal
accounts_withdrawals_create 1 param body → 200422503
POST
/v1/accounts/verify/
Run instant account verification
account_verify_instant body → 200400404422

Schemas 42

The contract defines 42 schemas that model the data the API accepts and returns. The most detailed are MobileAccount (25 properties), Transaction (20 properties), DocumentWithData (8 properties), Document (7 properties). Each schema is shown below with its type and property counts.

DocumentResponse
object
1 property 1 required
LoanDetails
object
3 properties
ProductTypeEnum
string
checking - Checking savings - Savings loan - Loan
GeneralError
object
2 properties 1 required
DocumentWithData
object
8 properties
Transaction
object
Representation of a non-pending monetary transaction.
20 properties
HoldsListResponse
object
3 properties 2 required
ExternalAccountCreateRequest
object
Shared fields and validation for all ExternalAccount serializers.
6 properties 5 required
AccountMeta
object
1 property 1 required
PaginatedAccounts
object
3 properties 3 required
SourceEnum
string
institution - institution external - external
PageNumberPagination
object
2 properties 2 required
NestedAccount
object
1 property 1 required
NullEnum
PatchedAccountStopRequest
object
3 properties
AccountStop
object
4 properties 1 required
AccountBalance
object
A representation of an account with respect to its balance totals.
6 properties
Location
object
3 properties
ServiceFailureError
object
2 properties
PermissionDeniedError
object
2 properties
TransactionsResponse
object
3 properties 3 required
Type61cEnum
string
Hold
object
4 properties
NestedAccounts
object
1 property 1 required
PaginatedAccountStopsResponse
object
3 properties 1 required
TransactionResponseMeta
object
3 properties 1 required
Product
object
3 properties
State973Enum
string
NotFoundError
object
2 properties 1 required
AccountWithdrawalRequest
object
1 property 1 required
MobileAccount
object
A representation of either an account or an external account.
25 properties 1 required
AccountPurposeEnum
string
personal - Personal business - Business
AccountsNotFoundError
object
2 properties
UpdateAccountDocRequest
object
3 properties
InvalidRequestError
object
2 properties
UserDocument
AccountStopResponse
object
1 property 1 required
Document
object
7 properties
Check
object
1 property
Success
object
1 property
ExternalAccountVerificationRequest
object
1 property
DocumentWithDataResponse
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

narmi-accounts-api-openapi.yml Raw ↑

Other APIs Narmi publishes across the network.

Narmi account balances 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
Narmi deposits API