Yodlee Cobrand API

swagger: '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 Cobrand API
  version: 1.1.0
basePath: /
tags:
- name: Cobrand
  description: Cobrand API
paths:
  /cobrand/login:
    post:
      summary: Cobrand Login
      deprecated: false
      produces:
      - application/json;charset=UTF-8
      description: The cobrand login service authenticates a cobrand.<br>Cobrand session in the response includes the cobrand session token (cobSession) <br>which is used in subsequent API calls like registering or signing in the user. <br>The idle timeout for a cobrand session is 2 hours and the absolute timeout is 24 hours. This service can be <br>invoked to create a new cobrand session token. <br><b>Note:</b> This endpoint is deprecated for customers using the API Key-based authentication and is applicable only to customers who use the SAML-based authentication.<br>The content type has to be passed as application/json for the body parameter. <br>
      operationId: cobrandLogin
      responses:
        200:
          schema:
            $ref: '#/definitions/CobrandLoginResponse'
          description: OK
        400:
          schema:
            $ref: '#/definitions/YodleeError'
          description: 'Y800 : Invalid value for cobrandParam'
        401:
          schema:
            $ref: '#/definitions/YodleeError'
          description: 'Y003 : Account is locked, contact Yodlee customer care<br>Y001 : User name and password required'
        404:
          description: Not Found
      parameters:
      - schema:
          $ref: '#/definitions/CobrandLoginRequest'
        in: body
        name: cobrandLoginRequest
        description: cobrandLoginRequest
        required: true
      tags:
      - Cobrand
      consumes:
      - application/json
  /cobrand/config/notifications/events/{eventName}:
    post:
      summary: Subscribe Event
      deprecated: true
      produces:
      - application/json;charset=UTF-8
      description: <b>Refer POST /configs/notifications/events/{eventName}.</b><br>The subscribe events service is used to subscribe to an event for receiving notifications.<br>The callback URL, where the notification will be posted should be provided to this service.<br>If the callback URL is invalid or inaccessible, the subscription will be unsuccessful, and an error will be thrown.<br>Customers can subscribe to REFRESH,DATA_UPDATES and AUTO_REFRESH_UPDATES event.<br><br><b>Notes</b>:<br>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.<br>The content type has to be passed as application/json for the body parameter.<br>
      operationId: createSubscriptionEvent
      responses:
        201:
          description: OK
        400:
          schema:
            $ref: '#/definitions/YodleeError'
          description: 'Y803 : eventName required<br>Y803 : callbackUrl required<br>Y800 : Invalid value for callbackUrl'
        401:
          description: Unauthorized
        404:
          description: Not Found
      parameters:
      - in: path
        name: eventName
        description: eventName
        type: string
        required: true
        enum:
        - REFRESH
        - DATA_UPDATES
        - AUTO_REFRESH_UPDATES
      - schema:
          $ref: '#/definitions/CreateCobrandNotificationEventRequest'
        in: body
        name: eventRequest
        description: eventRequest
        required: true
      tags:
      - Cobrand
      consumes:
      - application/json
    delete:
      summary: Delete Subscription
      deprecated: true
      produces:
      - application/json;charset=UTF-8
      description: <b>Refer DELETE /configs/notifications/events/{eventName}.</b><br>The delete events service is used to unsubscribe from an events service.<br>
      operationId: deleteSubscribedEvent
      responses:
        400:
          schema:
            $ref: '#/definitions/YodleeError'
          description: 'Y803 : eventName required'
        401:
          description: Unauthorized
        204:
          description: OK
        404:
          description: Not Found
      parameters:
      - in: path
        name: eventName
        description: eventName
        type: string
        required: true
        enum:
        - REFRESH
        - DATA_UPDATES
        - AUTO_REFRESH_UPDATES
      tags:
      - Cobrand
    put:
      summary: Update Subscription
      deprecated: true
      produces:
      - application/json;charset=UTF-8
      description: <b>Refer PUT /configs/notifications/events/{eventName}.</b><br>The update events service is used to update the callback URL.<br>If the callback URL is invalid or inaccessible, the subscription will be unsuccessful, and an error will be thrown.<br><b>Note:</b> The content type has to be passed as application/json for the body parameter. <br>
      operationId: updateSubscribedEvent
      responses:
        400:
          schema:
            $ref: '#/definitions/YodleeError'
          description: 'Y803 : eventName required<br>Y803 : callbackUrl required<br>Y800 : Invalid value for callbackUrl'
        401:
          description: Unauthorized
        204:
          description: OK
        404:
          description: Not Found
      parameters:
      - in: path
        name: eventName
        description: eventName
        type: string
        required: true
        enum:
        - REFRESH
        - DATA_UPDATES
        - AUTO_REFRESH_UPDATES
      - schema:
          $ref: '#/definitions/UpdateCobrandNotificationEventRequest'
        in: body
        name: eventRequest
        description: eventRequest
        required: true
      tags:
      - Cobrand
      consumes:
      - application/json
  /cobrand/logout:
    post:
      summary: Cobrand Logout
      deprecated: false
      produces:
      - application/json;charset=UTF-8
      description: The cobrand logout service is used to log out the cobrand.<br>This service does not return a response. The HTTP response code is 204 (Success with no content).<br><b>Note:</b> This endpoint is deprecated for customers using the API Key-based authentication and is applicable only to customers who use the SAML-based authentication.<br>
      operationId: cobrandLogout
      responses:
        401:
          description: Unauthorized
        204:
          description: Logout successful
        404:
          description: Not Found
      tags:
      - Cobrand
      consumes:
      - application/json
  /cobrand/config/notifications/events:
    get:
      summary: Get Subscribed Events
      deprecated: true
      produces:
      - application/json;charset=UTF-8
      description: <b>Refer GET /configs/notifications/events.</b><br>The get events service provides the list of events for which consumers subscribed <br>to receive notifications. <br>
      operationId: getSubscribedEvents
      responses:
        200:
          schema:
            $ref: '#/definitions/CobrandNotificationResponse'
          description: OK
        401:
          description: Unauthorized
        404:
          description: Not Found
      parameters:
      - in: query
        allowEmptyValue: false
        name: eventName
        description: eventName
        type: string
        required: false
        enum:
        - REFRESH
        - DATA_UPDATES
        - AUTO_REFRESH_UPDATES
      tags:
      - Cobrand
  /cobrand/publicKey:
    get:
      summary: Get Public Key
      deprecated: true
      produces:
      - application/json;charset=UTF-8
      description: <b>Refer GET /configs/publicKey.</b><br>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.<br>This endpoint is useful only for PKI enabled.<br>
      operationId: getPublicKey
      responses:
        200:
          schema:
            $ref: '#/definitions/CobrandPublicKeyResponse'
          description: OK
        401:
          description: Unauthorized
        404:
          description: Not Found
      tags:
      - Cobrand
definitions:
  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
  CobrandSession:
    type: object
    title: CobrandSession
    properties:
      cobSession:
        type: string
  UpdateCobrandNotificationEventRequest:
    type: object
    title: UpdateCobrandNotificationEventRequest
    required:
    - event
    properties:
      event:
        $ref: '#/definitions/UpdateCobrandNotificationEvent'
  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
  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
  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
  CobrandLoginRequest:
    type: object
    title: CobrandLoginRequest
    required:
    - cobrand
    properties:
      cobrand:
        $ref: '#/definitions/Cobrand'
  CreateCobrandNotificationEventRequest:
    type: object
    title: CreateCobrandNotificationEventRequest
    required:
    - event
    properties:
      event:
        $ref: '#/definitions/CreateCobrandNotificationEvent'
  CobrandLoginResponse:
    type: object
    title: CobrandLoginResponse
    properties:
      session:
        $ref: '#/definitions/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
  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
  CobrandNotificationResponse:
    type: object
    title: CobrandNotificationResponse
    properties:
      event:
        readOnly: true
        type: array
        items:
          $ref: '#/definitions/CobrandNotificationEvent'
  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