TD Bank Consents API

The Consents API from TD Bank — 2 operation(s) for consents.

OpenAPI Specification

td-bank-consents-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: TD Bank Account Basic Accounts Consents API
  description: FDX v6.2 Account Basic endpoint. Returns lightweight account information (accountId, type, displayName, masked number) for every consented TD account so aggregators can enumerate accounts without retrieving full detail.
  version: 1.0.0
  contact:
    name: TD Open Banking Developer Support
    url: https://developer.td.com
servers:
- url: https://api.openbanking.amcb.developer.td.com/fdx/v6
  description: Production
- url: https://api.openbanking.amcb.developer.td.com/sandbox/fdx/v6
  description: Sandbox
security:
- oauth2: []
tags:
- name: Consents
paths:
  /consents/{consentId}:
    get:
      operationId: getConsent
      summary: Get Consent Details
      tags:
      - Consents
      parameters:
      - name: consentId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Consent detail
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Consent'
    delete:
      operationId: revokeConsent
      summary: Revoke Consent
      tags:
      - Consents
      parameters:
      - name: consentId
        in: path
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Revoked
  /consent-revocations:
    get:
      operationId: listConsentRevocations
      summary: List Consent Revocations
      tags:
      - Consents
      responses:
        '200':
          description: Revocations
          content:
            application/json:
              schema:
                type: object
                properties:
                  revocations:
                    type: array
                    items:
                      $ref: '#/components/schemas/ConsentRevocation'
components:
  schemas:
    Consent:
      type: object
      required:
      - consentId
      - status
      properties:
        consentId:
          type: string
        status:
          type: string
          enum:
          - ACTIVE
          - REVOKED
          - EXPIRED
        durationType:
          type: string
        durationPeriod:
          type: integer
        grantedAt:
          type: string
          format: date-time
        expiresAt:
          type: string
          format: date-time
        resources:
          type: array
          items:
            type: object
            properties:
              resourceType:
                type: string
              accountId:
                type: string
              dataClusters:
                type: array
                items:
                  type: string
    ConsentRevocation:
      type: object
      properties:
        consentId:
          type: string
        revokedAt:
          type: string
          format: date-time
        initiator:
          type: string
          enum:
          - CONSUMER
          - DATA_PROVIDER
          - DATA_RECIPIENT
        reason:
          type: string
  securitySchemes:
    oauth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://api.openbanking.amcb.developer.td.com/oauth/v1/authorize
          tokenUrl: https://api.openbanking.amcb.developer.td.com/oauth/v1/token
          scopes:
            accounts_basic_read: Read basic account info
externalDocs:
  description: TD Open Banking — About Our APIs
  url: https://docs.pat.openbanking.amcb.developer.td.com/guides/about-our-apis-hdi