Properties
| Name | Type | Description |
|---|---|---|
| collateral_to_substitute | array | IDs of the collaterals to be substituted |
| replacement_collateral | array | IDs of existing collaterals or new collateral requests to substitute with |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://artifacts.apis.io/canopyservicing-com/json-schema/canopyservicing-com-collateral-substitution-request-schema.json",
"title": "CollateralSubstitutionRequest",
"x-generated": "2026-11-04",
"x-method": "derived",
"x-generator": "derive-json-schema.py",
"x-source": "openapi/canopyservicing-com-collaterals-api-openapi.yml#/components/schemas/CollateralSubstitutionRequest",
"properties": {
"collateral_to_substitute": {
"items": {
"type": "string"
},
"type": "array",
"minItems": 1,
"title": "Collateral To Substitute",
"description": "IDs of the collaterals to be substituted",
"hidden": false
},
"replacement_collateral": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"$ref": "#/$defs/CreateCollateralRequest"
}
]
},
"type": "array",
"minItems": 1,
"title": "Replacement Collateral",
"description": "IDs of existing collaterals or new collateral requests to substitute with",
"hidden": false
}
},
"type": "object",
"required": [
"collateral_to_substitute",
"replacement_collateral"
],
"$defs": {
"AssociationType": {
"type": "string",
"enum": [
"LOAN",
"LINE_OF_CREDIT"
],
"title": "AssociationType"
},
"CollateralType": {
"type": "string",
"enum": [
"REAL_ESTATE",
"VEHICLE",
"EQUIPMENT",
"ACCOUNTS_RECEIVABLE",
"INVENTORY",
"BUSINESS_ASSETS",
"SECURITIES",
"CASH",
"CRYPTOCURRENCY",
"COLLECTIBLES"
],
"title": "CollateralType"
},
"CreateCollateralRequest": {
"properties": {
"collateral_id": {
"type": "string",
"title": "Collateral Id",
"description": "The ID associated with the collateral for future requests. If not provided on creation, Canopy will generate this field."
},
"type": {
"$ref": "#/$defs/CollateralType",
"description": "The type of collateral to create.",
"hidden": false
},
"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"
}
],
"maxLength": 100,
"title": "Metadata",
"description": "Metadata associated with the collateral."
},
"initial_valuation": {
"$ref": "#/$defs/CreateCollateralValuationRequest",
"description": "The initial valuation of the collateral",
"hidden": false
},
"liens": {
"items": {
"$ref": "#/$defs/CreateLienRequest"
},
"type": "array",
"title": "Liens",
"description": "A list of liens associated with the collateral. Each lien represents a security interest in the collateral. Only liens tied to loans or lines of credit (LOCs) created outside of this system should be included here."
}
},
"type": "object",
"required": [
"type",
"initial_valuation"
],
"title": "CreateCollateralRequest",
"description": "Request schema for creating a collateral."
},
"CreateCollateralValuationRequest": {
"properties": {
"eligible_value_cents": {
"type": "integer",
"title": "Eligible Value Cents",
"description": "The eligible value of the collateral, in cents.",
"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%).",
"hidden": false
},
"valuation_type": {
"$ref": "#/$defs/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
},
"effective_at": {
"type": "string",
"title": "Effective At",
"description": "The date and time in which collateral valuation is effective"
}
},
"type": "object",
"required": [
"eligible_value_cents",
"advance_rate_percent",
"valuation_type",
"source"
],
"title": "CreateCollateralValuationRequest"
},
"CreateLienAssociationRequest": {
"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": "#/$defs/AssociationType",
"description": "The type of the association associated with the lien.",
"hidden": false
}
},
"type": "object",
"required": [
"association_id",
"association_type"
],
"title": "CreateLienAssociationRequest"
},
"CreateLienRequest": {
"properties": {
"lien_id": {
"type": "string",
"title": "Lien Id",
"description": "The ID associated with the lien for future requests. If not provided on creation, Canopy will generate this field."
},
"position": {
"type": "integer",
"exclusiveMinimum": 0,
"title": "Position",
"description": "The position of the lien in the list of liens associated with the collateral. The highest priority lien should have a position of 1.",
"hidden": false
},
"include_in_ltv": {
"type": "boolean",
"title": "Include In Ltv",
"description": "Whether the lien should be included in the LTV calculation.",
"hidden": false
},
"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 not provided (null), this may indicate a blanket lien that secures all current and future debts."
},
"association": {
"$ref": "#/$defs/CreateLienAssociationRequest",
"description": "The association (loan or line of credit) associated with the lien. This should only reference loans/lines of credit that exist within Canopy."
},
"metadata": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"items": {
"additionalProperties": true,
"type": "object"
},
"type": "array"
},
{
"items": {},
"type": "array"
}
],
"maxLength": 100,
"title": "Metadata",
"description": "Metadata associated with the lien."
}
},
"type": "object",
"required": [
"position",
"include_in_ltv"
],
"title": "CreateLienRequest"
},
"ValuationType": {
"type": "string",
"enum": [
"FULL_APPRAISAL",
"DESKTOP_APPRAISAL",
"MARKET_VALUE",
"LENDER_ANALYSIS",
"BORROWER_PROVIDED"
],
"title": "ValuationType"
}
}
}
Work with this as data
Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for schemas
4 MCP tools reach this
find_json_schemasBrowse and filter every JSON Schema in the catalog.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/canopyservicing-com-collateral-substitution-request"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.