Yodlee Consents API

openapi: 3.2.0
info:
  license:
    name: Yodlee Developer License
    url: https://developer.yodlee.com/terms/condition#_Services_1
  contact:
    email: developer@yodlee.com
  description: 'This file describes the Yodlee Platform APIs using the swagger notation. You can use this swagger file to generate client side SDKs to the Yodlee Platform APIs for many different programming languages. Yodlee API v1.1 - Overview</a>.<br><br>You will have to set the header before making the API call. The following headers apply to all the APIs:<ul><li>Authorization: This header holds the access token</li> <li> Api-Version: 1.1</li></ul><b>Note</b>: If there are any API-specific headers, they are mentioned explicitly in the respective API''s description.'
  termsOfService: https://developer.yodlee.com/terms/condition
  title: Yodlee Core APIs Account Token Consents API
  version: 1.1.0
servers:
- url: /
tags:
- name: Consents
  description: Consents API
paths:
  /consents/history/count:
    get:
      summary: Get Consent History Count
      deprecated: false
      description: The count service provides the total number of history records for a specific consent. <br/>If you are implementing pagination for consent history, call this endpoint before calling GET /consents/history to know the number of records for the given consent that are returned for the input parameters passed.<br/>
      operationId: getConsentHistoryCount
      responses:
        200:
          description: OK
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ConsentHistoryCountResponse'
        400:
          description: 'Y800 : Invalid value for consentId <br/>Y803 : consentId is required <br/>Y800 : Invalid value for fromDate<br/>Y800 : Invalid value for toDate<br/>Y809 : Invalid date range<br/>'
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/YodleeError'
        401:
          description: Unauthorized
        404:
          description: Not Found
      parameters:
      - in: query
        allowEmptyValue: false
        name: consentId
        description: Consent Id generated through POST Consent.
        required: true
        schema:
          type: string
      - in: query
        allowEmptyValue: false
        name: fromDate
        description: Consent History from date(YYYY-MM-DD)
        required: false
        schema:
          type: string
      - in: query
        allowEmptyValue: false
        name: toDate
        description: Consent History end date (YYYY-MM-DD)
        required: false
        schema:
          type: string
      tags:
      - Consents
  /consents/history:
    get:
      summary: 'Get Consent History '
      deprecated: false
      description: The get consent history service is used to retrieve all the history related to the consent. <br/>All history event details for few fields like userDataPurge, deidentificationPreference and consentCollectionPeriod may not be available for older AU Open Banking consents and other Open Banking regions.<br/>For any consent, history will be captured and available from consent authorization (consent status Active) event onwards.<br/><b>Note:</b><br/>  i. Duration (fromDate and toDate) is optional. In the absence of duration, one year history is retrieved from today's date.<br/>ii. The pagination feature is available by default. If no values are passed in the skip and top parameters, the API will only return the first 500 records.<br/>
      operationId: getConsentHistory
      responses:
        200:
          description: OK
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ConsentHistoryResponse'
        400:
          description: 'Y800 : Invalid value for consentId <br/>Y803 : consentId is required <br/>Y804 : Permitted values of top between 1 - 500<br/>Y800 : Invalid value for skip<br/>Y800 : Invalid value for fromDate<br/>Y800 : Invalid value for toDate<br/>Y809 : Invalid date range<br/>'
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/YodleeError'
        401:
          description: Unauthorized
        404:
          description: Not Found
      parameters:
      - in: query
        allowEmptyValue: false
        name: consentId
        description: Consent Id generated through POST Consent.
        required: true
        schema:
          type: string
      - in: query
        allowEmptyValue: false
        name: fromDate
        description: Consent History from date(YYYY-MM-DD)
        required: false
        schema:
          type: string
      - in: query
        allowEmptyValue: false
        name: skip
        description: skip (Min 0)
        required: false
        schema:
          type: integer
          format: int32
      - in: query
        allowEmptyValue: false
        name: toDate
        description: Consent History end date (YYYY-MM-DD)
        required: false
        schema:
          type: string
      - in: query
        allowEmptyValue: false
        name: top
        description: top (Max 500)
        required: false
        schema:
          type: integer
          format: int32
      tags:
      - Consents
  /consents/{consentId}:
    get:
      summary: Get Authorization Details
      deprecated: false
      description: The get authorization URL for consent service provides the authorization URL for the renew consent flow, within the consent dashboard.<b>Note:</b>This service supports the localization feature and accepts locale as a header parameter.<br>
      operationId: getConsentDetails
      responses:
        200:
          description: OK
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/UpdatedConsentResponse'
        400:
          description: 'Y800 : Invalid value for consentId <br/>'
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/YodleeError'
        401:
          description: Unauthorized
        404:
          description: Not Found
      parameters:
      - in: path
        name: consentId
        description: Consent Id generated through POST Consent.
        required: true
        schema:
          type: integer
          format: int64
      tags:
      - Consents
    put:
      summary: Put Consent
      deprecated: false
      description: The update consent service is used to capture the user acceptance of the consent presented to him or her. <br/>This service returns the authorization-redirect URL that should be used to display to the user, the bank's authentication interface.<b>Note:</b>This service supports the localization feature and accepts locale as a header parameter.<br>
      operationId: updateConsent
      responses:
        200:
          description: OK
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/UpdatedConsentResponse'
        400:
          description: 'Y800 : Invalid value for consentId <br/>Y800 : Invalid value for consentParam <br/>Y802 : The consent duration days is outside of the range selected during onboarding, hence consentDurationDays not allowed<br>Y803 : consent duration days preference required consentParam <br/>Y812 : Required field/value - scopeId missing in the consentParam <br/>'
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/YodleeError'
        401:
          description: Unauthorized
        404:
          description: Not Found
      parameters:
      - in: path
        name: consentId
        description: Consent Id generated through POST Consent.
        required: true
        schema:
          type: integer
          format: int64
      tags:
      - Consents
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateConsentRequest'
        description: Applicable Open Banking data cluster values.
        required: true
  /consents/preferences:
    get:
      summary: Get Consents Preferences
      deprecated: false
      description: This API service provides user's preferences for the consent
      operationId: getConsentPreferences
      responses:
        200:
          description: OK
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ConsentPreferencesResponse'
        400:
          description: 'Y800 : Invalid value for consentId <br/>Y812 :Required field/value - consentId missing in the request <br/>'
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/YodleeError'
        401:
          description: Unauthorized
        404:
          description: Not Found
      parameters:
      - in: query
        name: consentId
        description: consentId
        required: true
        schema:
          type: string
      tags:
      - Consents
  /consents/{consentId}/renewal:
    put:
      summary: Renew Consent
      deprecated: false
      description: 'The consent renewal service is used to renew the consent by validating the consent state. This API supports both UK and AU Open Banking. </br><b>Renewing an UK Open Banking consent:</b><br><li>Before the grace period of 90 days: The consent will be renewed using the third-party provider (TPP) renewal process that Yodlee does, and no consent reauthorisation is required.The API response will contain the complete renewed consent object.</li><li>After the grace period of 90 days: The API will provide an authorisation URL to redirect the user to the financial institution site to complete the consent reauthorization process.<br><b>Renewing an AU Open Banking consent:</b><br><li>Invoke this API, and in the API response, an authorisation URL will be provided to redirect the user to the financial institution site to complete the consent reauthorisation process.</li><br>'
      operationId: renewConsent
      responses:
        200:
          description: OK
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/RenewConsentResponse'
        400:
          description: 'Y800 : Invalid value for consentId <br/>Y800 : Invalid value for consentParam <br/>Y802 : The consent duration days is outside of the range selected during onboarding, hence consentDurationDays not allowed<br/>Y803 : consent duration days preference required consentParam <br/>Y812 : Required field/value - scopeId missing in the consentParam <br/>'
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/YodleeError'
        401:
          description: Unauthorized
        404:
          description: Not Found
      parameters:
      - in: path
        name: consentId
        description: Consent Id to be renewed.
        required: true
        schema:
          type: integer
          format: int64
      tags:
      - Consents
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RenewConsentRequest'
        description: renewal entity from consent details service.
  /consents:
    post:
      summary: Post Consent
      deprecated: false
      description: The generate consent service is used to generate all the consent information and permissions associated to a provider. <br/>The scope provided in the response is based on the providerId and the datasets provided in the input. <br/>If no dataset value is provided, the datasets that are configured for the customer will be considered. <br/>The configured dataset can be overridden by providing the dataset as an input. <br/>If no applicationName is provided in the input, the default applicationName will be considered. <b>Note:</b>This service supports the localization feature and accepts locale as a header parameter.<br>
      operationId: createConsent
      responses:
        200:
          description: OK
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/CreatedConsentResponse'
        400:
          description: 'Y800 : Invalid value for providerId <br/>Y807 : Resource not found <br/>Y800 : Invalid value for consentParam <br/>Y901 : Service not supported <br/>Y800 : Invalid value for applicationName <br/>'
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/YodleeError'
        401:
          description: Unauthorized
        404:
          description: Not Found
      tags:
      - Consents
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateConsentRequest'
        description: Unique identifier for the provider site(mandatory), the name of the application,  <br/>the flag responsible to include html content in the response, <br/>when passed as true and the name of the dataset attribute supported by the provider.
        required: true
    get:
      summary: Get Consents
      deprecated: false
      description: The get consent service is used to retrieve all the consents submitted to Yodlee. <br>The service can be used to build a manage consent interface or a consent dashboard to implement the renew and revoke consent flows.<br><b>Note:</b>This service supports the localization feature and accepts locale as a header parameter.<br>
      operationId: getConsents
      responses:
        200:
          description: OK
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ConsentResponse'
        401:
          description: Unauthorized
        404:
          description: Not Found
      parameters:
      - in: query
        allowEmptyValue: false
        name: consentIds
        description: Consent Id generated through POST Consent.
        required: false
        schema:
          type: string
      - in: query
        allowEmptyValue: false
        name: include
        description: The flag responsible to include renew details like sharing duration and reauthorization required
        required: false
        schema:
          type: string
      - in: query
        allowEmptyValue: false
        name: providerAccountIds
        description: Unique identifier for the provider account resource. This is created during account addition.
        required: false
        schema:
          type: string
      tags:
      - Consents
components:
  schemas:
    ClientTrustedAdvisorTxt:
      type: object
      title: ClientTrustedAdvisorTxt
      required:
      - description
      properties:
        description:
          description: ClientTrustedAdvisorTxt Description
          type: string
    ThirdPartyADR:
      type: object
      title: ThirdPartyADR
      required:
      - name
      - url
      properties:
        name:
          description: name of ADR
          type: string
        url:
          description: Unique Id of ADR
          type: string
    RenewalConsent:
      type: object
      title: RenewalConsent
      properties:
        defaultRenewalDuration:
          description: Consent default renewal duration.<br><br><b>Endpoints</b>:<ul><li>PUT consents/{consentId}/renewal</li></ul>
          type: string
        isReauthorizationRequired:
          description: Consent eligibility for reauthorization.<br><br><b>Endpoints</b>:<ul><li>PUT consents/{consentId}/renewal</li></ul>
          type: boolean
    UpdatedConsentResponse:
      type: object
      title: UpdatedConsentResponse
      properties:
        consent:
          readOnly: true
          type: array
          items:
            $ref: '#/components/schemas/UpdateConsent'
    ConsentHistoryResponse:
      type: object
      title: ConsentHistoryResponse
      properties:
        consentHistory:
          readOnly: true
          type: array
          items:
            $ref: '#/components/schemas/ConsentHistory'
    RenewConsentRequest:
      type: object
      title: RenewConsentRequest
      properties:
        preferences:
          description: preferences for consent renewal.<br><br><b>Endpoints</b>:<ul><li>PUT consents/{consentId}/renewal</li></ul>
          $ref: '#/components/schemas/RenewConsentPreferences'
        cdrInsightsDisclosure:
          description: Describes the information of the CDR Insights
          $ref: '#/components/schemas/CDRInsightsDisclosure'
        renewal:
          description: renewal entity from consent details service, containing default consent duration and reauthorization eligibility.<br><br><b>Endpoints</b>:<ul><li>PUT consents/{consentId}/renewal</li></ul>
          $ref: '#/components/schemas/RenewalConsent'
        businessUserDetail:
          description: Describes the information of the Business user consent disclosure
          $ref: '#/components/schemas/BusinessUserDetail'
        clientTrustedAdvisor:
          description: describes information of client trusted advisor.
          type: array
          items:
            $ref: '#/components/schemas/ClientTrustedAdvisor'
    ConsentConfirmation:
      type: object
      title: ConsentConfirmation
      required:
      - description
      - header
      properties:
        description:
          description: Consent confirmation Description
          type: string
        header:
          description: Consent confirmation Header
          type: string
    Preferences:
      type: object
      title: Preferences
      required:
      - id
      - title
      - type
      - value
      properties:
        id:
          format: int32
          description: Id of the preference
          type: integer
        label:
          description: Detailed description for each preference
          type: string
        title:
          description: Type of the preferences <br/> additionalUseOfData<br/> userDataPurge
          type: string
        type:
          description: Visual Type of the preference selection
          type: string
        value:
          description: Value of the preference
          type: string
    Consent:
      type: object
      title: Consent
      required:
      - applicationDisplayName
      - clientADR
      - consentId
      - consentStatus
      - expirationDate
      - expirationDateTime
      - links
      - preferences
      - providerId
      - revokeDate
      - revokeDateTime
      - scope
      - startDate
      - startDateTime
      - title
      - titleBody
      properties:
        dataAccessFrequency:
          description: Data Access Frequency explains the number of times that this consent can be used.<br> Otherwise called as consent frequency type.
          type: string
          enum:
          - ONE_TIME
          - RECURRING
        expirationDateTime:
          description: Consent expiry datetime.
          type: string
        otspADR:
          description: Unique/Accredition Id of the ADR
          type: string
        businessUserDetail:
          description: Describes the information of the Business user consent disclosure
          $ref: '#/components/schemas/BusinessUserDetail'
        clientTrustedAdvisor:
          description: describes information of client trusted advisor
          type: array
          items:
            $ref: '#/components/schemas/ClientTrustedAdvisor'
        providerConsentId:
          description: Provider consent id
          type: string
        revokeDate:
          description: Consent revoke date.
          type: string
        title:
          description: Title for the consent form.
          type: string
        applicationDisplayName:
          description: Application display name.
          type: string
        consentId:
          format: int64
          description: Consent Id generated through POST Consent.
          type: integer
        cdrInsightsDisclosure:
          description: Describes the information of the CDR Insights
          $ref: '#/components/schemas/CDRInsightsDisclosure'
        providerId:
          format: int64
          description: Provider Id for which the consent needs to be generated.
          type: integer
        consentStatus:
          description: Status of the consent.
          type: string
          enum:
          - ACTIVE
          - CONSENT_GENERATED
          - CONSENT_ACCEPTED
          - CONSENT_AUTHORIZED
          - CONSENT_MISMATCH
          - PENDING
          - EXPIRED
          - REVOKED
          - CONSENT_REPEALED
        scope:
          description: Scope describes about the consent permissions and their purpose.
          type: array
          items:
            $ref: '#/components/schemas/Scope'
        userDataTreatment:
          description: userDataTreatment describes details consumer data right policy and De-identification of data
          $ref: '#/components/schemas/UserDataTreatment'
        links:
          description: GET consent preferences API details
          type: array
          items:
            $ref: '#/components/schemas/Links'
        expirationDate:
          description: Consent expiry date.
          type: string
        otspADRName:
          description: Name of the Accredited Data Recipient/Organization
          type: string
        preferences:
          description: Preferences describes options about the additional usage of data or purge data
          type: array
          items:
            $ref: '#/components/schemas/Preferences'
        clientADR:
          description: Client Name of the ADR
          type: string
        renewal:
          description: Renewal describes the sharing duration and reauthorization required.
          $ref: '#/components/schemas/Renewal'
        revokeDateTime:
          description: Consent revoke datetime.
          type: string
        titleBody:
          description: Description for the title.
          type: string
        startDateTime:
          description: Consent start datetime.
          type: string
        thirdPartyADR:
          description: ThirdPartyADR describes details of additional parties which are accredited data recipients under organization
          type: array
          items:
            $ref: '#/components/schemas/ThirdPartyADR'
        renewedDateTime:
          description: Consent renewed datetime
          type: string
        providerAccountId:
          format: int64
          description: Unique identifier for the provider account resource. <br>This is created during account addition.<br><br><b>Endpoints</b>:<ul><li>GET providerAccounts</li></ul>
          readOnly: true
          type: integer
        startDate:
          description: Consent start date.
          type: string
    CDRInsights:
      type: object
      title: CDRInsights
      properties:
        description:
          description: name of the insight
          type: string
        detail:
          description: usage of the data for the insight
          type: string
    CDRInsightsDisclosure:
      type: object
      title: CDRInsightsDisclosure
      properties:
        purpose:
          description: purpose of the insights
          type: string
        nonAPName:
          description: non accredited party name
          type: string
        cdrInsights:
          type: array
          items:
            $ref: '#/components/schemas/CDRInsights'
    Links:
      type: object
      title: Links
      required:
      - href
      - methodType
      - rel
      properties:
        methodType:
          description: Type of the HTTP method <br/> GET , PUT , POST , DELETE , ...
          type: string
        rel:
          description: Get Consent preference
          type: string
        href:
          description: Get Consent preference Endpoint
          type: string
    Scope:
      type: object
      title: Scope
      required:
      - scopeId
      - title
      - titleBody
      properties:
        titleBody:
          description: Title body that explains the purpose of the scope.
          type: array
          items:
            type: string
        scopeId:
          description: Unique Dataset Cluster name for the consent group like <br/> ACCOUNT_DETAILS<br/> STATEMENT_DETAILS<br/> CONTACT_DETAILS<br/> TRANSACTION_DETAILS
          type: string
          enum:
          - ACCOUNT_DETAILS
          - TRANSACTION_DETAILS
          - STATEMENT_DETAILS
          - CONTACT_DETAILS
        datasetAttributes:
          description: Permissions that are associated with the Consent group like<br/> BASIC_AGG_DATA.BASIC_ACCOUNT_INFO<br/> BASIC_AGG_DATA.ACCOUNT_DETAILS<br/> BASIC_AGG_DATA.STATEMENTS<br/> BASIC_AGG_DATA.TRANSACTIONS<br/> ACCT_PROFILE.HOLDER_NAME<br/> ACCT_PROFILE.FULL_ACCT_NUMBER<br/> ACCT_PROFILE.BANK_TRANSFER_CODE<br/> ACCT_PROFILE.HOLDER_DETAILS
          type: array
          items:
            type: string
        title:
          description: Title for the Data Cluster.
          type: string
    ConsentPreferencesResponse:
      type: object
      title: ConsentPreferencesResponse
      required:
      - consentId
      - customDisplayData
      - preferences
      properties:
        consentId:
          format: int64
          description: Consent Id generated through POST Consent.
          type: integer
        preferences:
          description: User chosen preference value for consent expiration
          $ref: '#/components/schemas/Preferences'
        customDisplayData:
          description: custom display data
          $ref: '#/components/schemas/CustomDisplayData'
    ContainerAttributes:
      type: object
      title: ContainerAttributes
      properties:
        BANK:
          $ref: '#/components/schemas/TransactionDays'
        LOAN:
          $ref: '#/components/schemas/TransactionDays'
        CREDITCARD:
          $ref: '#/components/schemas/TransactionDays'
        INVESTMENT:
          $ref: '#/components/schemas/TransactionDays'
        INSURANCE:
          $ref: '#/components/schemas/TransactionDays'
    CustomDisplayData:
      type: object
      title: CustomDisplayData
      required:
      - clientTrustedAdvisorTxt
      - consentConfirmation
      - deletePreference
      - thirdParty
      - userDataTreatment
      properties:
        consentConfirmation:
          description: Details of ConsentConfirmation
          $ref: '#/components/schemas/ConsentConfirmation'
        deletePreference:
          description: Details of DeletePreference
          $ref: '#/components/schemas/DeletePreference'
        thirdParty:
          description: Details of ThirdParty
          $ref: '#/components/schemas/ThirdParty'
        clientTrustedAdvisorTxt:
          description: Details of ClientTrustedAdvisorTxt
          $ref: '#/components/schemas/ClientTrustedAdvisorTxt'
        userDataTreatment:
          description: Details of UserDataTreatment
          $ref: '#/components/schemas/UserDataTreatment'
    TotalCount:
      type: object
      title: TotalCount
      properties:
        count:
          format: int64
          readOnly: true
          type: integer
    ConsentHistoryCount:
      type: object
      title: ConsentHistoryCount
      properties:
        TOTAL:
          readOnly: true
          $ref: '#/components/schemas/TotalCount'
    BusinessUserDetail:
      type: object
      title: BusinessUserDetail
      required:
      - abn
      - name
      - status
      - verificationDateTime
      properties:
        name:
          description: entity name of the given ABN
          type: string
        verificationDateTime:
          description: when the ABN status is verified
          type: string
        abn:
          description: Australian Business number issued by ABR
          type: string
        status:
          description: status of the ABN
          type: string
    BusinessUserDetailForCreateConsent:
      type: object
      title: BusinessUserDetailForCreateConsent
      required:
      - abn
      properties:
        abn:
          description: Australian Business number issued by ABR
          type: string
    CreatedConsentResponse:
      type: object
      title: CreatedConsentResponse
      properties:
        consent:
          readOnly: true
          type: array
          items:
            $ref: '#/components/schemas/CreateConsent'
    ConsentResponse:
      type: object
      title: ConsentResponse
      properties:
        consent:
          readOnly: true
          type: array
          items:
            $ref: '#/components/schemas/Consent'
    CreateConsent:
      type: object
      title: CreateConsent
      required:
      - applicationDisplayName
      - clientADR
      - consentId
      - consentStatus
      - expirationDate
      - expirationDateTime
      - links
      - preferences
      - providerId
      - revokeDate
      - revokeDateTime
      - scope
      - startDate
      - startDateTime
      - title
      - titleBody
      properties:
        dataAccessFrequency:
          description: Data Access Frequency explains the number of times that this consent can be used.<br> Otherwise called as consent frequency type.
          type: string
          enum:
          - ONE_TIME
          - RECURRING
        otspADRName:
          description: Name of the Accredited Data Recipient/Organization
          type: string
        expirationDateTime:
          description: Consent expiry datetime.
          type: string
        preferences:
          description: Preferences describes options about the additional usage of data or purge data
          type: array
          items:
            $ref: '#/components/schemas/Preferences'
        otspADR:
          description: Unique/Accredition Id of the ADR
          type: string
        clientADR:
          description: Client Name of the ADR
          type: string
        renewal:
          description: Renewal describes the sharing duration and reauthorization required.
          $ref: '#/components/schemas/Renewal'
        clientTrustedAdvisor:
          description: describes information of client trusted advisor
          type: array
          items:
            $ref: '#/components/schemas/ClientTrustedAdvisor'
        revokeDateTime:
          description: Consent revoke datetime.
          type: string
        providerConsentId:
          description: Provider consent id
          type: string
        revokeDate:
          description: Consent revoke date.
          type: string
        title:
          description: Title for the consent form.
          type: string
        applicationDisplayName:
          description: Application display name.
          type: string
        titleBody:
          description: Description for the title.
          type: string
        consentId:
          format: int64
          description: Consent Id generated through POST Consent.
          type: integer
        startDateTime:
          description: Consent start datetime.
          type: string
        customDisplayData:
          description: customDisplayData describes details thirdParty , consentConfirmation,deletePreference,userdataTreatment and clientTrustedAdvisorTxt
          $ref: '#/components/schemas/CustomDisplayData'
        thirdPartyADR:
          description: ThirdPartyADR describes details of additional parties which are accredited data recipients under organization
          type: array
          items:
            $ref: '#/components/schemas/ThirdPartyADR'
        providerId:
          format: int64
          description: Provider Id for which the consent needs to be generated.
          type: integer
        consentStatus:
          description: Status of the consent.
          type: string
          enum:
          - ACTIVE
          - CONSENT_GENERATED
          - CONSENT_ACCEPTED
          - CONSENT_AUTHORIZED
          - CONSENT_MISMATCH
          - PENDING
          - EXPIRED
          - REVOKED
          - CONSENT_REPEALED
        scope:
          description: Scope describes about the consent permissions and their purpose.
          type: array
          items:
            $ref: '#/components/schemas/Scope'
        links:
          description: GET consent preferences API details
          type: array
          items:
            

# --- truncated at 32 KB (45 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/yodlee/refs/heads/main/openapi/yodlee-consents-api-openapi.yml