Canopy Account System Tags API

openapi: 3.2.0
info:
  title: Canopy Servicing Core Account System Tags API
  description: 'Canopy allows you to easily manage credit, installment, or other more complex lending programs from a servicing and compliance perspective -

    whether newly launched or migrated from existing systems. using canopy, you can track balances and transactions for each customer of your product, both in real-time and historically.

    You can see how various policy and product changes would impact your customers, and readily generate compliance reports and minimize your risk with all real-time information always on hand.

    Canopy additionally surfaces information around all of your lending activity through its intuitive ui which provides a customer support interface as well as at-a-glance data needed for compliance and insights.

    Simply configure your product`s policies through our create product api endpoint, and then you can immediately begin adding customer accounts and relying on canopy for accurate servicing information.'
  contact:
    name: Canopy Support
    url: https://www.canopyservicing.com/contact
    email: support@canopyservicing.com
  version: 1.0.0
servers:
- url: Contact sales to enable your sandbox
  description: Your private sandbox environment
- url: https://demo-api.us.canopyservicing.com
  description: Demo environment
tags:
- name: Account System Tags
  description: Tags that are automatically applied to an Account based on certain criteria.
paths:
  /core/v1/accounts/{account_id}/system_tags:
    get:
      tags:
      - Account System Tags
      summary: Get all system applied tags associated with an account
      description: Gets all system applied tags associated with an account.
      operationId: AccountSystemTagsCBV_get_all_account_system_applied_tags_core_v1_accounts__account_id__system_tags_get
      security:
      - HTTPBearer: []
      parameters:
      - name: account_id
        in: path
        required: true
        schema:
          type: string
          title: Account Id
      responses:
        '200':
          description: Returns a list of tags that were automatically applied to the account.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/GetSystemTagResponse'
                title: Response Accountsystemtagscbv Get All Account System Applied Tags Core V1 Accounts  Account Id  System Tags Get
        '404':
          description: Entity not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrNotFoundSchema'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
        '500':
          description: A server error has occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrServerErrorSchema'
components:
  schemas:
    TagCategory:
      type: string
      enum:
      - COLLATERAL_LIQUIDATION
      - CREDIT_UTILIZATION
      - DELINQUENCY_BUCKETS
      - DISPUTE_STATUS
      - GRADUATION
      - MISSED_PAYMENT
      - PAYMENT_DEFERRAL
      - PERSISTENT_DEBT
      - TEST_CATEGORY
      title: TagCategory
    ErrServerErrorSchema:
      properties:
        message:
          type: string
          title: Message
          description: The error message
          examples:
          - A server error has occurred.
      type: object
      required:
      - message
      title: ErrServerErrorSchema
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    ErrNotFoundSchema:
      properties:
        message:
          type: string
          title: Message
          description: The error message
          examples:
          - Entity not found.
      type: object
      required:
      - message
      title: ErrNotFoundSchema
    GetSystemTagResponse:
      properties:
        tag_id:
          type: integer
          title: Tag Id
          description: The ID of the tag
          examples:
          - 1
        label:
          type: string
          title: Label
          description: The label of the tag
          examples:
          - 1-30 days delinquent
        description:
          type: string
          title: Description
          description: The description of the tag
          examples:
          - Customer is in the 1-30 days delinquency bucket.
        color:
          $ref: '#/components/schemas/TagColor'
          description: The color of the tag
          examples:
          - yellow
        category:
          $ref: '#/components/schemas/TagCategory'
          description: The category of the tag
          examples:
          - DELINQUENCY_BUCKETS
        active:
          type: boolean
          title: Active
          description: The active status of the tag
          examples:
          - true
      type: object
      required:
      - tag_id
      - label
      - description
      - color
      - category
      - active
      title: GetSystemTagResponse
      description: Response schema for the get system tags endpoint.
    TagColor:
      type: string
      enum:
      - red
      - orange
      - yellow
      - green
      - blue
      - purple
      - pink
      - sky
      - teal
      - gray
      - black
      title: TagColor
      description: Enum for the colors of tags.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer