Canopy Collateral Valuations API

openapi: 3.2.0
info:
  title: Canopy Servicing Core Collateral Valuations 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: Collateral Valuations
  description: Manage valuations for your collaterals in Canopy.
paths:
  /core/v1/secured/collaterals/{collateral_id}/valuations:
    post:
      tags:
      - Collateral Valuations
      summary: Add a valuation to a collateral
      description: Adds a valuation to a collateral.
      operationId: CollateralsCBV_add_collateral_valuation_core_v1_secured_collaterals__collateral_id__valuations_post
      security:
      - HTTPBearer: []
      parameters:
      - name: collateral_id
        in: path
        required: true
        schema:
          type: string
          description: ID of the Collateral
          title: Collateral Id
        description: ID of the Collateral
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateCollateralValuationRequest'
              description: Collateral valuation creation parameters
      responses:
        '201':
          description: Returns the collateral with the valuation added.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetCollateralResponse'
        '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:
    GetLienAssociationResponse:
      properties:
        association_id:
          type: string
          title: Association Id
          description: The ID of the association (loan or line of credit) associated with the lien.
          hidden: false
        association_type:
          $ref: '#/components/schemas/AssociationType'
          description: The type of the association associated with the lien.
          hidden: false
      type: object
      required:
      - association_id
      - association_type
      title: GetLienAssociationResponse
    CollateralStatus:
      type: string
      enum:
      - ACTIVE
      - RELEASED
      - LIQUIDATED
      - SURPLUS_REFUNDED
      - RETURNED
      title: CollateralStatus
    GetCollateralResponse:
      properties:
        collateral_id:
          type: string
          title: Collateral Id
          description: The ID of the collateral to retrieve.
          hidden: false
        account_id:
          type: string
          title: Account Id
          description: The external ID of the account associated with this collateral.
        type:
          $ref: '#/components/schemas/CollateralType'
          description: The type of the collateral.
          hidden: false
        status:
          $ref: '#/components/schemas/CollateralStatus'
          description: The status of the collateral.
          hidden: false
        created_at:
          type: string
          title: Created At
          description: The date and time the collateral was created.
          hidden: false
        current_valuation:
          $ref: '#/components/schemas/GetCollateralValuationResponse'
          description: The current valuation of the collateral.
          hidden: false
        borrower_name:
          type: string
          title: Borrower Name
          description: 'The borrower''s name, shown in this priority order: 1) doing business as name, 2) business legal name, or 3) individual''s full name'
        description:
          type: string
          title: Description
          description: A description of the collateral.
        metadata:
          anyOf:
          - additionalProperties: true
            type: object
          - items:
              additionalProperties: true
              type: object
            type: array
          - items: {}
            type: array
          title: Metadata
          description: Metadata associated with the collateral.
          hidden: false
        associations:
          items:
            $ref: '#/components/schemas/GetCollateralAssociationResponse'
          type: array
          title: Associations
          description: A list of lines of credit and loans associated with the collateral.
          hidden: false
        liens:
          items:
            $ref: '#/components/schemas/GetLienResponse'
          type: array
          title: Liens
          description: A list of liens associated with the collateral. Each lien represents a security interest in the collateral.
          hidden: false
      type: object
      required:
      - collateral_id
      - type
      - status
      - created_at
      - current_valuation
      - associations
      - liens
      title: GetCollateralResponse
      description: Response schema for the get collateral endpoint.
    CollateralType:
      type: string
      enum:
      - REAL_ESTATE
      - VEHICLE
      - EQUIPMENT
      - ACCOUNTS_RECEIVABLE
      - INVENTORY
      - BUSINESS_ASSETS
      - SECURITIES
      - CASH
      - CRYPTOCURRENCY
      - COLLECTIBLES
      title: CollateralType
    ErrBadRequestSchema:
      properties:
        message:
          type: string
          title: Message
          description: The error message
          examples:
          - Your request is invalid.
      type: object
      required:
      - message
      title: ErrBadRequestSchema
    GetCollateralValuationResponse:
      properties:
        effective_at:
          type: string
          title: Effective At
          description: The date and time the valuation is effective.
          hidden: false
        eligible_value_cents:
          type: integer
          title: Eligible Value Cents
          description: The eligible value of the collateral in cents.
          hidden: false
        advance_rate_percent:
          type: number
          title: Advance Rate Percent
          description: The advance rate of the collateral.
          hidden: false
        valuation_type:
          $ref: '#/components/schemas/ValuationType'
          description: The type of valuation used to determine the eligible value.
          hidden: false
        source:
          type: string
          title: Source
          description: The source of the valuation.
          hidden: false
      type: object
      required:
      - effective_at
      - eligible_value_cents
      - advance_rate_percent
      - valuation_type
      - source
      title: GetCollateralValuationResponse
    AssociationType:
      type: string
      enum:
      - LOAN
      - LINE_OF_CREDIT
      title: AssociationType
    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
    LienStatus:
      type: string
      enum:
      - ACTIVE
      - LAPSED
      - RELEASED
      - TERMINATED
      title: LienStatus
    GetCollateralAssociationResponse:
      properties:
        association_id:
          type: string
          title: Association Id
          description: The ID of the association (loan or line of credit) associated with the collateral.
          hidden: false
        association_type:
          $ref: '#/components/schemas/AssociationType'
          description: The type of the association associated with the collateral.
          hidden: false
      type: object
      required:
      - association_id
      - association_type
      title: GetCollateralAssociationResponse
    ValuationType:
      type: string
      enum:
      - FULL_APPRAISAL
      - DESKTOP_APPRAISAL
      - MARKET_VALUE
      - LENDER_ANALYSIS
      - BORROWER_PROVIDED
      title: ValuationType
    CreateCollateralValuationRequest:
      properties:
        eligible_value_cents:
          type: integer
          title: Eligible Value Cents
          description: The eligible value of the collateral, in cents.
          examples:
          - 1000000
          hidden: false
        advance_rate_percent:
          anyOf:
          - type: number
          - type: string
          title: Advance Rate Percent
          description: The advance rate of the collateral, as a whole number (e.g., 5.75 for 5.75%).
          examples:
          - 80
          hidden: false
        valuation_type:
          $ref: '#/components/schemas/ValuationType'
          description: The type of valuation used to determine the eligible value.
          examples:
          - FULL_APPRAISAL
          hidden: false
        source:
          type: string
          title: Source
          description: The source of the valuation.
          examples:
          - XYZ Appraisal Company
          hidden: false
        effective_at:
          type: string
          title: Effective At
          description: The date and time in which collateral valuation is effective
          examples:
          - '2019-10-19T23:59:59Z'
      type: object
      required:
      - eligible_value_cents
      - advance_rate_percent
      - valuation_type
      - source
      title: CreateCollateralValuationRequest
    ErrConflictSchema:
      properties:
        message:
          type: string
          title: Message
          description: The error message
          examples:
          - Entity already exists.
      type: object
      required:
      - message
      title: ErrConflictSchema
    ErrNotFoundSchema:
      properties:
        message:
          type: string
          title: Message
          description: The error message
          examples:
          - Entity not found.
      type: object
      required:
      - message
      title: ErrNotFoundSchema
    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
    GetLienResponse:
      properties:
        lien_id:
          type: string
          title: Lien Id
          description: The ID of the lien.
          hidden: false
        status:
          $ref: '#/components/schemas/LienStatus'
          description: The status of the lien.
          hidden: false
        position:
          type: integer
          title: Position
          description: The position of the lien in the list of liens associated with the collateral.
          hidden: false
        include_in_ltv:
          type: boolean
          title: Include In Ltv
          description: Whether the lien should be included in the LTV calculation.
          hidden: false
        association:
          $ref: '#/components/schemas/GetLienAssociationResponse'
          description: The association (loan or line of credit) associated with the lien. This should only reference loans/lines of credit that exist within Canopy.
        outstanding_debt_amount_cents:
          type: integer
          title: Outstanding Debt Amount Cents
          description: The outstanding debt amount secured by this lien, in cents. This represents the current balance of debt that the lien secures. If missing, this may indicate a blanket lien that secures all current and future debts.
        metadata:
          anyOf:
          - additionalProperties: true
            type: object
          - items:
              additionalProperties: true
              type: object
            type: array
          - items: {}
            type: array
          title: Metadata
          description: Metadata associated with the lien.
          hidden: false
      type: object
      required:
      - lien_id
      - status
      - position
      - include_in_ltv
      title: GetLienResponse
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer