Canopy LTV API

openapi: 3.2.0
info:
  title: Canopy Servicing Core LTV 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: LTV
  description: Manage LTV for your loans and lines of credit in Canopy.
paths:
  /core/v1/secured/ltv:
    get:
      tags:
      - LTV
      summary: Get the Loan To Value ratio
      description: Gets the LTV for the loan or line of credit.
      operationId: CollateralsCBV_get_ltv_core_v1_secured_ltv_get
      security:
      - HTTPBearer: []
      parameters:
      - name: loan_id
        in: query
        required: false
        schema:
          type: string
          description: Returns the LTV for the provided loan_id.
          examples:
          - loan_123
          title: Loan Id
        description: Returns the LTV for the provided loan_id.
      - name: line_of_credit_id
        in: query
        required: false
        schema:
          type: string
          description: Returns the LTV for the provided line_of_credit_id.
          examples:
          - loc_123
          title: Line Of Credit Id
        description: Returns the LTV for the provided line_of_credit_id.
      responses:
        '200':
          description: Returns the LTV for the loan or line of credit.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetLtvResponse'
        '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'
        '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:
    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
    GetLtvResponse:
      properties:
        loan_id:
          type: string
          title: Loan Id
          description: The ID of the loan.
        line_of_credit_id:
          type: string
          title: Line Of Credit Id
          description: The ID of the line of credit.
        ltv_type:
          $ref: '#/components/schemas/LtvTypes'
          description: The type of Loan To Value ratio for the loan or line of credit.
          hidden: false
        ltv_percent:
          type: number
          title: Ltv Percent
          description: The Loan To Value ratio for the loan or line of credit. If LTV is not computable, it will be None.
        max_allowed_ltv_percent:
          type: number
          title: Max Allowed Ltv Percent
          description: The maximum Loan To Value ratio allowed for the loan or line of credit.
          hidden: false
      type: object
      required:
      - ltv_type
      - max_allowed_ltv_percent
      title: GetLtvResponse
    ErrNotFoundSchema:
      properties:
        message:
          type: string
          title: Message
          description: The error message
          examples:
          - Entity not found.
      type: object
      required:
      - message
      title: ErrNotFoundSchema
    LtvTypes:
      type: string
      enum:
      - CURRENT_BALANCE_LTV
      - CREDIT_LIMIT_LTV
      title: LtvTypes
    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
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer