Canopy · Schema

CreateCustomerInput

CompanyB2BLoan ManagementFintechAPI Platform

Properties

Name Type Description
passport object
name_prefix string Prefix to the customer's name.
name_first string Customer's first name.
name_middle string Customer's middle name.
name_last string Customer's last name.
name_suffix string Suffix to the customer's name.
address_line_one string Address line one.
address_line_two string Address line two.
address_city string Address city.
address_state string Address state.
address_zip string Five digit zipcode or nine digit 'ZIP+4'.
address_country_code object ISO 3166-1 alpha-2 country code for the customer.
customer_id string The ID associated to be with the customer for future requests. If not provided on customer creation, Canopy will generate this field.
customer_type object The customer can be either a person or a business. This is used to explicitly set that and adjust behavior such as validation.
customer_parent_id string The customer can be a child customer to another parent customer. This is used most commonly to show a PERSON customer that is a child of a BUSINESS customer.
verification_status object The verification status of this customer. The default is 'unverified'. Depending on the system's configuration verification with third parties will happen and the status will be updated based on the r
title string Title of the customer if a person OR title of the admin if a business
phone_number string Customer's phone number in E.164 format.
ssn string Social security number of the customer.
international_customer_id string Any country-specific unique identifier for the customer.
email string The Customer's email address.
date_of_birth string Customer's date of birth in ISO 8601 format.
business_details object
assign_to_accounts array
metro2_config object
attributes object Arbitrary customer attributes
View JSON Schema on GitHub

JSON Schema

canopyservicing-com-create-customer-input-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/canopyservicing-com/json-schema/canopyservicing-com-create-customer-input-schema.json",
  "title": "CreateCustomerInput",
  "x-generated": "2026-11-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/canopyservicing-com-borrowers-api-openapi.yml#/components/schemas/CreateCustomerInput",
  "properties": {
    "passport": {
      "$ref": "#/$defs/PassportDetails"
    },
    "name_prefix": {
      "type": "string",
      "title": "Name Prefix",
      "description": "Prefix to the customer's name."
    },
    "name_first": {
      "type": "string",
      "title": "Name First",
      "description": "Customer's first name."
    },
    "name_middle": {
      "type": "string",
      "title": "Name Middle",
      "description": "Customer's middle name."
    },
    "name_last": {
      "type": "string",
      "title": "Name Last",
      "description": "Customer's last name."
    },
    "name_suffix": {
      "type": "string",
      "title": "Name Suffix",
      "description": "Suffix to the customer's name."
    },
    "address_line_one": {
      "type": "string",
      "title": "Address Line One",
      "description": "Address line one."
    },
    "address_line_two": {
      "type": "string",
      "title": "Address Line Two",
      "description": "Address line two."
    },
    "address_city": {
      "type": "string",
      "title": "Address City",
      "description": "Address city."
    },
    "address_state": {
      "type": "string",
      "title": "Address State",
      "description": "Address state."
    },
    "address_zip": {
      "type": "string",
      "title": "Address Zip",
      "description": "Five digit zipcode or nine digit 'ZIP+4'."
    },
    "address_country_code": {
      "$ref": "#/$defs/AddressCountryCode",
      "description": "ISO 3166-1 alpha-2 country code for the customer."
    },
    "customer_id": {
      "type": "string",
      "title": "Customer Id",
      "description": "The ID associated to be with the customer for future requests. If not provided on customer creation, Canopy will generate this field."
    },
    "customer_type": {
      "$ref": "#/$defs/CustomerType",
      "description": "The customer can be either a person or a business. This is used to explicitly set that and adjust behavior such as validation."
    },
    "customer_parent_id": {
      "type": "string",
      "title": "Customer Parent Id",
      "description": "The customer can be a child customer to another parent customer. This is used most commonly to show a PERSON customer that is a child of a BUSINESS customer."
    },
    "verification_status": {
      "$ref": "#/$defs/VerificationStatus-Input",
      "description": "The verification status of this customer. The default is 'unverified'. Depending on the system's configuration verification with third parties will happen and the status will be updated based on the result."
    },
    "title": {
      "type": "string",
      "title": "Title",
      "description": "Title of the customer if a person OR title of the admin if a business"
    },
    "phone_number": {
      "type": "string",
      "title": "Phone Number",
      "description": "Customer's phone number in E.164 format."
    },
    "ssn": {
      "type": "string",
      "title": "Ssn",
      "description": "Social security number of the customer."
    },
    "international_customer_id": {
      "type": "string",
      "title": "International Customer Id",
      "description": "Any country-specific unique identifier for the customer."
    },
    "email": {
      "type": "string",
      "title": "Email",
      "description": "The Customer's email address."
    },
    "date_of_birth": {
      "type": "string",
      "format": "date",
      "title": "Date Of Birth",
      "description": "Customer's date of birth in ISO 8601 format."
    },
    "business_details": {
      "$ref": "#/$defs/BusinessDetails-Input"
    },
    "assign_to_accounts": {
      "items": {
        "$ref": "#/$defs/AssignToAccount"
      },
      "type": "array",
      "maxItems": 100,
      "title": "Assign To Accounts"
    },
    "metro2_config": {
      "$ref": "#/$defs/CustomerMetro2Config-Input"
    },
    "attributes": {
      "additionalProperties": {},
      "type": "object",
      "title": "Attributes",
      "description": "Arbitrary customer attributes"
    }
  },
  "type": "object",
  "required": [
    "address_line_one",
    "address_city",
    "address_state",
    "address_zip",
    "phone_number",
    "email",
    "date_of_birth"
  ],
  "$defs": {
    "AccountDesignation": {
      "properties": {
        "account_id": {
          "type": "string",
          "title": "Account Id",
          "description": "the ID of the account associated with the customer"
        },
        "designation": {
          "$ref": "#/$defs/Designation",
          "description": "The designation of the customer for the account."
        }
      },
      "type": "object",
      "title": "AccountDesignation"
    },
    "AddressCountryCode": {
      "type": "string",
      "enum": [
        "US",
        "GB",
        "CA",
        "AF",
        "AX",
        "AL",
        "DZ",
        "AS",
        "AD",
        "AO",
        "AI",
        "AQ",
        "AG",
        "AR",
        "AM",
        "AN",
        "AW",
        "AU",
        "AT",
        "AZ",
        "BS",
        "BH",
        "BD",
        "BB",
        "BY",
        "BE",
        "BZ",
        "BJ",
        "BM",
        "BT",
        "BO",
        "BA",
        "BW",
        "BV",
        "BR",
        "IO",
        "BN",
        "BG",
        "BF",
        "BI",
        "KH",
        "CM",
        "CV",
        "KY",
        "CF",
        "TD",
        "CL",
        "CN",
        "CX",
        "CC",
        "CO",
        "KM",
        "CG",
        "CD",
        "CK",
        "CR",
        "CI",
        "HR",
        "CU",
        "CY",
        "CZ",
        "DK",
        "DJ",
        "DM",
        "DO",
        "EC",
        "EG",
        "SV",
        "GQ",
        "ER",
        "EE",
        "ET",
        "FK",
        "FO",
        "FJ",
        "FI",
        "FR",
        "GF",
        "PF",
        "TF",
        "GA",
        "GM",
        "GE",
        "DE",
        "GH",
        "GI",
        "GR",
        "GL",
        "GD",
        "GP",
        "GU",
        "GT",
        "GG",
        "GN",
        "GW",
        "GY",
        "HT",
        "HM",
        "VA",
        "HN",
        "HK",
        "HU",
        "IS",
        "IN",
        "ID",
        "IR",
        "IQ",
        "IE",
        "IM",
        "IL",
        "IT",
        "JM",
        "JP",
        "JE",
        "JO",
        "KZ",
        "KE",
        "KI",
        "KR",
        "KW",
        "KG",
        "LA",
        "LV",
        "LB",
        "LS",
        "LR",
        "LY",
        "LI",
        "LT",
        "LU",
        "MO",
        "MK",
        "MG",
        "MW",
        "MY",
        "MV",
        "ML",
        "MT",
        "MH",
        "MQ",
        "MR",
        "MU",
        "YT",
        "MX",
        "FM",
        "MD",
        "MC",
        "MN",
        "ME",
        "MS",
        "MA",
        "MZ",
        "MM",
        "NA",
        "NR",
        "NP",
        "NL",
        "NC",
        "NZ",
        "NI",
        "NE",
        "NG",
        "NU",
        "NF",
        "MP",
        "NO",
        "OM",
        "PK",
        "PW",
        "PS",
        "PA",
        "PG",
        "PY",
        "PE",
        "PH",
        "PN",
        "PL",
        "PT",
        "PR",
        "QA",
        "RE",
        "RO",
        "RU",
        "RW",
        "BL",
        "SH",
        "KN",
        "LC",
        "MF",
        "PM",
        "VC",
        "WS",
        "SM",
        "ST",
        "SA",
        "SN",
        "RS",
        "SC",
        "SL",
        "SG",
        "SK",
        "SI",
        "SB",
        "SO",
        "ZA",
        "GS",
        "ES",
        "LK",
        "SD",
        "SR",
        "SJ",
        "SZ",
        "SE",
        "CH",
        "SY",
        "TW",
        "TJ",
        "TZ",
        "TH",
        "TL",
        "TG",
        "TK",
        "TO",
        "TT",
        "TN",
        "TR",
        "TM",
        "TC",
        "TV",
        "UG",
        "UA",
        "AE",
        "UM",
        "UY",
        "UZ",
        "VU",
        "VE",
        "VN",
        "VG",
        "VI",
        "WF",
        "EH",
        "YE",
        "ZM",
        "ZW"
      ],
      "title": "AddressCountryCode"
    },
    "AddressType": {
      "type": "string",
      "enum": [
        "CONFIRMED",
        "KNOWN",
        "NOT_CONFIRMED",
        "MILITARY",
        "SECONDARY",
        "BUSINESS",
        "UNDELIVERABLE",
        "DEFAULT",
        "BILL_PAYER_SERVICE"
      ],
      "title": "AddressType"
    },
    "AssignToAccount": {
      "properties": {
        "account_id": {
          "type": "string",
          "title": "Account Id",
          "description": "This is generated by Canopy. A unique ID for the account."
        },
        "customer_account_role": {
          "$ref": "#/$defs/CustomerAccountRole",
          "description": "The role of the customer for the account."
        },
        "customer_account_external_id": {
          "type": "string",
          "title": "Customer Account External Id",
          "description": "A unique number for the customer on the account. For instance, a credit card number. If none is provided, a Canopy-generated ID can be used."
        },
        "designation": {
          "$ref": "#/$defs/Designation",
          "description": "The designation of the customer for the account."
        }
      },
      "type": "object",
      "required": [
        "account_id",
        "customer_account_role"
      ],
      "title": "AssignToAccount"
    },
    "BloomMetadata-Input": {
      "properties": {
        "address_type": {
          "$ref": "#/$defs/AddressType",
          "description": "Status of the reported address."
        },
        "residence_type": {
          "$ref": "#/$defs/ResidenceType",
          "description": "Optional, if not available or unknown, do not report."
        },
        "account_designations": {
          "items": {
            "$ref": "#/$defs/AccountDesignation"
          },
          "type": "array",
          "title": "Account Designations",
          "description": "A list of accounts associated with the customer."
        }
      },
      "type": "object",
      "title": "BloomMetadata"
    },
    "BusinessDetails-Input": {
      "properties": {
        "business_legal_name": {
          "type": "string",
          "title": "Business Legal Name",
          "description": "The legal name of the Business."
        },
        "doing_business_as": {
          "type": "string",
          "title": "Doing Business As",
          "description": "The DBA name of the Business."
        },
        "business_ein": {
          "type": "string",
          "title": "Business Ein",
          "description": "EIN of the business, expected format in NN-NNNNNNN."
        },
        "business_type": {
          "$ref": "#/$defs/BusinessType",
          "description": "Type of business is used in determining the appropriate validation."
        },
        "business_classification_id": {
          "type": "string",
          "title": "Business Classification Id",
          "description": "UUID that references the business classification. This will eventually be supported by a reference api, however, for now refer to dwolla's specific UUID."
        },
        "website": {
          "type": "string",
          "title": "Website",
          "description": "URL for the business's website. This should be publicly resolvable"
        },
        "controller": {
          "$ref": "#/$defs/Controller"
        }
      },
      "type": "object",
      "title": "BusinessDetails"
    },
    "BusinessType": {
      "type": "string",
      "enum": [
        "sole_proprietorship",
        "llc",
        "unincorporated_association",
        "trust",
        "corporation",
        "corporation_public",
        "non_profile",
        "partnership"
      ],
      "title": "BusinessType"
    },
    "Controller": {
      "properties": {
        "passport": {
          "$ref": "#/$defs/PassportDetails"
        },
        "name_prefix": {
          "type": "string",
          "title": "Name Prefix",
          "description": "Prefix to the customer's name."
        },
        "name_first": {
          "type": "string",
          "title": "Name First",
          "description": "Customer's first name."
        },
        "name_middle": {
          "type": "string",
          "title": "Name Middle",
          "description": "Customer's middle name."
        },
        "name_last": {
          "type": "string",
          "title": "Name Last",
          "description": "Customer's last name."
        },
        "name_suffix": {
          "type": "string",
          "title": "Name Suffix",
          "description": "Suffix to the customer's name."
        },
        "address_line_one": {
          "type": "string",
          "title": "Address Line One",
          "description": "Address line one."
        },
        "address_line_two": {
          "type": "string",
          "title": "Address Line Two",
          "description": "Address line two."
        },
        "address_city": {
          "type": "string",
          "title": "Address City",
          "description": "Address city."
        },
        "address_state": {
          "type": "string",
          "title": "Address State",
          "description": "Address state."
        },
        "address_zip": {
          "type": "string",
          "title": "Address Zip",
          "description": "Five digit zipcode or nine digit 'ZIP+4'."
        },
        "address_country_code": {
          "$ref": "#/$defs/AddressCountryCode",
          "description": "ISO 3166-1 alpha-2 country code for the customer."
        },
        "date_of_birth": {
          "type": "string",
          "format": "date",
          "title": "Date Of Birth",
          "description": "Customer's date of birth in ISO 8601 format"
        },
        "email": {
          "type": "string",
          "title": "Email",
          "description": "The email address of this Customer"
        },
        "title": {
          "type": "string",
          "title": "Title",
          "description": "Title of the customer if a person OR title of the admin if a business"
        },
        "phone_number": {
          "type": "string",
          "title": "Phone Number",
          "description": "Customer's phone number in E.164 format."
        },
        "ssn": {
          "type": "string",
          "title": "Ssn",
          "description": "Social security number of the customer."
        }
      },
      "type": "object",
      "required": [
        "address_line_one",
        "address_city",
        "address_state",
        "address_zip"
      ],
      "title": "Controller"
    },
    "CustomerAccountRole": {
      "type": "string",
      "enum": [
        "PRIMARY",
        "SECONDARY"
      ],
      "title": "CustomerAccountRole"
    },
    "CustomerMetro2Config-Input": {
      "properties": {
        "bloom_metadata": {
          "$ref": "#/$defs/BloomMetadata-Input",
          "description": "Bloom API fields for customers: https://docs.bloom.dev/docs/furnishment-api/b3A6MjA1NTM1MQ-create-consumer"
        }
      },
      "type": "object",
      "title": "CustomerMetro2Config"
    },
    "CustomerType": {
      "type": "string",
      "enum": [
        "person",
        "business"
      ],
      "title": "CustomerType"
    },
    "Designation": {
      "type": "string",
      "enum": [
        "INDIVIDUAL",
        "JOINT_CONTRACTUAL_LIABILITY",
        "AUTHORIZED_USER",
        "COMAKER_OR_GUARANTOR",
        "MAKER",
        "BUSINESS_COMMERCIAL",
        "DECEASED"
      ],
      "title": "Designation"
    },
    "PassportDetails": {
      "properties": {
        "number": {
          "type": "string",
          "title": "Number",
          "description": "Number on the passport"
        },
        "country": {
          "type": "string",
          "title": "Country",
          "description": "ISO 3166-1 Two letter code for the issuing country"
        }
      },
      "type": "object",
      "title": "PassportDetails"
    },
    "ResidenceType": {
      "type": "string",
      "enum": [
        "OWNS",
        "RENTS"
      ],
      "title": "ResidenceType"
    },
    "VerificationStatus-Input": {
      "type": "string",
      "enum": [
        "verified",
        "unverified"
      ],
      "title": "VerificationStatus"
    }
  }
}

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.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/canopyservicing-com-create-customer-input"
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.