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

The enrollments API from Narmi — 5 operation(s) for enrollments.

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

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

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

enrollments 5
POST
/v1/enroll/
Create a digital banking user
enroll_create body → 200400
POST
/v1/enroll_verify/
Verify enrollment code
enroll_verify_create body → 200422
POST
/v1/enrollments
Create enrollment URL
enrollments_create body → 422200
POST
/v1/users/{user_uuid}/enrollment_code/
Create a new enrollment code
users_enrollment_code_create 1 param → 200404422
POST
/v1/users/{user_uuid}/enrollment_complete
Set user as enrolled
users_enrollment_complete_create 1 param body → 204404422

Schemas 19

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

Address
object
7 properties 4 required
Profile
object
40 properties
UserCategory4f2Enum
string
UserCategory905Enum
string
business - business personal - personal
BusinessPermissionsField
object
3 properties 3 required
NullEnum
IncomeSource
object
6 properties 2 required
CreateEnrollmentUrlsResponse
object
1 property 1 required
VerifyEnrollmentDocRequest
object
1 property 1 required
EnrollmentDocRequest
object
6 properties
CreateEnrollmentUrlsURLField
object
1 property 1 required
OrgRoleEnum
string
Device
object
Serializer for two-factor authorization devices.
3 properties
EnrollmentCompleteDocRequest
object
1 property
EnrollmentUrlCreateRequest
object
5 properties
Phone
object
3 properties 1 required
IncomeTypeEnum
string
employed - Employed parttime - Part time notemployed - Not employed selfemployed - Self employed retirement - Retirement other - Other
VerifyEnrollment
object
1 property
Enrollment
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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