Canopy Graduation API

openapi: 3.2.0
info:
  title: Canopy Servicing Core Graduation 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: Graduation
  description: Graduate secured card accounts to unsecured.
paths:
  /core/v1/secured/graduation/accounts/{account_id}/line_of_credit/{line_of_credit_id}:
    post:
      tags:
      - Graduation
      summary: Graduate a secured card line of credit to unsecured
      description: 'Graduates a secured card line of credit to an unsecured card by updating credit limit,

        APR, handling the security deposit, and releasing the collateral.'
      operationId: CollateralsCBV_graduate_line_of_credit_core_v1_secured_graduation_accounts__account_id__line_of_credit__line_of_credit_id__post
      security:
      - HTTPBearer: []
      parameters:
      - name: account_id
        in: path
        required: true
        schema:
          type: string
          description: ID of the Account
          title: Account Id
        description: ID of the Account
      - name: line_of_credit_id
        in: path
        required: true
        schema:
          type: string
          description: ID of the Line of Credit to graduate
          title: Line Of Credit Id
        description: ID of the Line of Credit to graduate
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GraduateLineOfCreditRequest'
              description: Graduation parameters
      responses:
        '200':
          description: Returns the graduation details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GraduateLineOfCreditResponse'
        '400':
          description: Your request is invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrBadRequestSchema'
        '404':
          description: Entity not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrNotFoundSchema'
        '409':
          description: Entity already exists.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrConflictSchema'
        '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:
    CollateralStatus:
      type: string
      enum:
      - ACTIVE
      - RELEASED
      - LIQUIDATED
      - SURPLUS_REFUNDED
      - RETURNED
      title: CollateralStatus
    GraduateLineOfCreditRequest:
      properties:
        external_credit_check_passed:
          type: boolean
          title: External Credit Check Passed
          description: Result of an external credit check. Required for CREDIT_BUREAU and COMPREHENSIVE graduation strategies.
      type: object
      title: GraduateLineOfCreditRequest
    ErrBadRequestSchema:
      properties:
        message:
          type: string
          title: Message
          description: The error message
          examples:
          - Your request is invalid.
      type: object
      required:
      - message
      title: ErrBadRequestSchema
    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
    DepositDisposition:
      type: string
      enum:
      - REFUND_TO_BORROWER
      - APPLY_AS_CREDIT_BALANCE
      title: DepositDisposition
    ErrNotFoundSchema:
      properties:
        message:
          type: string
          title: Message
          description: The error message
          examples:
          - Entity not found.
      type: object
      required:
      - message
      title: ErrNotFoundSchema
    ErrConflictSchema:
      properties:
        message:
          type: string
          title: Message
          description: The error message
          examples:
          - Entity already exists.
      type: object
      required:
      - message
      title: ErrConflictSchema
    ErrServerErrorSchema:
      properties:
        message:
          type: string
          title: Message
          description: The error message
          examples:
          - A server error has occurred.
      type: object
      required:
      - message
      title: ErrServerErrorSchema
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    GraduateLineOfCreditResponse:
      properties:
        account_id:
          type: string
          title: Account Id
          description: The account ID that was graduated
          hidden: false
        line_of_credit_id:
          type: string
          title: Line Of Credit Id
          description: The line of credit ID
          hidden: false
        new_credit_limit_cents:
          type: integer
          title: New Credit Limit Cents
          description: The new credit limit in cents after graduation
          hidden: false
        new_apr_percent:
          type: number
          title: New Apr Percent
          description: The new APR as a percentage after graduation (e.g., 19.99)
          hidden: false
        deposit_disposition:
          $ref: '#/components/schemas/DepositDisposition'
          description: How the security deposit was handled
          hidden: false
        deposit_amount_cents:
          type: integer
          title: Deposit Amount Cents
          description: The deposit amount in cents
          hidden: false
        collateral_id:
          type: string
          title: Collateral Id
          description: The collateral ID
          hidden: false
        collateral_status:
          $ref: '#/components/schemas/CollateralStatus'
          description: The new status of the collateral
          hidden: false
      type: object
      required:
      - account_id
      - line_of_credit_id
      - new_credit_limit_cents
      - new_apr_percent
      - deposit_disposition
      - deposit_amount_cents
      - collateral_id
      - collateral_status
      title: GraduateLineOfCreditResponse
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer