Consumer API
>
API Reference
>
v0
>
Institutions
>
Institution Routing Number Details
openapi: 3.0.0
info:
version: "0.0"
title: Institution Routing Numbers
tags:
- name: Lookup Institution
description: Retrieve the display name of an insitution by routing number
paths:
/institutions:
get:
tags:
- Lookup Institution
description: |
Takes a routing number and returns an institution's legal name.
Note: This requires a valid routing number (ie. a demo/fake routing number will return a 404).
parameters:
- in: query
name: routingNumber
description: Routing number of the desired institution
required: true
schema:
type: integer
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/institutionRoutingNumber"
"404":
description: Not found or ineligible
"/institutions/routing-numbers/{routingNumbers}":
get:
tags:
- Lookup Institution
description: Takes a list of routing numbers and returns an array of objects
containing the associated names
parameters:
- in: path
name: routingNumbers
description: List of routing numbers separated by commas.
required: true
schema:
type: string
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/routingNames"
servers:
- url: 'https://{API_ENVIRONMENT}/a/consumer/api/v0'
variables:
API_ENVIRONMENT:
default: digital.garden-fi.com
description: FI specific hostname
components:
schemas:
institutionRoutingNumber:
type: object
required:
- institutionName
- routingNumber
properties:
institutionName:
type: string
description: Display name of the institution
routingNumber:
type: string
description: Routing number of the institution
routingNames:
type: object
required:
- routingNumbers
properties:
routingNumbers:
type: array
items:
type: object
required:
- institutionName
- routingNumber
properties:
institutionName:
type: string
description: Display name of the institution
routingNumber:
type: string
description: Routing number of the institution
Have a Question?
Have a how-to question? Seeing a weird error? Get help on
StackOverflow.
Register for the Digital Toolkit Meetup
where we answer technical Q&A from the audience.