{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/inscribe/json-schema/inscribe-customer-schema.json",
  "title": "Customer",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/inscribe-customers-api-openapi.yml#/components/schemas/Customer",
  "type": "object",
  "required": [
    "name"
  ],
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "description": "Unique identifier for the object."
    },
    "name": {
      "type": "string",
      "maxLength": 128,
      "description": "A unique name that was given to the customer by you."
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "Time at which the object was created. In the format: yyyy-MM-dd'T'HH:mm:ssZ"
    },
    "approved": {
      "type": [
        "boolean",
        "null"
      ],
      "description": "Has the value false if you have identified the customer as fraudulent, true is legitimate, and null if unknown. The default is null.",
      "deprecated": true
    },
    "review": {
      "$ref": "#/$defs/Review"
    },
    "notes": {
      "type": [
        "string",
        "null"
      ],
      "description": "Additional notes that you have recorded about this customer."
    },
    "no_of_documents": {
      "type": "integer",
      "description": "A whole number representing the number of documents attached to this customer."
    },
    "no_of_fraudulent_documents": {
      "type": "integer",
      "description": "A whole number representing the number of attached documents that have been identified as fraudulent."
    },
    "urls": {
      "type": "object",
      "properties": {
        "web_app": {
          "type": "string",
          "description": "A URL to the location of this customer on our web app."
        },
        "api": {
          "type": "string",
          "description": "A URL to the location of this customer on our API."
        }
      }
    },
    "creator": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "format": "uuid",
          "description": "Unique identifier of the user who created this customer."
        },
        "email": {
          "type": "string",
          "format": "email",
          "description": "The email address of the user who created this customer."
        },
        "type": {
          "type": "string",
          "enum": [
            "USER",
            "API"
          ],
          "description": "Indicates whether the creator is a human dashboard user or an API key. When the value is `API`, the `email` field will contain the string `\"API User\"` rather than an email address."
        }
      }
    },
    "organisation": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "format": "uuid",
          "description": "Unique identifier of the organisation this customer belongs to."
        }
      }
    },
    "risk_assessment": {
      "$ref": "#/$defs/CustomerRiskAssessment"
    },
    "persons": {
      "$ref": "#/$defs/Persons"
    },
    "company": {
      "allOf": [
        {
          "$ref": "#/$defs/Company"
        }
      ]
    },
    "fraud_rating": {
      "deprecated": true,
      "description": "Deprecated: This field is being phased out. Use `risk_assessment.risk_level` instead. The value is `null` when no fraud rating has been determined.",
      "allOf": [
        {
          "$ref": "#/$defs/CustomerFraudRating"
        }
      ]
    },
    "verify_entity": {
      "$ref": "#/$defs/VerifyEntityResponse"
    },
    "canonical_profile": {
      "description": "Structured profile information aggregated from documents and verification sources for this customer. The value is `null` when no canonical profile has been generated.",
      "allOf": [
        {
          "$ref": "#/$defs/CanonicalProfile"
        }
      ]
    },
    "business_compliance_agent_v1": {
      "deprecated": true,
      "description": "Deprecated: This field is deprecated. Compliance insights can now be found in the risk_assessment object.",
      "allOf": [
        {
          "$ref": "#/$defs/BusinessComplianceAnalyst"
        }
      ]
    }
  },
  "$defs": {
    "Address": {
      "type": "object",
      "description": "The structured address. Any or all of these fields can be empty",
      "properties": {
        "line_1": {
          "type": [
            "string",
            "null"
          ],
          "description": "First line of the address"
        },
        "line_2": {
          "type": [
            "string",
            "null"
          ],
          "description": "Second line of the address"
        },
        "city": {
          "type": [
            "string",
            "null"
          ],
          "description": "City of the address"
        },
        "post_code": {
          "type": [
            "string",
            "null"
          ],
          "description": "Post code of the address"
        },
        "state": {
          "type": [
            "string",
            "null"
          ],
          "description": "State field of the address"
        },
        "country": {
          "type": [
            "string",
            "null"
          ],
          "description": "Country of the address"
        }
      }
    },
    "BusinessComplianceAnalyst": {
      "type": "object",
      "description": "AI-powered Business Compliance Analyst results that perform deep KYB due diligence on the company and its associated individuals.\nNOTE: This feature requires explicit access. Please contact your Customer Success Manager or sales@inscribe.ai to enable this feature.\n",
      "properties": {
        "run_id": {
          "type": "string",
          "description": "A unique identifier for the specific run of the Business Compliance Analyst"
        },
        "customer_id": {
          "type": "string",
          "format": "uuid",
          "description": "A unique identifier for the customer object"
        },
        "status": {
          "type": "string",
          "description": "The current status of the compliance check process.\n`RUNNING`: The review process is currently in progress.\n`FINISHED`: The review process has been successfully completed.\n`FAILED`: The review process encountered an error and could not be completed.\n",
          "enum": [
            "RUNNING",
            "FINISHED",
            "FAILED"
          ]
        },
        "started_at": {
          "type": "string",
          "format": "date-time",
          "description": "The timestamp when the Business Compliance review started. In the format yyyy-MM-dd'T'HH:mm:ssZ"
        },
        "finished_at": {
          "type": "string",
          "format": "date-time",
          "description": "The timestamp when the Business Compliance review finished. In the format yyyy-MM-dd'T'HH:mm:ssZ"
        },
        "output": {
          "$ref": "#/$defs/BusinessComplianceAnalystOutput",
          "description": "The output of the Business Compliance review. This field can be `null` when the status is not `FINISHED`."
        }
      }
    },
    "BusinessComplianceAnalystBaseCheck": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "type": {
              "type": "string"
            },
            "title": {
              "type": "string"
            }
          }
        },
        {
          "type": "object",
          "properties": {
            "result": {
              "type": "string",
              "description": "Result of the check.\n`PASS`: The check passed - no issues were identified.\n`FAIL`: The check failed - issues were identified.\n`INCONCLUSIVE`: The check is inconclusive - unable to determine PASS or FAIL, typically due to insufficient information.\n`NOT_APPLICABLE`: The check does not apply to this entity, usually due to insufficient data.\n",
              "enum": [
                "PASS",
                "FAIL",
                "INCONCLUSIVE",
                "NOT_APPLICABLE"
              ]
            },
            "rationale": {
              "type": "string",
              "description": "Detailed explanation of the check result"
            },
            "urls": {
              "type": "array",
              "description": "Relevant URLs supporting the check",
              "items": {
                "type": "string",
                "format": "uri"
              }
            },
            "related_inscribe_document_ids": {
              "type": "array",
              "description": "IDs of related documents",
              "items": {
                "type": "string"
              }
            }
          }
        }
      ]
    },
    "BusinessComplianceAnalystBeneficialOwnerCheck": {
      "type": "object",
      "properties": {
        "beneficial_owner_full_name": {
          "type": "string",
          "description": "Full name of the beneficial owner"
        },
        "checks": {
          "type": "array",
          "description": "Array of checks performed on the beneficial owner",
          "items": {
            "allOf": [
              {
                "type": "object",
                "properties": {
                  "type": {
                    "type": "string",
                    "description": "Type of check.\nFor more information about the beneficial owner checks, see [this page](https://docs.inscribe.ai/docs/business-compliance-analyst-checks#beneficial-owner-checks).\n",
                    "enum": [
                      "CONNECTION_TO_COMPANY",
                      "ADVERSE_MEDIA"
                    ]
                  },
                  "title": {
                    "type": "string",
                    "description": "Human-readable title of the check",
                    "enum": [
                      "Connection to Company",
                      "Adverse Media"
                    ]
                  },
                  "sub_checks": {
                    "type": "array",
                    "description": "Array of sub-checks that contribute to this check's result (currently empty for beneficial owner checks)",
                    "items": {
                      "$ref": "#/$defs/BusinessComplianceAnalystBaseCheck"
                    },
                    "default": []
                  }
                }
              },
              {
                "$ref": "#/$defs/BusinessComplianceAnalystBaseCheck"
              }
            ]
          }
        }
      }
    },
    "BusinessComplianceAnalystCanonicalProfile": {
      "type": "object",
      "properties": {
        "legal_name": {
          "type": "string",
          "description": "Legal name of the company"
        },
        "address": {
          "type": "string",
          "description": "Full address of the company"
        },
        "address_city": {
          "type": "string",
          "description": "City"
        },
        "address_state": {
          "type": "string",
          "description": "State/Province/Region"
        },
        "address_country": {
          "type": "string",
          "description": "Country"
        },
        "phone_number": {
          "type": "string",
          "description": "Contact phone number"
        },
        "company_structure": {
          "type": "string",
          "description": "Business structure type"
        },
        "business_type": {
          "type": "string",
          "description": "Type of business/industry based on NAICS (North American Industry Classification System)",
          "enum": [
            "Agriculture, Forestry, Fishing and Hunting",
            "Mining, Quarrying, and Oil and Gas Extraction",
            "Utilities",
            "Construction",
            "Manufacturing",
            "Wholesale Trade",
            "Retail Trade",
            "Transportation and Warehousing",
            "Information",
            "Finance and Insurance",
            "Real Estate and Rental and Leasing",
            "Professional, Scientific, and Technical Services",
            "Management of Companies and Enterprises",
            "Administrative and Support and Waste Management and Remediation Services",
            "Educational Services",
            "Health Care and Social Assistance",
            "Arts, Entertainment, and Recreation",
            "Accommodation and Food Services",
            "Public Administration",
            "Other Services"
          ]
        },
        "business_description": {
          "type": "string",
          "description": "Detailed description of business activities"
        },
        "ownership_structure": {
          "type": "string",
          "description": "Description of company ownership"
        },
        "beneficial_owners": {
          "type": "array",
          "description": "List of beneficial owners",
          "items": {
            "type": "object",
            "properties": {
              "full_name": {
                "type": "string",
                "description": "Full name of the beneficial owner"
              },
              "address": {
                "type": "string",
                "description": "Address of the beneficial owner"
              },
              "address_city": {
                "type": "string",
                "description": "City of the beneficial owner"
              },
              "address_state": {
                "type": "string",
                "description": "State/Province/Region of the beneficial owner"
              },
              "address_country": {
                "type": "string",
                "description": "Country of the beneficial owner"
              },
              "role": {
                "type": "string",
                "description": "Role of the beneficial owner in the company"
              }
            }
          }
        },
        "source_of_funds_claim": {
          "type": "string",
          "description": "Claimed source of company funds"
        },
        "opencorporates_data": {
          "type": [
            "object",
            "null"
          ],
          "description": "Data from OpenCorporates. If no match has been found or searching OpenCorporates is not enabled, this will be null.",
          "properties": {
            "name": {
              "type": "string",
              "description": "Name of the company as it appears on OpenCorporates"
            },
            "company_type": {
              "type": [
                "string",
                "null"
              ],
              "description": "Type of company as it appears on OpenCorporates"
            }
          }
        }
      }
    },
    "BusinessComplianceAnalystCompanyCheck": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "type": {
              "type": "string",
              "description": "Type of check.\nFor more information about the company checks, see [this page](https://docs.inscribe.ai/docs/business-compliance-analyst-checks#company-checks).\n",
              "enum": [
                "INCORPORATION_STATUS",
                "WEB_PRESENCE",
                "ADVERSE_MEDIA",
                "ADDRESS_VERIFICATION",
                "COUNTRY_RISK_SCREENING",
                "INDUSTRY_RISK_SCREENING",
                "TRANSACTION_ACTIVITY",
                "SOURCE_OF_FUNDS"
              ]
            },
            "title": {
              "type": "string",
              "description": "Human-readable title of the check",
              "enum": [
                "Incorporation Status",
                "Web Presence",
                "Adverse Media",
                "Address Verification",
                "Country Risk Screening",
                "Industry Risk Screening",
                "Transaction Activity",
                "Source of Funds"
              ]
            },
            "sub_checks": {
              "type": "array",
              "description": "Array of sub-checks that contribute to this check's result",
              "items": {
                "allOf": [
                  {
                    "$ref": "#/$defs/BusinessComplianceAnalystBaseCheck"
                  },
                  {
                    "type": "object",
                    "properties": {
                      "type": {
                        "type": "string",
                        "description": "Type identifier of the sub-check",
                        "enum": [
                          "WEBSITE_PRESENCE",
                          "SOCIAL_MEDIA_PRESENCE",
                          "SOURCE_OF_FUNDS_FROM_DOCUMENTS",
                          "SOURCE_OF_FUNDS_FROM_WEB_SEARCH",
                          "SOURCE_OF_FUNDS_DOCS_RISK",
                          "INCORPORATION_STATUS_FROM_WEB",
                          "INCORPORATION_DOCS_RISK",
                          "PO_BOX_ADDRESS",
                          "PRIVATE_MAILBOX_ADDRESS",
                          "ADDRESS_VERIFICATION_FROM_WEB",
                          "TRANSACTION_ACTIVITY_FROM_DOCUMENTS",
                          "TRANSACTION_ACTIVITY_DOCS_RISK"
                        ]
                      },
                      "title": {
                        "type": "string",
                        "description": "Human-readable title of the sub-check",
                        "enum": [
                          "Website Presence",
                          "Social Media Presence",
                          "Source of Funds from Documents",
                          "Source of Funds from Web Search",
                          "Fraud Risk from Documents",
                          "Incorporation Status from Web",
                          "Address PO Box Screening",
                          "Address Private Mailbox Screening",
                          "Address verified from Web Presence",
                          "Transaction Activity from Documents"
                        ]
                      }
                    }
                  }
                ]
              },
              "default": []
            }
          }
        },
        {
          "$ref": "#/$defs/BusinessComplianceAnalystBaseCheck"
        }
      ]
    },
    "BusinessComplianceAnalystOutput": {
      "type": "object",
      "properties": {
        "result": {
          "type": "string",
          "description": "The overall compliance status of the company after review.\n`PASS`: The company passed the compliance review - no issues were identified.\n`FAIL`: The company failed the compliance review - issues were identified.\n`INCONCLUSIVE`: The company's compliance status is inconclusive - unable to determine PASS or FAIL, typically due to insufficient information.\n`NOT_APPLICABLE`: The company's compliance status is not applicable, usually due to insufficient data.\n",
          "enum": [
            "PASS",
            "FAIL",
            "INCONCLUSIVE",
            "NOT_APPLICABLE"
          ]
        },
        "analysis": {
          "type": "string",
          "description": "A detailed analysis summarizing the compliance review findings"
        },
        "canonical_profile": {
          "$ref": "#/$defs/BusinessComplianceAnalystCanonicalProfile"
        },
        "company_checks": {
          "type": "array",
          "description": "Array of compliance checks performed on the company",
          "items": {
            "$ref": "#/$defs/BusinessComplianceAnalystCompanyCheck"
          }
        },
        "beneficial_owner_checks": {
          "type": "array",
          "description": "Array of checks performed on beneficial owners",
          "items": {
            "$ref": "#/$defs/BusinessComplianceAnalystBeneficialOwnerCheck"
          }
        }
      }
    },
    "CanonicalAddress": {
      "type": "object",
      "description": "A canonical address derived for a customer, along with the kind of source it was extracted from.",
      "properties": {
        "full_address": {
          "type": [
            "string",
            "null"
          ],
          "description": "The full address as a single string."
        },
        "city": {
          "type": [
            "string",
            "null"
          ],
          "description": "City of the address."
        },
        "state": {
          "type": [
            "string",
            "null"
          ],
          "description": "State of the address."
        },
        "country": {
          "type": [
            "string",
            "null"
          ],
          "description": "Country of the address."
        },
        "post_code": {
          "type": [
            "string",
            "null"
          ],
          "description": "Post code of the address."
        },
        "source": {
          "type": [
            "string",
            "null"
          ],
          "description": "The kind of source the address was derived from:\n  - `DOCUMENT` — extracted from a customer-uploaded document.\n  - `CUSTOMER` — provided directly by the customer (e.g. on the create-customer API call).\n  - `WEB_SEARCH` — sourced from an online lookup, such as a business registry or the company website.\n  - `PHONE_NUMBER` — inferred from a phone-number lookup, e.g. address fields derived from the registered phone number.\n",
          "enum": [
            "DOCUMENT",
            "CUSTOMER",
            "WEB_SEARCH",
            "PHONE_NUMBER"
          ]
        }
      }
    },
    "CanonicalItem": {
      "type": "object",
      "description": "A single canonical value extracted for a customer, along with the kind of source it was derived from.",
      "properties": {
        "value": {
          "type": [
            "string",
            "null"
          ],
          "description": "The canonical value derived for this attribute. `null` when no value could be determined."
        },
        "source": {
          "type": [
            "string",
            "null"
          ],
          "description": "The kind of source the value was derived from:\n  - `DOCUMENT` — extracted from a customer-uploaded document.\n  - `CUSTOMER` — provided directly by the customer (e.g. on the create-customer API call).\n  - `WEB_SEARCH` — sourced from an online lookup, such as a business registry or the company website.\n  - `PHONE_NUMBER` — inferred from a phone-number lookup.\n",
          "enum": [
            "DOCUMENT",
            "CUSTOMER",
            "WEB_SEARCH",
            "PHONE_NUMBER"
          ]
        }
      }
    },
    "CanonicalProfile": {
      "type": "object",
      "description": "Structured profile information aggregated from documents and verification sources for this customer. Each value carries the kind of source it was derived from.",
      "properties": {
        "individual": {
          "type": "object",
          "description": "Canonical profile fields relating to the individual.",
          "properties": {
            "name": {
              "allOf": [
                {
                  "$ref": "#/$defs/CanonicalItem"
                }
              ]
            },
            "address": {
              "allOf": [
                {
                  "$ref": "#/$defs/CanonicalAddress"
                }
              ]
            },
            "employer": {
              "type": "object",
              "description": "Employer details associated with the individual.",
              "properties": {
                "name": {
                  "allOf": [
                    {
                      "$ref": "#/$defs/CanonicalItem"
                    }
                  ]
                },
                "address": {
                  "allOf": [
                    {
                      "$ref": "#/$defs/CanonicalAddress"
                    }
                  ]
                }
              }
            }
          }
        },
        "company": {
          "type": "object",
          "description": "Canonical profile fields relating to the company.",
          "properties": {
            "legal_name": {
              "allOf": [
                {
                  "$ref": "#/$defs/CanonicalItem"
                }
              ]
            },
            "address": {
              "allOf": [
                {
                  "$ref": "#/$defs/CanonicalAddress"
                }
              ]
            },
            "phone_number": {
              "allOf": [
                {
                  "$ref": "#/$defs/CanonicalItem"
                }
              ]
            },
            "company_structure": {
              "allOf": [
                {
                  "$ref": "#/$defs/CanonicalItem"
                }
              ]
            },
            "associated_persons": {
              "type": "array",
              "description": "Individuals associated with the company (e.g. directors, owners).",
              "items": {
                "type": "object",
                "properties": {
                  "full_name": {
                    "allOf": [
                      {
                        "$ref": "#/$defs/CanonicalItem"
                      }
                    ]
                  },
                  "address": {
                    "allOf": [
                      {
                        "$ref": "#/$defs/CanonicalAddress"
                      }
                    ]
                  },
                  "role": {
                    "allOf": [
                      {
                        "$ref": "#/$defs/CanonicalItem"
                      }
                    ]
                  }
                }
              }
            },
            "source_of_funds_claim": {
              "allOf": [
                {
                  "$ref": "#/$defs/CanonicalItem"
                }
              ]
            },
            "business_type": {
              "allOf": [
                {
                  "$ref": "#/$defs/CanonicalItem"
                }
              ]
            },
            "business_description": {
              "allOf": [
                {
                  "$ref": "#/$defs/CanonicalItem"
                }
              ]
            },
            "ownership_structure": {
              "type": [
                "object",
                "null"
              ],
              "description": "A description of the company's ownership structure, with a rationale for the determination. `null` when no ownership structure could be derived.",
              "properties": {
                "description": {
                  "type": "string",
                  "description": "A summary of the ownership structure."
                },
                "rationale": {
                  "type": "string",
                  "description": "The reasoning behind the determined ownership structure."
                },
                "related_inscribe_document_ids": {
                  "type": "array",
                  "description": "IDs of Inscribe documents that informed this determination.",
                  "items": {
                    "type": "string"
                  }
                },
                "source": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "description": "The kind of source the ownership structure was derived from:\n  - `DOCUMENT` — extracted from a customer-uploaded document.\n  - `CUSTOMER` — provided directly by the customer (e.g. on the create-customer API call).\n  - `WEB_SEARCH` — sourced from an online lookup, such as a business registry or the company website.\n  - `PHONE_NUMBER` — inferred from a phone-number lookup.\n",
                  "enum": [
                    "DOCUMENT",
                    "CUSTOMER",
                    "WEB_SEARCH",
                    "PHONE_NUMBER"
                  ]
                }
              }
            },
            "website": {
              "allOf": [
                {
                  "$ref": "#/$defs/CanonicalItem"
                }
              ]
            },
            "registry_data": {
              "type": [
                "object",
                "null"
              ],
              "description": "Company registry data sourced from a business registry provider. `null` when no registry data is available.",
              "properties": {
                "url": {
                  "type": "string",
                  "description": "URL of the company's record in the registry."
                },
                "name": {
                  "type": "string",
                  "description": "The name of the company as recorded in the registry."
                },
                "jurisdiction_code": {
                  "type": "string",
                  "description": "The jurisdiction the company is registered in (ISO 3166-2)."
                },
                "company_type": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "description": "The company type as recorded in the registry."
                }
              }
            }
          }
        }
      }
    },
    "Company": {
      "type": "object",
      "description": "The company associated with the customer record",
      "properties": {
        "name": {
          "type": [
            "string",
            "null"
          ],
          "description": "Company name"
        },
        "address": {
          "allOf": [
            {
              "$ref": "#/$defs/Address"
            }
          ]
        },
        "id_number": {
          "type": [
            "string",
            "null"
          ],
          "description": "The ID number of the company, this could be the EIN or any other tax number"
        },
        "structure": {
          "type": [
            "string",
            "null"
          ],
          "description": "The structure of the company",
          "enum": [
            "SOLE_PROPRIETORSHIP",
            "PARTNERSHIP",
            "CORPORATION",
            "LIMITED_LIABILITY_COMPANY",
            "PRIVATE_LIMITED_COMPANY",
            "NON_PROFIT"
          ]
        },
        "phone_number": {
          "type": [
            "string",
            "null"
          ],
          "description": "Phone number of the company"
        },
        "website_url": {
          "type": [
            "string",
            "null"
          ],
          "description": "Website URL of the company"
        },
        "source_of_funds_claim": {
          "type": [
            "string",
            "null"
          ],
          "description": "A customer-provided declaration of where the company's funds originate (e.g. revenue, investment, loans). This raw input feeds the `SOURCE_OF_FUNDS` insight and is reconciled against documents and web evidence to produce the canonical `canonical_profile.company.source_of_funds_claim`. Defaults to `null` when not provided.\n"
        }
      }
    },
    "CustomerFraudRating": {
      "type": [
        "string",
        "null"
      ],
      "description": "The fraud rating of the customer. This field can be either 'HIGH_RISK', 'LOW_RISK', 'UNCERTAIN_RISK', or null. More information can be found at https://help.inscribe.ai/en/articles/8631969-fraud-rating",
      "enum": [
        "HIGH_RISK",
        "LOW_RISK",
        "UNCERTAIN_RISK",
        null
      ]
    },
    "CustomerInsight": {
      "type": "object",
      "description": "A customer-level insight derived from a customer fraud signal or a verification.",
      "properties": {
        "type": {
          "type": "string",
          "description": "The type of customer insight. (`SALARY_CROSS_CHECK` is deprecated: new insights of this type are no longer generated, but it may still be returned for customers where it was previously created.)",
          "enum": [
            "COMPANY_ADDRESS_EXISTENCE",
            "COMPANY_EXISTENCE",
            "COMPANY_WEB_PRESENCE",
            "CONNECTION_BETWEEN_COMPANY_AND_ADDRESS",
            "CONNECTION_BETWEEN_PERSON_AND_ADDRESS",
            "CONNECTION_BETWEEN_PERSON_AND_COMPANY",
            "MULTIPLE_DOCUMENT_RISK_SIGNALS",
            "MULTIPLE_HIGH_RISK_DOCUMENTS",
            "PERSON_ADDRESS_EXISTENCE",
            "PREVIOUS_HIGH_RISK_APPLICATIONS",
            "SALARY_CROSS_CHECK",
            "UNUSUAL_TRANSACTION_PATTERNS",
            "INCORPORATION_STATUS",
            "WEB_PRESENCE",
            "ADVERSE_MEDIA",
            "ADDRESS_VERIFICATION",
            "COUNTRY_RISK_SCREENING",
            "INDUSTRY_RISK_SCREENING",
            "TRANSACTION_ACTIVITY",
            "SOURCE_OF_FUNDS",
            "CONNECTION_TO_COMPANY",
            "ADVERSE_MEDIA_INDIVIDUAL",
            "CUSTOM_INSIGHT"
          ]
        },
        "result": {
          "type": "string",
          "description": "The result of the customer insight.",
          "enum": [
            "PASS",
            "INCONCLUSIVE",
            "FAIL"
          ]
        },
        "title": {
          "type": [
            "string",
            "null"
          ],
          "description": "A title describing the customer insight."
        },
        "rationale": {
          "type": [
            "string",
            "null"
          ],
          "description": "Detailed explanation of customer insight."
        },
        "urls": {
          "type": [
            "array",
            "null"
          ],
          "items": {
            "type": "string"
          },
          "description": "URLs with the sources that support the customer insight."
        },
        "scopes": {
          "type": "array",
          "items": {
            "type": "string",
            "enum": [
              "FRAUD"
            ]
          },
          "description": "Categories this insight belongs to. Currently, the only supported scope is \"FRAUD\", which indicates that the insight contributes to assessing risk_level. In the future, additional scopes may be introduced to represent other types of risk beyond fraud."
        },
        "target": {
          "type": "string",
          "description": "Indicates what entity this insight pertains to. `COMPANY` — the insight relates to a company-level check (e.g. web presence, adverse media, incorporation status, company existence). `INDIVIDUAL` — the insight relates to checks on an individual person (e.g. adverse media for an individual, connection to company, person address existence). `APPLICATION` — the insight relates to the application as a whole rather than a specific entity (e.g. document fraud signals, previous high-risk applications). This field is always present.\n",
          "enum": [
            "COMPANY",
            "INDIVIDUAL",
            "APPLICATION"
          ]
        },
        "sub_insights": {
          "type": [
            "array",
            "null"
          ],
          "description": "List of sub-insights that provide additional detail for this insight. This field is only included when sub-insights are present.",
          "items": {
            "type": "object",
            "properties": {
              "type": {
                "type": "string",
                "description": "The type of sub-insight."
              },
              "title": {
                "type": "string",
                "description": "A title describing the sub-insight."
              },
              "result": {
                "type": "string",
                "description": "The result of the sub-insight.",
                "enum": [
                  "PASS",
                  "INCONCLUSIVE",
                  "FAIL"
                ]
              },
              "rationale": {
                "type": "string",
                "description": "Detailed explanation of the sub-insight result."
              },
              "urls": {
                "type": [
                  "array",
                  "null"
                ],
                "items": {
                  "type": "string"
                },
                "description": "URLs with the sources that support the sub-insight. This field is excluded from the response if the array is empty."
              }
            }
          }
        },
        "owner_name": {
          "type": [
            "string",
            "null"
          ],
          "description": "The name of the owner associated with this insight, if applicable. This field is only included when an owner name is present."
        }
      }
    },
    "CustomerRiskAssessment": {
      "type": "object",
      "description": "Contains customer risk assessment data, including risk indicators and related insights.",
      "properties": {
        "id": {
          "type": [
            "string",
            "null"
          ],
          "format": "uuid",
          "description": "Unique identifier of the latest customer review agent run for this customer. `null` if no run exists yet."
        },
        "status": {
          "type": [
            "string",
            "null"
          ],
          "description": "The status of the latest customer review agent run. `null` if no run exists yet.",
          "enum": [
            "PENDING",
            "RUNNING",
            "FINISHED",
            "FAILED"
          ]
        },
        "started_at": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time",
          "description": "Time at which the latest customer review agent run started. `null` if no run exists yet."
        },
        "finished_at": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time",
          "description": "Time at which the latest customer review agent run finished. `null` if no run exists yet, or the run is still in progress."
        },
        "risk_level": {
          "type": [
            "string",
            "null"
          ],
          "description": "The risk level assigned to the customer. `null` if no risk level has been determined yet.",
          "enum": [
            "LOW",
            "MEDIUM",
            "HIGH",
            "NOT_APPLICABLE"
          ]
        },
        "summary": {
          "type": [
            "string",
            "null"
          ],
          "description": "A summary of the customer analysis. `null` if no analysis has completed yet."
        },
        "insights": {
          "type": "array",
          "description": "List of relevant customer-level insights. An insight can be derived from a customer fraud signal, or a verification. An insight can be configured to be turned on or off. Not all insights are enabled by default. You can contact Inscribe <a href=\"#\" onclick=\"Intercom('showNewMessage')\">via intercom</a> to enquire about enabling or disabling individual insights.\n",
          "items": {
            "$ref": "#/$defs/CustomerInsight"
          }
        }
      }
    },
    "Person": {
      "type": "object",
      "description": "Person associated with the customer record",
      "properties": {
        "first_name": {
          "type": [
            "string",
            "null"
          ],
          "description": "First name of the person"
        },
        "last_name": {
          "type": [
            "string",
            "null"
          ],
          "description": "Last name of the person"
        },
        "date_of_birth": {
          "type": [
            "string",
            "null"
          ],
          "format": "date",
          "description": "Date of birth of the person in YYYY-MM-DD format."
        },
        "address": {
          "allOf": [
            {
              "$ref": "#/$defs/Address"
            }
          ]
        },
        "email": {
          "type": [
            "string",
            "null"
          ],
          "format": "email",
          "description": "Email address of the person"
        },
        "phone_number": {
          "type": [
            "string",
            "null"
          ],
          "description": "Phone number of the person"
        },
        "id_number": {
          "type": [
            "string",
            "null"
          ],
          "description": "The ID number of the person, this could be the SSN, PPSN or any other tax number"
        }
      }
    },
    "Persons": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/Person"
      },
      "description": "List of persons associated with the customer record"
    },
    "Review": {
      "type": "object",
      "description": "Represents a manual review decision.",
      "properties": {
        "status": {
          "type": "string",
          "description": "The new status of the review decision.",
          "enum": [
            "ACCEPTED",
            "REJECTED",
            "REQUIRES_REVIEW"
          ]
        },
        "reason": {
          "type": [
            "string",
            "null"
          ],
          "description": "The reason for rejection. This field is only supported when `status` is `REJECTED`. `null` when no reason has been set.",
          "enum": [
            "FRAUD",
            "CREDIT_RISK",
            "OTHER"
          ]
        },
        "comment": {
          "type": [
            "string",
            "null"
          ],
          "maxLength": 2000,
          "description": "A free-text comment providing additional context for the review decision."
        }
      }
    },
    "VerifyEntityResponse": {
      "type": "object",
      "description": "Entities that have been requested to be verified.",
      "properties": {
        "income": {
          "type": "object",
          "description": "Income entities that have requested to be verified. This service is currently only available for Inscribe Credit customers. The `personal_income` and `revenue` fields will only be returned if they were included in the initial verification request when creating the customer.",
          "properties": {
            "personal_income": {
              "description": "This is the personal income verification request.",
              "type": "object",
              "properties": {
                "lower_income_tolerance": {
                  "description": "The tolerance with which found incomes below the `input` amount are verified. For example, if this value is set to 0.1, an income will verified if it is at least 90% (1-`lower_income_tolerance`) of the `input` amount.",
                  "type": "number"
                },
                "under_reported_tolerance": {
                  "description": "The tolerance with which found incomes above the `input` amount are set to `under_reported`. For example, if this value is set to 0.1, an income will set to `under_reported` if it is at least 110% (1+`under_reported_tolerance`) of the `input` amount.",
                  "type": "number"
                },
                "input": {
                  "description": "This is the expected income amount to be verified (in cents).",
                  "type": "number"
                },
                "frequency": {
                  "description": "This is frequency of the income to check. Currently, the only income that can be checked is `annual` income.",
                  "type": "string"
                },
                "verified": {
                  "description": "This is the status of the verification request. This will be set to `true` if the found income was greater than or equal to the `input` value (adjusted by any given `lower_income_tolerance`). It will be set to `false` if the `input` value did not meet that threshold. If no relevant documents have been provided, this value is set to `null`.",
                  "type": "boolean"
                },
                "matched": {
                  "description": "This is the found income amount (in cents).",
                  "type": "number"
                },
                "amount_type": {
                  "description": "This is the type of the found income.",
                  "type": "string",
                  "enum": [
                    "gross",
                    "net"
                  ]
                },
                "under_reported": {
                  "description": "This value is set to `true` if the found income exceeded the `input` amount. It is set to `false` if the found income did not. It is set to `null` if no relevant documents were provided or if the income was not verified.",
                  "type": "boolean"
                }
              }
            },
            "revenue": {
              "description": "This is the revenue verification request.",
              "type": "object",
              "properties": {
                "lower_income_tolerance": {
                  "description": "The tolerance with which found incomes below the `input` amount are verified. For example, if this value is set to 0.1, an income will verified if it is at least 90% (1-`lower_income_tolerance`) of the `input` amount.",
                  "type": "number"
                },
                "under_reported_tolerance": {
                  "description": "The tolerance with which found incomes above the `input` amount are set to `under_reported`. For example, if this value is set to 0.1, an income will set to `under_reported` if it is at least 110% (1+`under_reported_tolerance`) of the `input` amount.",
                  "type": "number"
                },
                "input": {
                  "description": "This is the expected revenue amount to be verified (in cents).",
                  "type": "number"
                },
                "frequency": {
                  "description": "This is frequency of the revenue to check. Currently, the only revenue that can be checked is `annual` income.",
                  "type": "string"
                },
                "verified": {
                  "description": "This is the status of the verification request. This will be set to `true` if the found revenue was greater than or equal to the `input` value (adjusted by any given `lower_income_tolerance`). It will be set to `false` if the `input` value did not meet that threshold. If no relevant documents have been provided, this value is set to `null`.",
                  "type": "boolean"
                },
                "matched": {
                  "description": "This is the found revenue amount (in cents).",
                  "type": "number"
                },
                "amount_type": {
                  "description": "This is the type of the found revenue.",
                  "type": "string",
                  "enum": [
                    "gross",
                    "net"
                  ]
                },
                "under_reported": {
                  "description": "This value is set to `true` if the found revenue exceeded the `input` amount. It is set to `false` if the found revenue did not. It is set to `null` if no relevant documents were provided or if the revenue was not verified.",
                  "type": "boolean"
                }
              }
            },
            "confidence_score": {
              "type": "number",
              "format": "float",
              "description": "The confidence score represents the degree of certainty for the income verification decision.  We calculate this score using a weighted combination of parsing and transaction categorization certainties.  Confidence scores above 0.5 represent high confidence."
            }
          }
        }
      }
    }
  }
}