CertifID

CertifID Bank Lookup API

The BankLookup API from CertifID — 2 operation(s) for banklookup.

GitHub OpenAPI

Documentation

📖
APIReference
https://api.certifid.com/swagger/index.html
📖
Authentication
https://raw.githubusercontent.com/api-evangelist/certifid/refs/heads/main/authentication/certifid-authentication.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/certifid/refs/heads/main/openapi/certifid-banklookup-api-openapi.yml

Other Resources

🔗
OAuthScopes
https://raw.githubusercontent.com/api-evangelist/certifid/refs/heads/main/scopes/certifid-scopes.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/certifid/refs/heads/main/errors/certifid-problem-types.yml
🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/certifid/refs/heads/main/conventions/certifid-conventions.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/certifid/refs/heads/main/data-model/certifid-data-model.yml

OpenAPI Specification

certifid-banklookup-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: CertifID V2 Bank Lookup API
  description: Access to CertifID data and functions for 3rd Party Integrations
  version: v1
security:
- oauth2: []
tags:
- name: BankLookup
paths:
  /api/v1/Bank/{abaRoutingNumber}/WiringDetails:
    get:
      tags:
      - BankLookup
      summary: Lookup a bank's wiring details based on their ABA/routing number.
      parameters:
      - name: abaRoutingNumber
        in: path
        description: The ABA/routing number of the bank to lookup.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Banks.BankWiringDetailsViewModel'
            application/json:
              schema:
                $ref: '#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Banks.BankWiringDetailsViewModel'
            text/json:
              schema:
                $ref: '#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Banks.BankWiringDetailsViewModel'
        '404':
          description: Not Found
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
            application/json:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
            text/json:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
        '400':
          description: Bad Request
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
            application/json:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
            text/json:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
      security:
      - oauth2:
        - CertifIDUser
  /api/v1/Bank/{abaRoutingNumber}:
    get:
      tags:
      - BankLookup
      summary: Lookup a correspondent bank's details based on their ABA/routing number.
      parameters:
      - name: abaRoutingNumber
        in: path
        description: The ABA/routing number of the bank to lookup.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Banks.BankDetails'
            application/json:
              schema:
                $ref: '#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Banks.BankDetails'
            text/json:
              schema:
                $ref: '#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Banks.BankDetails'
        '404':
          description: Not Found
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
            application/json:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
            text/json:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
        '400':
          description: Bad Request
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
            application/json:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
            text/json:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
      security:
      - oauth2:
        - CertifIDUser
components:
  schemas:
    CertifID.V2.PublicAPI.ViewModels.Banks.BankDetails:
      required:
      - abaRoutingNumber
      type: object
      properties:
        abaRoutingNumber:
          minLength: 1
          type: string
          description: The bank's ABA/routing number.
          example: '111904943'
        institutionFullName:
          type: string
          description: The bank's full name.
          example: Texas Bank
        streetAddress:
          maxLength: 150
          minLength: 0
          type: string
          description: The bank's street address.
          example: 1120 US Hwy 79 N
        city:
          maxLength: 27
          minLength: 0
          type: string
          description: The bank's city.
          example: Henderson
        state:
          type: string
          description: The bank's state.
          example: TX
        zipCode:
          type: string
          description: The bank's ZIP code.
          example: '75652'
        phoneNumber:
          type: string
          description: The bank's phone number.
          example: '9036571466'
        bankWireStatus:
          $ref: '#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Banks.BankWireStatusType'
      additionalProperties: false
      description: Details about a bank.
    CertifID.V2.PublicAPI.ViewModels.Banks.BankWireStatusType:
      enum:
      - Unknown
      - Valid
      - CannotTransactWiresElectronically
      - CannotTransactWires
      type: string
    CertifID.V2.PublicAPI.ViewModels.Banks.CorrespondentBankDetails:
      required:
      - abaRoutingNumber
      type: object
      properties:
        abaRoutingNumber:
          minLength: 1
          type: string
          description: The bank's ABA/routing number.
          example: '111904943'
        institutionFullName:
          type: string
          description: The bank's full name.
          example: Texas Bank
        streetAddress:
          maxLength: 150
          minLength: 0
          type: string
          description: The bank's street address.
          example: 1120 US Hwy 79 N
        city:
          maxLength: 27
          minLength: 0
          type: string
          description: The bank's city.
          example: Henderson
        state:
          type: string
          description: The bank's state.
          example: TX
        zipCode:
          type: string
          description: The bank's ZIP code.
          example: '75652'
        phoneNumber:
          type: string
          description: The bank's phone number.
          example: '9036571466'
        bankWireStatus:
          $ref: '#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Banks.BankWireStatusType'
        achWithBeneficiaryFedwire:
          type: boolean
          description: 'The correspondent ABA Routing Number is an ACH, but the bank has

            a Fedwire ABA Routing Number as a beneficiary.'
      additionalProperties: false
      description: Correspondent bank details related to a beneficiary ABA Routing Number.
    CertifID.V2.PublicAPI.ViewModels.Banks.BankWiringDetailsViewModel:
      type: object
      properties:
        beneficiaryBank:
          $ref: '#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Banks.BankDetails'
        correspondentBank:
          $ref: '#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Banks.CorrespondentBankDetails'
      additionalProperties: false
      description: Wiring details for a bank.
    Microsoft.AspNetCore.Mvc.ProblemDetails:
      type: object
      properties:
        type:
          type:
          - string
          - 'null'
        title:
          type:
          - string
          - 'null'
        status:
          type:
          - integer
          - 'null'
          format: int32
        detail:
          type:
          - string
          - 'null'
        instance:
          type:
          - string
          - 'null'
      additionalProperties: {}
  securitySchemes:
    oauth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://auth.certifid.com/authorize?audience=https://api.certifid.com&connection=CertifID-Users-DB
          tokenUrl: https://auth.certifid.com/oauth/token
          scopes: {}