Yodlee Cobrand 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.
  termsOfService: https://developer.yodlee.com/terms/condition
  title: Yodlee Core Cobrand API
  version: 1.1.0
servers:
- url: /
tags:
- name: Cobrand
  description: Cobrand API
paths:
  /cobrand/login:
    post:
      summary: Cobrand Login
      deprecated: false
      description: 'The cobrand login service authenticates a cobrand.

        Cobrand session in the response includes the cobrand session token (cobSession)

        which is used in subsequent API calls like registering or signing in the user.

        The idle timeout for a cobrand session is 2 hours and the absolute timeout is 24 hours. This service can be

        invoked to create a new cobrand session token.

        Note: This endpoint is deprecated for customers using the API Key-based authentication and is applicable only to customers who use the SAML-based authentication.

        The content type has to be passed as application/json for the body parameter.'
      operationId: cobrandLogin
      responses:
        200:
          description: OK
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/CobrandLoginResponse'
        400:
          description: 'Y800 : Invalid value for cobrandParam'
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/YodleeError'
        401:
          description: 'Y003 : Account is locked, contact Yodlee customer care<br>Y001 : User name and password required'
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/YodleeError'
        404:
          description: Not Found
      tags:
      - Cobrand
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CobrandLoginRequest'
        description: cobrandLoginRequest
        required: true
  /cobrand/config/notifications/events/{eventName}:
    post:
      summary: Subscribe Event
      deprecated: true
      description: 'Refer POST /configs/notifications/events/{eventName}.

        The subscribe events service is used to subscribe to an event for receiving notifications.

        The callback URL, where the notification will be posted should be provided to this service.

        If the callback URL is invalid or inaccessible, the subscription will be unsuccessful, and an error will be thrown.

        Customers can subscribe to REFRESH,DATA_UPDATES and AUTO_REFRESH_UPDATES event.


        Notes:

        This service is not available in developer sandbox/test environment and will be made available for testing in your dedicated environment, once the contract is signed.

        The content type has to be passed as application/json for the body parameter.'
      operationId: createSubscriptionEvent
      responses:
        201:
          description: OK
        400:
          description: 'Y803 : eventName required<br>Y803 : callbackUrl required<br>Y800 : Invalid value for callbackUrl'
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/YodleeError'
        401:
          description: Unauthorized
        404:
          description: Not Found
      parameters:
      - in: path
        name: eventName
        description: eventName
        required: true
        schema:
          type: string
          enum:
          - REFRESH
          - DATA_UPDATES
          - AUTO_REFRESH_UPDATES
      tags:
      - Cobrand
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateCobrandNotificationEventRequest'
        description: eventRequest
        required: true
    delete:
      summary: Delete Subscription
      deprecated: true
      description: 'Refer DELETE /configs/notifications/events/{eventName}.

        The delete events service is used to unsubscribe from an events service.'
      operationId: deleteSubscribedEvent
      responses:
        400:
          description: 'Y803 : eventName required'
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/YodleeError'
        401:
          description: Unauthorized
        204:
          description: OK
        404:
          description: Not Found
      parameters:
      - in: path
        name: eventName
        description: eventName
        required: true
        schema:
          type: string
          enum:
          - REFRESH
          - DATA_UPDATES
          - AUTO_REFRESH_UPDATES
      tags:
      - Cobrand
    put:
      summary: Update Subscription
      deprecated: true
      description: 'Refer PUT /configs/notifications/events/{eventName}.

        The update events service is used to update the callback URL.

        If the callback URL is invalid or inaccessible, the subscription will be unsuccessful, and an error will be thrown.

        Note: The content type has to be passed as application/json for the body parameter.'
      operationId: updateSubscribedEvent
      responses:
        400:
          description: 'Y803 : eventName required<br>Y803 : callbackUrl required<br>Y800 : Invalid value for callbackUrl'
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/YodleeError'
        401:
          description: Unauthorized
        204:
          description: OK
        404:
          description: Not Found
      parameters:
      - in: path
        name: eventName
        description: eventName
        required: true
        schema:
          type: string
          enum:
          - REFRESH
          - DATA_UPDATES
          - AUTO_REFRESH_UPDATES
      tags:
      - Cobrand
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateCobrandNotificationEventRequest'
        description: eventRequest
        required: true
  /cobrand/logout:
    post:
      summary: Cobrand Logout
      deprecated: false
      description: 'The cobrand logout service is used to log out the cobrand.

        This service does not return a response. The HTTP response code is 204 (Success with no content).

        Note: This endpoint is deprecated for customers using the API Key-based authentication and is applicable only to customers who use the SAML-based authentication.'
      operationId: cobrandLogout
      responses:
        401:
          description: Unauthorized
        204:
          description: Logout successful
        404:
          description: Not Found
      tags:
      - Cobrand
  /cobrand/config/notifications/events:
    get:
      summary: Get Subscribed Events
      deprecated: true
      description: 'Refer GET /configs/notifications/events.

        The get events service provides the list of events for which consumers subscribed

        to receive notifications.'
      operationId: getSubscribedEvents
      responses:
        200:
          description: OK
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/CobrandNotificationResponse'
        401:
          description: Unauthorized
        404:
          description: Not Found
      parameters:
      - in: query
        allowEmptyValue: false
        name: eventName
        description: eventName
        required: false
        schema:
          type: string
          enum:
          - REFRESH
          - DATA_UPDATES
          - AUTO_REFRESH_UPDATES
      tags:
      - Cobrand
  /cobrand/publicKey:
    get:
      summary: Get Public Key
      deprecated: true
      description: 'Refer GET /configs/publicKey.

        The get public key service provides the customer the public key that should be used to encrypt the user credentials before sending it to Yodlee.

        This endpoint is useful only for PKI enabled.'
      operationId: getPublicKey
      responses:
        200:
          description: OK
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/CobrandPublicKeyResponse'
        401:
          description: Unauthorized
        404:
          description: Not Found
      tags:
      - Cobrand
components:
  schemas:
    CobrandPublicKeyResponse:
      type: object
      title: CobrandPublicKeyResponse
      properties:
        keyAlias:
          description: The key name used for encryption.<br><br><b>Endpoints</b>:<ul><li>GET cobrand/publicKey</li></ul>
          readOnly: true
          type: string
        keyAsPemString:
          description: Public key that the customer should be using to encrypt the credentials and answers before sending to the add & update providerAccounts APIs.<br><br><b>Endpoints</b>:<ul><li>GET cobrand/publicKey</li></ul>
          readOnly: true
          type: string
    UpdateCobrandNotificationEventRequest:
      type: object
      title: UpdateCobrandNotificationEventRequest
      required:
      - event
      properties:
        event:
          $ref: '#/components/schemas/UpdateCobrandNotificationEvent'
    CobrandLoginRequest:
      type: object
      title: CobrandLoginRequest
      required:
      - cobrand
      properties:
        cobrand:
          $ref: '#/components/schemas/Cobrand'
    Cobrand:
      type: object
      title: Cobrand
      required:
      - cobrandLogin
      - cobrandPassword
      properties:
        cobrandLogin:
          minLength: 1
          type: string
          maxLength: 2147483647
        cobrandPassword:
          minLength: 1
          type: string
          maxLength: 2147483647
        locale:
          pattern: '[a-z]{2}_[A-Z]{2}'
          description: The customer's locale that will be considered for the localization functionality.<br><br><b>Endpoints</b>:<ul><li>POST cobrand/login</li></ul>
          type: string
    CreateCobrandNotificationEventRequest:
      type: object
      title: CreateCobrandNotificationEventRequest
      required:
      - event
      properties:
        event:
          $ref: '#/components/schemas/CreateCobrandNotificationEvent'
    UpdateCobrandNotificationEvent:
      type: object
      title: UpdateCobrandNotificationEvent
      properties:
        callbackUrl:
          minLength: 1
          description: URL to which the notification should be posted.<br><br><b>Endpoints</b>:<ul><li>GET cobrand/config/notifications/events</li></ul>
          type: string
          maxLength: 2147483647
    YodleeError:
      type: object
      title: YodleeError
      properties:
        errorMessage:
          description: The descriptive message that explains the error scenario.
          readOnly: true
          type: string
        errorCode:
          description: The error code follows the format YNNN. The error codes do not change. New error codes may be added as we introduce new features and enhance functionalities.
          readOnly: true
          type: string
        referenceCode:
          description: Unique Yodlee identifier used to troubleshoot issues at Yodlee's end.
          readOnly: true
          type: string
    CreateCobrandNotificationEvent:
      type: object
      title: CreateCobrandNotificationEvent
      properties:
        callbackUrl:
          minLength: 1
          description: URL to which the notification should be posted.<br><br><b>Endpoints</b>:<ul><li>GET cobrand/config/notifications/events</li></ul>
          type: string
          maxLength: 2147483647
    CobrandNotificationEvent:
      type: object
      title: CobrandNotificationEvent
      properties:
        name:
          description: Name of the event for which the customers must subscribe to receive notifications.<br><b>Valid Value:</b> Notification Events Name<br><br><b>Endpoints</b>:<ul><li>GET cobrand/config/notifications/events</li></ul><b>Applicable Values</b><br>
          type: string
          enum:
          - REFRESH
          - DATA_UPDATES
          - AUTO_REFRESH_UPDATES
        callbackUrl:
          minLength: 1
          description: URL to which the notification should be posted.<br><br><b>Endpoints</b>:<ul><li>GET cobrand/config/notifications/events</li></ul>
          type: string
          maxLength: 2147483647
    CobrandSession:
      type: object
      title: CobrandSession
      properties:
        cobSession:
          type: string
    CobrandLoginResponse:
      type: object
      title: CobrandLoginResponse
      properties:
        session:
          $ref: '#/components/schemas/CobrandSession'
        cobrandId:
          format: int64
          description: Unique identifier of the cobrand (customer) in the system.<br><br><b>Endpoints</b>:<ul><li>POST cobrand/login</li></ul>
          readOnly: true
          type: integer
        applicationId:
          description: The application identifier.<br><br><b>Endpoints</b>:<ul><li>POST cobrand/login</li></ul>
          readOnly: true
          type: string
        locale:
          description: The customer's locale that will be considered for the localization functionality.<br><br><b>Endpoints</b>:<ul><li>POST cobrand/login</li></ul>
          readOnly: true
          type: string
    CobrandNotificationResponse:
      type: object
      title: CobrandNotificationResponse
      properties:
        event:
          readOnly: true
          type: array
          items:
            $ref: '#/components/schemas/CobrandNotificationEvent'