Scotiabank Account Validation API

openapi: 3.0.3
info:
  title: Scotiabank Scotia TranXact APIs Account Validation API
  description: The Scotia TranXact APIs provide corporate and commercial customers with programmatic access to Scotiabank's payment and cash management services. APIs are designed for integration with Treasury Management Systems (TMS), ERP platforms, and CRM systems. Covers wire payments, real-time payments via INTERAC e-Transfer, EFT payments, account balance and transaction retrieval, account validation, and payment track and trace.
  version: '1.0'
  contact:
    url: https://developer.scotiabank.com/en.html
servers:
- url: https://developer.api.scotiabank.com
  description: Scotiabank API Gateway
security:
- OAuth2: []
tags:
- name: Account Validation
paths:
  /v1/accounts/validate:
    post:
      operationId: validateAccount
      summary: Validate Account
      description: Verify the validity of an account number format and indicate the likelihood of account ownership match for Scotiabank accounts.
      tags:
      - Account Validation
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AccountValidationRequest'
      responses:
        '200':
          description: Account validation result
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountValidationResponse'
components:
  schemas:
    AccountValidationResponse:
      type: object
      properties:
        is_valid_format:
          type: boolean
          description: Whether the account number format is valid
        ownership_match_likelihood:
          type: string
          enum:
          - HIGH
          - MEDIUM
          - LOW
          - UNKNOWN
          description: Likelihood of account ownership match
    AccountValidationRequest:
      type: object
      required:
      - account_number
      properties:
        account_number:
          type: string
        institution_number:
          type: string
        transit_number:
          type: string
        account_holder_name:
          type: string
  securitySchemes:
    OAuth2:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://developer.api.scotiabank.com/auth/token
          scopes:
            payments:write: Initiate payments
            payments:read: Read payment status
            accounts:read: Read account information