{"openapi":"3.1.0","info":{"title":"Middesk API","version":"1.0.0"},"paths":{"/v1/businesses":{"get":{"operationId":"list-businesses","summary":"List businesses","tags":["subpackage_businesses"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"businesses list","content":{"application/json":{"schema":{"$ref":"#/components/schemas/type_businesses:ListBusinessesResponse"}}}}}},"post":{"operationId":"create-business","summary":"Create a business","tags":["subpackage_businesses"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"business created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/type_:Business"}}}},"422":{"description":"invalid request","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"tin":{"$ref":"#/components/schemas/type_businesses:BusinessRequestParamTin"},"addresses":{"type":"array","items":{"$ref":"#/components/schemas/type_businesses:BusinessRequestParamAddressesItem"}},"website":{"$ref":"#/components/schemas/type_businesses:BusinessRequestParamWebsite","description":"Website information for the business. Required when name and addresses are not provided when ordering the web_analysis and/or industry_classification subproducts."},"people":{"type":"array","items":{"$ref":"#/components/schemas/type_:SubmittedPerson"}},"external_id":{"type":"string"},"unique_external_id":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"connection_id":{"type":"string","description":"The ID of a connection to use as the source for this business. Pre-fills the business name and address from the connection."},"orders":{"type":"array","items":{"$ref":"#/components/schemas/type_businesses:BusinessRequestParamOrdersItem"},"description":"Orders to place against the business at creation time. Each order specifies a product (and optional subproducts/options) to run."}},"required":["name","addresses"]}}}}}},"/v1/businesses/{id}":{"get":{"operationId":"get-business","summary":"Retrieve a business","tags":["subpackage_businesses"],"parameters":[{"name":"id","in":"path","description":"Business ID","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"business found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/type_:Business"}}}},"404":{"description":"business not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/type_:ErrorResponse"}}}}}},"patch":{"operationId":"update-business","summary":"Update a business","tags":["subpackage_businesses"],"parameters":[{"name":"id","in":"path","description":"Business ID","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"business updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/type_:Business"}}}},"404":{"description":"business not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/type_:ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"status":{"$ref":"#/components/schemas/type_businesses:BusinessUpdateParamStatus","description":"Status to set for the business (only final statuses allowed)"},"tin":{"$ref":"#/components/schemas/type_businesses:BusinessUpdateParamTin"},"addresses":{"type":"array","items":{"$ref":"#/components/schemas/type_businesses:BusinessUpdateParamAddressesItem"}},"people":{"type":"array","items":{"$ref":"#/components/schemas/type_:SubmittedPerson"}},"external_id":{"type":"string"},"unique_external_id":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}}}}}}}}},"/v1/businesses/{id}/pdf":{"get":{"operationId":"get-business-pdf","summary":"Retrieve a business PDF","tags":["subpackage_businesses"],"parameters":[{"name":"id","in":"path","description":"Business ID","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response"},"404":{"description":"business not found","content":{"application/json":{"schema":{"description":"Any type"}}}}}}},"/v1/businesses/{business_id}/orders":{"get":{"operationId":"list-orders","summary":"List orders for a business","tags":["subpackage_orders"],"parameters":[{"name":"business_id","in":"path","description":"Business ID","required":true,"schema":{"type":"string"}},{"name":"packages","in":"query","description":"Comma-separated list of packages to filter by","required":false,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Page number for pagination","required":false,"schema":{"type":"integer"}},{"name":"per_page","in":"query","description":"Number of items per page","required":false,"schema":{"type":"integer"}},{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"orders found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/type_orders:ListOrdersResponse"}}}}}},"post":{"operationId":"create-order","summary":"Create an order for a business","tags":["subpackage_orders"],"parameters":[{"name":"business_id","in":"path","description":"Business ID","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"order created","content":{"application/json":{"schema":{"description":"Any type"}}}},"400":{"description":"bad request - missing package","content":{"application/json":{"schema":{"$ref":"#/components/schemas/type_:ErrorResponse"}}}},"422":{"description":"unprocessable entity - reorder validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/type_:ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"product":{"$ref":"#/components/schemas/type_orders:OrderRequestParamProduct","description":"Product type for the order"},"subproducts":{"type":"array","items":{"$ref":"#/components/schemas/type_orders:OrderRequestParamSubproductsItem"},"description":"Array of subproducts"},"options":{"$ref":"#/components/schemas/type_orders:OrderRequestParamOptions","description":"Additional options for the order"}}}}}}}},"/v1/businesses/{business_id}/orders/{id}":{"get":{"operationId":"get-order","summary":"Retrieve an order","tags":["subpackage_orders"],"parameters":[{"name":"business_id","in":"path","description":"Business ID","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Order ID","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"order found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/type_:Order"}}}}}}},"/v1/orders/{id}":{"get":{"operationId":"get-order-by-id","summary":"Retrieve an order by ID","tags":["subpackage_orders"],"parameters":[{"name":"id","in":"path","description":"Order ID","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"order found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/type_:Order"}}}}}},"put":{"operationId":"update-order","summary":"Update an order","tags":["subpackage_orders"],"parameters":[{"name":"id","in":"path","description":"Order ID","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"order updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/type_:Order"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"assignee_id":{"type":"string","description":"ID of the user to assign the order to"},"status":{"type":"string","description":"New status for the order"}}}}}}}},"/v1/business_batches":{"get":{"operationId":"list-business-batches","summary":"List business batches","tags":["subpackage_businessBatches"],"parameters":[{"name":"page","in":"query","description":"Page number","required":false,"schema":{"type":"integer"}},{"name":"per_page","in":"query","description":"Items per page","required":false,"schema":{"type":"integer"}},{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"business batches list","content":{"application/json":{"schema":{"$ref":"#/components/schemas/type_businessBatches:ListBusinessBatchesResponse"}}}}}},"post":{"operationId":"create-business-batch","summary":"Create a business batch","tags":["subpackage_businessBatches"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"business batch created","content":{"application/json":{"schema":{"description":"Any type"}}}},"400":{"description":"invalid request","content":{"application/json":{"schema":{"description":"Any type"}}}},"422":{"description":"validation errors","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Name for the business batch"},"filename":{"type":"string","description":"CSV filename"},"csv":{"type":"string","description":"Base64 encoded CSV data"}},"required":["name","filename","csv"]}}}}}},"/v1/business_batches/{id}":{"get":{"operationId":"get-business-batch","summary":"Retrieve a business batch","tags":["subpackage_businessBatches"],"parameters":[{"name":"id","in":"path","description":"Business Batch ID","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"business batch found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/type_:BusinessBatch"}}}},"404":{"description":"business batch not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/type_:ErrorResponse"}}}}}}},"/v1/business_batches/{id}/csv":{"get":{"operationId":"get-business-batch-csv","summary":"Download business batch CSV","tags":["subpackage_businessBatches"],"parameters":[{"name":"id","in":"path","description":"Business Batch ID","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"csv download","content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"404":{"description":"business batch not found","content":{"application/json":{"schema":{"description":"Any type"}}}}}}},"/v1/signals":{"get":{"operationId":"list-signals","summary":"List signals","tags":["subpackage_signals"],"parameters":[{"name":"page","in":"query","description":"Page number","required":false,"schema":{"type":"integer"}},{"name":"per_page","in":"query","description":"Items per page","required":false,"schema":{"type":"integer"}},{"name":"q","in":"query","description":"Search query","required":false,"schema":{"type":"string"}},{"name":"external_id","in":"query","description":"Filter by external ID","required":false,"schema":{"type":"string"}},{"name":"start_date","in":"query","description":"Start date filter (YYYY-MM-DD)","required":false,"schema":{"type":"string"}},{"name":"end_date","in":"query","description":"End date filter (YYYY-MM-DD)","required":false,"schema":{"type":"string"}},{"name":"starting_at","in":"query","description":"Start timestamp filter","required":false,"schema":{"type":"string"}},{"name":"ending_at","in":"query","description":"End timestamp filter","required":false,"schema":{"type":"string"}},{"name":"batch_id","in":"query","description":"Filter by batch ID","required":false,"schema":{"type":"string"}},{"name":"model_slug","in":"query","description":"Filter by model slug","required":false,"schema":{"type":"string"}},{"name":"reason_codes","in":"query","description":"Filter by reason codes","required":false,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"signals list","content":{"application/json":{"schema":{"$ref":"#/components/schemas/type_signals:ListSignalsResponse"}}}}}},"post":{"operationId":"create-signal","summary":"Create a signal","tags":["subpackage_signals"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"signal created","content":{"application/json":{"schema":{"description":"Any type"}}}},"422":{"description":"invalid request","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Company name"},"tin":{"type":"string","description":"Tax identification number"},"external_id":{"type":"string","description":"External identifier"},"model_slug":{"type":"string","description":"Scoring model slug"},"addresses":{"type":"array","items":{"type":"string"},"description":"Array of addresses"},"people":{"type":"array","items":{"type":"string"},"description":"Array of people names"}},"required":["name","addresses"]}}}}}},"/v1/signals/{id}":{"get":{"operationId":"get-signal","summary":"Retrieve a signal","tags":["subpackage_signals"],"parameters":[{"name":"id","in":"path","description":"Signal ID","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"signal found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/type_:Signal"}}}},"404":{"description":"signal not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/type_:ErrorResponse"}}}}}}},"/v1/businesses/{business_id}/monitor":{"get":{"operationId":"get-business-monitor","summary":"Retrieve a monitor for a business","tags":["subpackage_monitoring"],"parameters":[{"name":"business_id","in":"path","description":"Business ID","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"monitor found","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"monitor not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/type_:ErrorResponse"}}}}}},"post":{"operationId":"create-business-monitor","summary":"Create a monitor for a business","tags":["subpackage_monitoring"],"parameters":[{"name":"business_id","in":"path","description":"Business ID","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"monitor created","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/type_:MonitoringEventTypesParam"}}}}},"put":{"operationId":"update-business-monitor","summary":"Update a monitor for a business","tags":["subpackage_monitoring"],"parameters":[{"name":"business_id","in":"path","description":"Business ID","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"monitor updated","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"monitor not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/type_:ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/type_:MonitoringEventTypesParam"}}}}},"delete":{"operationId":"delete-business-monitor","summary":"Delete a monitor for a business","tags":["subpackage_monitoring"],"parameters":[{"name":"business_id","in":"path","description":"Business ID","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response"},"404":{"description":"monitor not found","content":{"application/json":{"schema":{"description":"Any type"}}}}}}},"/v1/monitoring/bulk_disable":{"post":{"operationId":"bulk-disable-monitors","summary":"Bulk disable monitors","description":"Disables monitors for all businesses in the account. This operation is processed asynchronously. When monitor_types is omitted, all monitor types allowed for the account are disabled.","tags":["subpackage_monitoring"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response"}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"monitor_types":{"type":"array","items":{"$ref":"#/components/schemas/type_monitoring:BulkDisableMonitorsParamMonitorTypesItem"},"description":"Array of monitor types to disable. Defaults to all types allowed for the account."},"notification_email":{"type":"string","description":"Email address to notify when bulk disable operation completes"}}}}}}}},"/v1/businesses/{business_id}/liens":{"get":{"operationId":"list-liens","summary":"List liens for a business","tags":["subpackage_liens"],"parameters":[{"name":"business_id","in":"path","description":"Business ID","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"liens found","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"business not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/type_:ErrorResponse"}}}}}},"post":{"operationId":"create-lien","summary":"Create a lien for a business","tags":["subpackage_liens"],"parameters":[{"name":"business_id","in":"path","description":"Business ID","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"lien created using account defaults","content":{"application/json":{"schema":{"description":"Any type"}}}},"400":{"description":"invalid secured parties configuration","content":{"application/json":{"schema":{"$ref":"#/components/schemas/type_:ErrorResponse"}}}},"403":{"description":"identity or verify order required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/type_:ErrorResponse"}}}},"404":{"description":"business not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/type_:ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"state":{"$ref":"#/components/schemas/type_liens:LienRequestParamState","description":"State where the lien will be filed. Use `state` for a single state or `states` for multiple states. If both are provided, `states` takes precedence."},"states":{"type":"array","items":{"$ref":"#/components/schemas/type_liens:LienRequestParamStatesItem"},"description":"Array of states to file the lien in. Creates one lien per state. Returns a list response. Either `state` or `states` is required."},"debtors":{"type":"array","items":{"$ref":"#/components/schemas/type_liens:LienRequestParamDebtorsItem"},"description":"Array of debtor details"},"secured_parties":{"type":"array","items":{"$ref":"#/components/schemas/type_liens:LienRequestParamSecuredPartiesItem"},"description":"Array of secured party details (optional - uses account defaults if not provided)"},"secured_party":{"$ref":"#/components/schemas/type_liens:LienRequestParamSecuredParty","description":"Single secured party (alternative to secured_parties array)"},"collateral":{"type":"string","description":"Collateral description (optional - uses account default if not provided)"},"loan_principal_amount_cents":{"type":"integer","description":"Loan principal amount in cents"},"packet_number":{"type":"string","description":"Packet number for the filing (optional - auto-generated if not provided)"},"alternative_designation":{"type":"string","description":"Alternative designation (for Tennessee filings)"}},"required":["debtors"]}}}}}},"/v1/businesses/{business_id}/liens/batch":{"post":{"operationId":"create-lien-filings-in-batch","summary":"Create lien filings in batch","description":"Creates multiple lien filings in a single request. Each entry is processed independently. Successful entries return lien objects, failed entries return per-item errors.","tags":["subpackage_liens"],"parameters":[{"name":"business_id","in":"path","description":"Business ID","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"batch processed","content":{"application/json":{"schema":{"description":"Any type"}}}},"422":{"description":"batch validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/type_:CreateLienFilingsInBatchRequestUnprocessableEntityErrorBody"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"liens":{"type":"array","items":{"$ref":"#/components/schemas/type_liens:LienBatchRequestParamLiensItem"},"description":"Array of lien filing entries. Each entry creates one lien. Each entry must have a unique state. Maximum 50 entries per request."}},"required":["liens"]}}}}}},"/v1/liens/{lien_id}/termination":{"post":{"operationId":"create-lien-termination","summary":"Create a termination for a lien","description":"Creates a lien termination or returns existing one if already terminated","tags":["subpackage_lienTerminations"],"parameters":[{"name":"lien_id","in":"path","description":"Lien ID","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"lien termination created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/type_lienTerminations:CreateLienTerminationResponse"}}}},"404":{"description":"lien not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/type_:ErrorResponse"}}}},"422":{"description":"lien in created status cannot be terminated","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"packet_number":{"type":"string","description":"Packet number for the termination filing (optional - auto-generated if not provided)"}}}}}}}},"/v1/businesses/{business_id}/policy_results":{"get":{"operationId":"list-business-policy-results","summary":"List policy results for a business","description":"Returns policy results for enabled policy versions only","tags":["subpackage_policyResults"],"parameters":[{"name":"business_id","in":"path","description":"Business ID","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"multiple policy results with different versions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/type_:PolicyResultsList"}}}},"404":{"description":"business not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/type_:ErrorResponse"}}}}}}},"/v1/businesses/{business_id}/review":{"get":{"operationId":"get-business-review","summary":"Retrieve a review for a business","description":"Returns the review associated with a business","tags":["subpackage_reviews"],"parameters":[{"name":"business_id","in":"path","description":"Business ID","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"review found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/type_:Review"}}}},"404":{"description":"business not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/type_:ErrorResponse"}}}}}}},"/v1/actions":{"get":{"operationId":"list-actions","summary":"List actions for an object","tags":["subpackage_actions"],"parameters":[{"name":"object_type","in":"query","description":"Type of object to list actions for","required":true,"schema":{"$ref":"#/components/schemas/type_actions:ListActionsRequestObjectType"}},{"name":"object_id","in":"query","description":"ID of the object to list actions for","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"actions with effects and actors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/type_actions:ListActionsResponse"}}}},"400":{"description":"invalid object_type","content":{"application/json":{"schema":{"$ref":"#/components/schemas/type_:ErrorResponse"}}}}}},"post":{"operationId":"create-action","summary":"Create an action on an object","tags":["subpackage_actions"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"action created - verify TIN","content":{"application/json":{"schema":{"$ref":"#/components/schemas/type_:Action"}}}},"400":{"description":"invalid action type","content":{"application/json":{"schema":{"$ref":"#/components/schemas/type_:ErrorResponse"}}}},"404":{"description":"object not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/type_:ErrorResponse"}}}},"422":{"description":"invalid payload","content":{"application/json":{"schema":{"$ref":"#/components/schemas/type_:ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"object_type":{"$ref":"#/components/schemas/type_actions:ActionRequestParamObjectType","description":"Type of object to perform the action on"},"object_id":{"type":"string","format":"uuid","description":"ID of the object to perform the action on"},"type":{"$ref":"#/components/schemas/type_actions:ActionRequestParamType","description":"The type of action to perform"},"note":{"type":"string","description":"Optional text note describing the reason for the action"},"thread_id":{"type":"string","format":"uuid","description":"Optional operator thread ID used to resolve an action actor"},"run_id":{"type":"string","format":"uuid","description":"Optional operator run ID used to resolve an action actor"},"payload":{"type":"object","additionalProperties":{"description":"Any type"},"description":"Action-specific parameters (varies by action type)"}},"required":["object_type","object_id","type","payload"]}}}}}},"/v1/actions/{id}":{"get":{"operationId":"get-action","summary":"Retrieve an action","tags":["subpackage_actions"],"parameters":[{"name":"id","in":"path","description":"Action ID","required":true,"schema":{"type":"string"}},{"name":"object_type","in":"query","description":"Type of object the action belongs to","required":true,"schema":{"$ref":"#/components/schemas/type_actions:GetActionRequestObjectType"}},{"name":"object_id","in":"query","description":"ID of the object the action belongs to","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"action found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/type_:Action"}}}},"404":{"description":"action not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/type_:ErrorResponse"}}}}}}},"/v1/tin_match/availability":{"get":{"operationId":"get-tin-match-availability","summary":"Check TIN match service availability","description":"Returns the availability status of the IRS TIN matching service","tags":["subpackage_tinMatch"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"TIN match service is unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/type_:TinMatchAvailability"}}}}}}},"/v1/businesses/{business_id}/website":{"get":{"operationId":"get-business-website","summary":"Retrieve website analysis for a business","description":"Returns website analysis data including domain info, pages, and quality indicators","tags":["subpackage_websites"],"parameters":[{"name":"business_id","in":"path","description":"Business ID","required":true,"schema":{"type":"string"}},{"name":"include","in":"query","description":"Include additional data. Use \"indicator_details\" to include source examples and explanations for each indicator","required":false,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"website analysis found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/type_:Website"}}}},"404":{"description":"website not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/type_:ErrorResponse"}}}}}}},"/v1/businesses/{business_id}/connections":{"get":{"operationId":"list-connections","summary":"List connections","description":"Returns businesses connected to the specified business, ordered by confidence score. Each connection includes connecting people, addresses, and businesses that link them. Results are paginated.","tags":["subpackage_connections"],"parameters":[{"name":"business_id","in":"path","description":"Business ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Page number","required":false,"schema":{"type":"integer"}},{"name":"per_page","in":"query","description":"Items per page","required":false,"schema":{"type":"integer"}},{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"connections found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/type_connections:GetV1BusinessesBusinessIdConnectionsResponse"}}}},"403":{"description":"feature not enabled for account","content":{"application/json":{"schema":{"$ref":"#/components/schemas/type_:ErrorResponse"}}}}}}},"/v1/businesses/{business_id}/timeline":{"get":{"operationId":"get-business-timeline","summary":"Retrieve timeline for a business","description":"Returns a paginated list of timeline events for a business. Timeline events include Secretary of State (SOS) history events and SOS monitoring events, providing a chronological record of changes to the business's registration data.","tags":["subpackage_timeline"],"parameters":[{"name":"business_id","in":"path","description":"Business ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Page number (default: 1)","required":false,"schema":{"type":"integer"}},{"name":"per_page","in":"query","description":"Number of events per page (default: 100, max: 100)","required":false,"schema":{"type":"integer"}},{"name":"start_date","in":"query","description":"Filter events on or after this date (YYYY-MM-DD format)","required":false,"schema":{"type":"string"}},{"name":"end_date","in":"query","description":"Filter events on or before this date (YYYY-MM-DD format)","required":false,"schema":{"type":"string"}},{"name":"event_types","in":"query","description":"Comma-separated list of event types to filter by","required":false,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"timeline events list","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"business not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/type_:ErrorResponse"}}}}}}},"/v1/partner/registration_requests":{"get":{"operationId":"list-registration-requests","summary":"List registration requests","tags":["subpackage_registrationRequests"],"parameters":[{"name":"page","in":"query","description":"Page number","required":false,"schema":{"type":"integer"}},{"name":"per_page","in":"query","description":"Items per page","required":false,"schema":{"type":"integer"}},{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"registration requests list","content":{"application/json":{"schema":{"$ref":"#/components/schemas/type_registrationRequests:ListRegistrationRequestsResponse"}}}}}},"post":{"operationId":"create-registration-request","summary":"Create a registration request","tags":["subpackage_registrationRequests"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"registration request created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/type_:RegistrationRequest"}}}},"400":{"description":"validation errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/type_:ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"state":{"$ref":"#/components/schemas/type_registrationRequests:RegistrationRequestParamState","description":"US state abbreviation (required)"},"email":{"type":"string","format":"email","description":"User email (required)"},"company_id":{"type":"string","format":"uuid","description":"Existing company ID"},"company_name":{"type":"string","description":"Company name for new company"},"external_id":{"type":"string","description":"External company identifier"},"tax_registration_types":{"type":"array","items":{"type":"string"},"description":"Types of tax registrations (e.g., sales_tax, payroll_tax)"},"jurisdictions":{"type":"array","items":{"type":"string"},"description":"Tax jurisdictions"},"redirect_uri":{"type":"string","format":"uri","description":"Success redirect URL"},"redirect_back_uri":{"type":"string","format":"uri","description":"Back redirect URL"}},"required":["state","email"]}}}}}},"/v1/partner/registration_requests/{id}":{"get":{"operationId":"get-registration-request","summary":"Retrieve a registration request","tags":["subpackage_registrationRequests"],"parameters":[{"name":"id","in":"path","description":"Registration Request ID","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"registration request found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/type_:RegistrationRequest"}}}},"404":{"description":"registration request not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/type_:ErrorResponse"}}}}}},"delete":{"operationId":"delete-registration-request","summary":"Delete a registration request","tags":["subpackage_registrationRequests"],"parameters":[{"name":"id","in":"path","description":"Registration Request ID","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response"},"400":{"description":"registration request already submitted","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"registration request not found","content":{"application/json":{"schema":{"description":"Any type"}}}}}}},"/v1/partner/registration_requests/{id}/guest_dashboard":{"get":{"operationId":"get-registration-request-guest-dashboard","summary":"Fetch guest dashboard link for a registration request","tags":["subpackage_registrationRequests"],"parameters":[{"name":"id","in":"path","description":"Registration Request ID","required":true,"schema":{"type":"string"}},{"name":"section","in":"query","description":"Dashboard section to link to","required":false,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"guest dashboard link","content":{"application/json":{"schema":{"$ref":"#/components/schemas/type_registrationRequests:GetRegistrationRequestGuestDashboardResponse"}}}},"404":{"description":"registration request not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/type_:ErrorResponse"}}}}}}},"/v1/partner/exceptions":{"get":{"operationId":"list-information-requests","summary":"List Information Requests","tags":["subpackage_informationRequests"],"parameters":[{"name":"page","in":"query","description":"Page number","required":false,"schema":{"type":"integer"}},{"name":"per_page","in":"query","description":"Items per page","required":false,"schema":{"type":"integer"}},{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"information requests list","content":{"application/json":{"schema":{"$ref":"#/components/schemas/type_informationRequests:ListInformationRequestsResponse"}}}}}}},"/v1/partner/applications":{"post":{"operationId":"create-application","summary":"Create an application","tags":["subpackage_applications"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"application created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/type_applications:CreateApplicationResponse"}}}},"422":{"description":"validation errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/type_:ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"company_id":{"type":"string","format":"uuid","description":"Company ID"},"company_external_id":{"type":"string","description":"Company external ID"},"redirect_uri":{"type":"string","format":"uri","description":"Redirect URI"},"redirect_back_uri":{"type":"string","format":"uri","description":"Redirect back URI"}}}}}}}},"/v1/partner/companies":{"post":{"operationId":"create-company","summary":"Create a company","tags":["subpackage_companies"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"company created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/type_:AgentCompany"}}}},"409":{"description":"company already exists","content":{"application/json":{"schema":{"$ref":"#/components/schemas/type_:AgentCompany"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"legal_name":{"type":"string","description":"Legal name of the company"},"ein":{"type":"string","description":"Employer Identification Number"},"external_id":{"type":"string","description":"External identifier"},"dba_name":{"type":"string","description":"Doing business as name"},"contact_email":{"type":"string","format":"email"},"contact_name":{"type":"string"},"contact_phone_number":{"type":"string"},"entity_type":{"type":"string"},"formation_state":{"type":"string"},"formation_date":{"type":"string","format":"date"},"addresses":{"type":"array","items":{"$ref":"#/components/schemas/type_companies:CreateCompanyRequestAddressesItem"}}},"required":["legal_name"]}}}}}},"/v1/agent/jurisdictions/search":{"get":{"operationId":"search-jurisdictions","summary":"Search jurisdictions","description":"Search for jurisdictions by name, PSD code, or other criteria. Supports filtering by state, tax type, and jurisdiction type. Results are paginated.","tags":["subpackage_jurisdictions"],"parameters":[{"name":"state","in":"query","description":"Two-letter US state abbreviation (e.g., OH, PA)","required":false,"schema":{"type":"string"}},{"name":"q","in":"query","description":"Search query (name, PSD code, or municipality)","required":false,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Page number for pagination","required":false,"schema":{"type":"integer"}},{"name":"per_page","in":"query","description":"Number of results per page","required":false,"schema":{"type":"integer"}},{"name":"tax_type","in":"query","description":"Filter by tax type (e.g., CITY, EIT, LST)","required":false,"schema":{"type":"string"}},{"name":"local_only","in":"query","description":"When true, returns only local jurisdictions","required":false,"schema":{"type":"string"}},{"name":"supported_only","in":"query","description":"When true, returns only supported jurisdictions","required":false,"schema":{"type":"string"}},{"name":"slug","in":"query","description":"Filter by jurisdiction slug","required":false,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"jurisdictions search results","content":{"application/json":{"schema":{"$ref":"#/components/schemas/type_jurisdictions:SearchJurisdictionsResponse"}}}}}}},"/v1/agent/jurisdictions":{"get":{"operationId":"list-jurisdictions","summary":"Fetch supported local jurisdictions","tags":["subpackage_jurisdictions"],"parameters":[{"name":"state","in":"query","description":"US state abbreviation (e.g., CO, CA, NY)","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"jurisdictions list","content":{"application/json":{"schema":{"$ref":"#/components/schemas/type_jurisdictions:ListJurisdictionsResponse"}}}}}}},"/v1/agent/questions":{"get":{"operationId":"list-questions","summary":"List questions","description":"Retrieve the set of dynamic questions required for a registration in a given state or local jurisdiction. The questions returned depend on the jurisdiction and registration type.","tags":["subpackage_questions"],"parameters":[{"name":"state","in":"query","description":"Two-letter US state abbreviation (e.g., CA, NY). Required when jurisdiction_slugs is not provided and states is not used.","required":false,"schema":{"type":"string"}},{"name":"states[]","in":"query","description":"Array of two-letter US state abbreviations. Used when fetching questions for multiple states.","required":false,"schema":{"type":"string"}},{"name":"jurisdiction_slugs[]","in":"query","description":"Array of local jurisdiction slug identifiers. Used to fetch questions specific to local jurisdictions. Must be provided together with the state parameter.","required":false,"schema":{"type":"string"}},{"name":"categories[]","in":"query","description":"Filter questions by registration type. Only applicable to state-level questions; omit for local jurisdiction questions.","required":false,"schema":{"$ref":"#/components/schemas/type_questions:ListQuestionsRequestCategoriesItem"}},{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"questions list","content":{"application/json":{"schema":{"$ref":"#/components/schemas/type_questions:ListQuestionsResponse"}}}},"400":{"description":"bad request — state or states param missing","content":{"application/json":{"schema":{"description":"Any type"}}}},"422":{"description":"unprocessable entity — invalid state abbreviation","content":{"application/json":{"schema":{"description":"Any type"}}}}}}},"/v1/partner/mail":{"get":{"operationId":"list-mail-items","summary":"List mail items","tags":["subpackage_mail"],"parameters":[{"name":"page","in":"query","description":"Page number","required":false,"schema":{"type":"integer"}},{"name":"per_page","in":"query","description":"Items per page","required":false,"schema":{"type":"integer"}},{"name":"state","in":"query","description":"Filter by state","required":false,"schema":{"type":"string"}},{"name":"q","in":"query","description":"Search query","required":false,"schema":{"type":"string"}},{"name":"sort_by","in":"query","description":"Sort field","required":false,"schema":{"type":"string"}},{"name":"sort_order","in":"query","description":"Sort order","required":false,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"mail items list","content":{"application/json":{"schema":{"$ref":"#/components/schemas/type_mail:ListMailItemsResponse"}}}}}}},"/v1/partner/mail/{id}":{"get":{"operationId":"get-mail-item","summary":"Retrieve a mail item","tags":["subpackage_mail"],"parameters":[{"name":"id","in":"path","description":"Mail item ID","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response"},"404":{"description":"mail item not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/type_:ErrorResponse"}}}}}},"patch":{"operationId":"update-mail-item","summary":"Update a mail item","tags":["subpackage_mail"],"parameters":[{"name":"id","in":"path","description":"Mail item ID","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response"},"404":{"description":"mail item not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/type_:ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}}}},"/v1/agents":{"get":{"operationId":"list-agents","summary":"List agents","description":"Returns a list of available agents for running workflows","tags":["subpackage_agents"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"agents list","content":{"application/json":{"schema":{"$ref":"#/components/schemas/type_agents:ListAgentsResponse"}}}}}}},"/v1/agents/{id}":{"get":{"operationId":"get-agent","summary":"Retrieve an agent","description":"Retrieves details of a specific agent","tags":["subpackage_agents"],"parameters":[{"name":"id","in":"path","description":"Agent ID","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"agent found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/type_:AgentsAgent"}}}},"404":{"description":"agent not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/type_:ErrorResponse"}}}}}}},"/v1/threads":{"get":{"operationId":"list-agent-threads","summary":"List agent threads","description":"Returns a paginated list of agent threads","tags":["subpackage_threads"],"parameters":[{"name":"page","in":"query","description":"Page number","required":false,"schema":{"type":"integer"}},{"name":"per_page","in":"query","description":"Items per page","required":false,"schema":{"type":"integer"}},{"name":"business_id","in":"query","description":"Optional business ID filter","required":false,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"agent threads list","content":{"application/json":{"schema":{"$ref":"#/components/schemas/type_threads:ListAgentThreadsResponse"}}}}}},"post":{"operationId":"create-agent-thread","summary":"Create an agent thread","description":"Creates a new agent thread for running agent workflows","tags":["subpackage_threads"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"agent thread created with context_type and context_id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/type_:AgentsThread"}}}},"404":{"description":"agent type not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/type_:ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"The agent type to use for this agent thread"},"business_id":{"type":"string","format":"uuid","description":"Business to use as context for the thread. Shorthand for context_type=business. Required unless context_type and context_id are provided."},"context_type":{"type":"string","description":"The type of context resource (e.g., \"business\")"},"context_id":{"type":"string","format":"uuid","description":"The ID of the context resource. Must be provided with context_type."}},"required":["type"]}}}}}},"/v1/threads/{id}":{"get":{"operationId":"get-agent-thread","summary":"Retrieve an agent thread","description":"Retrieves details of a specific agent thread","tags":["subpackage_threads"],"parameters":[{"name":"id","in":"path","description":"Agent thread ID","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"agent thread found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/type_:AgentsThread"}}}},"404":{"description":"agent thread not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/type_:ErrorResponse"}}}}}}},"/v1/runs":{"get":{"operationId":"list-agent-runs","summary":"List agent runs","description":"Returns a paginated list of agent runs","tags":["subpackage_runs"],"parameters":[{"name":"page","in":"query","description":"Page number","required":false,"schema":{"type":"integer"}},{"name":"per_page","in":"query","description":"Items per page","required":false,"schema":{"type":"integer"}},{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"agent runs list with pagination","content":{"application/json":{"schema":{"$ref":"#/components/schemas/type_runs:ListAgentRunsResponse"}}}}}},"post":{"operationId":"create-agent-run","summary":"Create an agent run","description":"Creates a new agent run","tags":["subpackage_runs"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"agent run created within existing agent thread","content":{"application/json":{"schema":{"$ref":"#/components/schemas/type_:AgentsRun"}}}},"400":{"description":"missing context when thread_id is not provided","content":{"application/json":{"schema":{"$ref":"#/components/schemas/type_:ErrorResponse"}}}},"404":{"description":"agent thread not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/type_:ErrorResponse"}}}},"422":{"description":"inline business payload refers to business in audit","content":{"application/json":{"schema":{"$ref":"#/components/schemas/type_:ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"The agent type to use for this agent run"},"business_id":{"type":"string","format":"uuid","description":"Business to use as context for the run. Shorthand for context_type=business. Required when thread_id is not provided (unless context_type and context_id are given)."},"context_type":{"type":"string","description":"The type of context resource (e.g., \"business\")"},"context_id":{"type":"string","format":"uuid","description":"The ID of the context resource. Must be provided with context_type."},"thread_id":{"type":"string","format":"uuid","description":"Optional agent thread ID in which to execute the agent run"}},"required":["type"]}}}}}},"/v1/runs/{id}":{"get":{"operationId":"get-agent-run","summary":"Retrieve an agent run","description":"Retrieves details of a specific agent run","tags":["subpackage_runs"],"parameters":[{"name":"id","in":"path","description":"Agent run ID","required":true,"schema":{"type":"string"}},{"name":"include","in":"query","description":"Comma-separated list of optional sub-resources to include. Pass `steps` to populate the `steps` array with this run's execution trace; omitted by default to avoid the cost of fetching step state from the underlying execution backend.","required":false,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"agent run found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/type_:AgentsRun"}}}},"404":{"description":"agent run not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/type_:ErrorResponse"}}}}}}},"/v1/runs/{id}/feedback":{"post":{"operationId":"submit-agent-run-feedback","summary":"Submit feedback on an agent run","description":"Records a rating on an agent run artifact. The rating can be POSITIVE or NEGATIVE. Attribution defaults to the authenticated user; API-key callers are attributed to their account instead.","tags":["subpackage_runs"],"parameters":[{"name":"id","in":"path","description":"Agent run ID","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"feedback recorded successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/type_:AgentsRunFeedback"}}}},"403":{"description":"operator_feedback feature is not enabled on the account","content":{"application/json":{"schema":{"$ref":"#/components/schemas/type_:ErrorResponse"}}}},"404":{"description":"agent run not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/type_:ErrorResponse"}}}},"422":{"description":"request payload is missing or invalid","content":{"application/json":{"schema":{"$ref":"#/components/schemas/type_:ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"rating":{"$ref":"#/components/schemas/type_runs:AgentsRunFeedbackRequestParamRating","description":"Rating value to record for this artifact."},"artifact_id":{"type":"string","format":"uuid","description":"Identifier of the artifact to rate."},"comment":{"type":["string","null"],"description":"Optional free-text comment explaining the rating. Whitespace is stripped server-side; empty or whitespace-only strings are normalized to null."}},"required":["rating","artifact_id"]}}}}}},"/v1/runs/{id}/stream":{"get":{"operationId":"stream-agent-run-events","summary":"Stream agent run events","description":"Streams real-time events for an agent run using Server-Sent Events (SSE). Events are emitted in AG-UI format: `RUN_STARTED`, `STATE_SNAPSHOT`, and `RUN_FINISHED`.","tags":["subpackage_runs"],"parameters":[{"name":"id","in":"path","description":"Agent run ID","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"event stream","content":{"application/json":{"schema":{"type":"string"}}}},"404":{"description":"agent run not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/type_:ErrorResponse"}}}}}}},"/v1/identities/autocomplete":{"post":{"operationId":"autocomplete-business-identities","summary":"Autocomplete business identities","description":"Search for business identities using partial name matching. Returns matching businesses with names, addresses, people, and entity type.","tags":["subpackage_identities"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"autocomplete results","content":{"application/json":{"schema":{"$ref":"#/components/schemas/type_:BusinessIdentityList"}}}},"422":{"description":"invalid request - name too short","content":{"application/json":{"schema":{"$ref":"#/components/schemas/type_:ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Business name to search for (minimum 3 characters)"},"entity_type":{"$ref":"#/components/schemas/type_identities:BusinessIdentityRequestParamEntityType","description":"Entity type filter"},"addresses":{"type":"array","items":{"$ref":"#/components/schemas/type_identities:BusinessIdentityRequestParamAddressesItem"},"description":"Address filters"}},"required":["name"]}}}}}},"/v1/prefill/businesses":{"post":{"operationId":"business","summary":"Prefill business information","description":"Smart populate business attributes by searching with name and address, TIN, or website URL. Returns enriched business data.","tags":["subpackage_prefill"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"prefill results","content":{"application/json":{"schema":{"$ref":"#/components/schemas/type_:PrefillBusiness"}}}},"400":{"description":"invalid request - missing required parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/type_:ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"names":{"type":"array","items":{"type":"string"},"description":"Business name(s) to search for"},"addresses":{"type":"array","items":{"type":"string"},"description":"Business address(es) to search for"},"tin":{"type":"string","description":"Taxpayer Identification Number"},"website_url":{"type":"string","description":"Business website URL"},"autocomplete_result_id":{"type":"string","description":"ID of an autocomplete result to use for direct lookup"}}}}}}}},"/v1/webhooks":{"get":{"operationId":"list-webhooks","summary":"List webhooks","tags":["subpackage_webhooks"],"parameters":[{"name":"page","in":"query","description":"Page number","required":false,"schema":{"type":"integer"}},{"name":"per_page","in":"query","description":"Items per page","required":false,"schema":{"type":"integer"}},{"name":"account","in":"query","description":"Account slug (super admin only)","required":false,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"webhooks list","content":{"application/json":{"schema":{"description":"Any type"}}}}}},"post":{"operationId":"create-webhook","summary":"Create a webhook","tags":["subpackage_webhooks"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"webhook created with wildcard events","content":{"application/json":{"schema":{"description":"Any type"}}}},"422":{"description":"invalid request","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string","description":"Webhook endpoint URL"},"secret":{"type":"string","description":"Secret for webhook signature verification"},"enabled_events":{"type":"array","items":{"type":"string"},"description":"Array of event types to subscribe to, or [\"*\"] for all events"},"include":{"type":"string","description":"Comma-delimited list of associations to include in webhook payloads. Omit or set to \"*\" for all. Use \"identifiers\" to receive only top-level scalar fields (id, external_id, name, status, etc.) with no associations."},"oidc_auth_method":{"$ref":"#/components/schemas/type_webhooks:WebhookCreateParamOidcAuthMethod","description":"OIDC authentication method for obtaining access tokens. Required when configuring OIDC. 'private_key_jwt' — requires oidc_client_id, oidc_token_endpoint, oidc_access_token_ttl_seconds. 'client_secret' — requires oidc_client_id, oidc_client_secret, oidc_token_endpoint, oidc_access_token_ttl_seconds. Both methods optionally accept oidc_scope and oidc_resource_uri."},"oidc_client_id":{"type":"string","description":"OIDC client ID. Required for both auth methods."},"oidc_client_secret":{"type":"string","description":"OIDC client secret. Required when oidc_auth_method is 'client_secret'. Write-only; never returned in responses."},"oidc_token_endpoint":{"type":"string","description":"OIDC token endpoint URL. Required for both auth methods."},"oidc_resource_uri":{"type":"string","description":"Optional. OIDC resource URI (Microsoft-specific; use oidc_scope for standard OAuth 2.0)."},"oidc_scope":{"type":"string","description":"Optional. OAuth 2.0 scope for the token request (e.g. \"api://<app-id>/.default\")."},"oidc_access_token_ttl_seconds":{"type":"integer","description":"OIDC access token TTL in seconds. Required for both auth methods."}},"required":["url","enabled_events"]}}}}}},"/v1/webhooks/{id}":{"get":{"operationId":"get-webhook","summary":"Retrieve a webhook","tags":["subpackage_webhooks"],"parameters":[{"name":"id","in":"path","description":"Webhook ID","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"webhook found","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"webhook not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/type_:ErrorResponse"}}}}}},"put":{"operationId":"update-webhook","summary":"Update a webhook","tags":["subpackage_webhooks"],"parameters":[{"name":"id","in":"path","description":"Webhook ID","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"webhook updated","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"webhook not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/type_:ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string","description":"Webhook endpoint URL"},"secret":{"type":"string","description":"Secret for webhook signature verification"},"disabled_at":{"type":"string","description":"Timestamp when webhook was disabled"},"enabled_events":{"type":"array","items":{"type":"string"},"description":"Array of event types to subscribe to"},"include":{"type":"string","description":"Comma-delimited list of associations to include in webhook payloads. Omit or set to \"*\" for all. Use \"identifiers\" to receive only top-level scalar fields (id, external_id, name, status, etc.) with no associations."},"oidc_auth_method":{"$ref":"#/components/schemas/type_webhooks:WebhookUpdateParamOidcAuthMethod","description":"OIDC authentication method for obtaining access tokens. Required when configuring OIDC. 'private_key_jwt' — requires oidc_client_id, oidc_token_endpoint, oidc_access_token_ttl_seconds. 'client_secret' — requires oidc_client_id, oidc_client_secret, oidc_token_endpoint, oidc_access_token_ttl_seconds. Both methods optionally accept oidc_scope and oidc_resource_uri."},"oidc_client_id":{"type":"string","description":"OIDC client ID. Required for both auth methods."},"oidc_client_secret":{"type":"string","description":"OIDC client secret. Required when oidc_auth_method is 'client_secret'. Write-only; never returned in responses."},"oidc_token_endpoint":{"type":"string","description":"OIDC token endpoint URL. Required for both auth methods."},"oidc_resource_uri":{"type":"string","description":"Optional. OIDC resource URI (Microsoft-specific; use oidc_scope for standard OAuth 2.0)."},"oidc_scope":{"type":"string","description":"Optional. OAuth 2.0 scope for the token request (e.g. \"api://<app-id>/.default\")."},"oidc_access_token_ttl_seconds":{"type":"integer","description":"OIDC access token TTL in seconds. Required for both auth methods."}}}}}}},"delete":{"operationId":"delete-webhook","summary":"Delete a webhook","tags":["subpackage_webhooks"],"parameters":[{"name":"id","in":"path","description":"Webhook ID","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response"},"404":{"description":"webhook not found","content":{"application/json":{"schema":{"description":"Any type"}}}}}}},"/v1/webhooks/oidc_keys":{"get":{"operationId":"get-oidc-keys","summary":"Retrieve OIDC public keys","description":"Returns the public keys used for OIDC JWT signature verification","tags":["subpackage_webhooks"],"responses":{"200":{"description":"OIDC keys retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/type_:OidcKey"}}}}}}},"/v1/businesses/{business_id}/documents":{"get":{"operationId":"list-documents","summary":"List documents for a business","tags":["subpackage_documents"],"parameters":[{"name":"business_id","in":"path","description":"Business ID","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"documents found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/type_documents:ListDocumentsResponse"}}}},"404":{"description":"business not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/type_:ErrorResponse"}}}}}}},"/v1/documents/{id}":{"get":{"operationId":"get-document","summary":"Get a document","tags":["subpackage_documents"],"parameters":[{"name":"id","in":"path","description":"Document ID","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"document found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/type_:Document"}}}},"404":{"description":"document not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/type_:ErrorResponse"}}}}}}},"/v1/documents/{id}/download_url":{"get":{"operationId":"get-document-download-url","summary":"Get document download URL","tags":["subpackage_documents"],"parameters":[{"name":"id","in":"path","description":"Document ID","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"download URL returned","content":{"application/json":{"schema":{"$ref":"#/components/schemas/type_documents:GetDocumentDownloadUrlResponse"}}}},"404":{"description":"document not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/type_:ErrorResponse"}}}}}}}},"servers":[{"url":"https://api.middesk.com","description":"Default"}],"components":{"schemas":{"type_:BusinessItemStatus":{"type":"string","enum":["open","pending","in_audit","in_review","approved","rejected"],"description":"Current status of the business verification","title":"BusinessItemStatus"},"type_:ReviewObject":{"type":"string","enum":["review"],"title":"ReviewObject"},"type_:ReviewTaskCategory":{"type":"string","enum":["bankruptcies","global_watchlists","name","people_litigations","loans","kyc","watchlist","phone","formation","people_criminal_history","adverse_media","litigations","tin_type","address","sos","web","liens","people_bankruptcies","industry","tin","people","people_liens","website","politically_exposed_persons","email"],"title":"ReviewTaskCategory"},"type_:ReviewTaskKey":{"type":"string","enum":["location_frequency","bankruptcies","sos_unknown","address_deliverability","website_url_discovery","entity_type","web_person_verification","global_watchlists","website_status","name","sos_sub_status","name_and_entity_type","sos_active","profile_status","phone","sos_domestic","address_high_risk","web_address_verification","address_property_type","sos_not_found","time_in_business","web_phone_number_verification","adverse_media","litigations","address_verification","people_litigations","dba_name","watchlist","entity_type_match","people_criminal_history","formation_state","tin_error","sos_inactive","address_frequency","web_business_name_verification","web_presence_quality","tin_type","tin_issued","sos_domestic_sub_status","risky_keywords","address_registered_agent","sos","kyc_decision","ppp_loans","web_email_address_verification","tin","address","liens","sos_status","industry","sos_match","address_risk","website_url_domain_ownership","website_parked","domain_redirect","people_bankruptcies","politically_exposed_persons","person_verification","profile_discovery","address_cmra","website_verification","website","people_liens","email_risk"],"title":"ReviewTaskKey"},"type_:ReviewTaskLabel":{"type":"string","enum":["Politically Exposed Persons","Web Presence Quality","KYC","People Bankruptcies","Address Risk","Global Watchlists","Phone Number","Third Party Profile Status","Liens","Third Party Profiles","Time in Business","Web - Email Address","Risky Keywords","SOS Domestic Sub‑status","PPP Loans","Secretary of State Filings","Entity Type","SOS Filings","People Criminal History","Adverse Media","Web - People","Office Address","Entity Type Match","Web - Phone Number","Business Name","Bankruptcies","Industry Classification","TIN Match","Watchlists","People Litigations","True Industry","People","DBA Name","Domain Ownership","Domain Redirect","TIN Type","Website","TIN Error","Watchlist","Litigations","Web - Business Name","Name Entity Type","Formation State","People Liens","Web - Office Address","Email Risk"],"title":"ReviewTaskLabel"},"type_:ReviewTaskStatus":{"type":"string","enum":["success","failure","warning","neutral"],"title":"ReviewTaskStatus"},"type_:Source":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"type":{"type":"string"},"metadata":{"type":"object","additionalProperties":{"description":"Any type"}}},"required":["id","type","metadata"],"title":"Source"},"type_:ReviewTask":{"type":"object","properties":{"category":{"$ref":"#/components/schemas/type_:ReviewTaskCategory"},"key":{"$ref":"#/components/schemas/type_:ReviewTaskKey"},"label":{"$ref":"#/components/schemas/type_:ReviewTaskLabel"},"message":{"type":"string"},"name":{"type":"string"},"status":{"$ref":"#/components/schemas/type_:ReviewTaskStatus"},"sub_label":{"type":"string"},"sources":{"type":"array","items":{"$ref":"#/components/schemas/type_:Source"}}},"required":["category","key","label","message","name","status","sub_label","sources"],"title":"ReviewTask"},"type_:User":{"type":"object","properties":{"object":{"type":"string"},"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"email":{"type":"string","format":"email"},"roles":{"type":"array","items":{"type":"string"}},"image_url":{"type":"string","format":"uri"},"directory_managed":{"type":"boolean"},"last_login_at":{"type":["string","null"],"format":"date-time"},"settings":{"type":"object","additionalProperties":{"description":"Any type"}},"created_at":{"type":"string","format":"date-time"}},"required":["object","id","name","email","roles","created_at"],"title":"User"},"type_:Review":{"type":"object","properties":{"object":{"$ref":"#/components/schemas/type_:ReviewObject"},"id":{"type":"string","format":"uuid"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"completed_at":{"type":["string","null"],"format":"date-time"},"tasks":{"type":"array","items":{"$ref":"#/components/schemas/type_:ReviewTask"}},"assignee":{"oneOf":[{"$ref":"#/components/schemas/type_:User"},{"type":"null"}]}},"required":["object","id","created_at","updated_at","tasks"],"title":"Review"},"type_:BusinessItemWebsite":{"type":"object","properties":{"object":{"type":"string"},"id":{"type":"string","format":"uuid"},"url":{"type":"string"},"title":{"type":["string","null"]},"description":{"type":["string","null"]}},"title":"BusinessItemWebsite"},"type_:OrderStatus":{"type":"string","enum":["created","pending","audited","completed","approved","rejected"],"title":"OrderStatus"},"type_:OrderSubproductsItem":{"type":"string","enum":["Articles of Incorporation","Certificate of Good Standing","Articles of Incorporation with Certificate of Good Standing fallback","ucc_documents","web_analysis","industry_classification"],"title":"OrderSubproductsItem"},"type_:OrderProduct":{"type":"string","enum":["identity","liens","adverse_media","bankruptcies","business_enrichment","documents","enhanced_screenings","kyc","litigations","people_litigations","people_bankruptcies","people_tax_liens","people_ucc_liens","people_criminal_history","tin","website","business_verification_qualify","business_verification_verify","tax_liens","ucc_liens","email_risk"],"title":"OrderProduct"},"type_:OrderRequesterType":{"type":"string","enum":["account","user","api_key"],"title":"OrderRequesterType"},"type_:OrderRequester":{"type":"object","properties":{"name":{"type":["string","null"]},"type":{"oneOf":[{"$ref":"#/components/schemas/type_:OrderRequesterType"},{"type":"null"}]}},"title":"OrderRequester"},"type_:Order":{"type":"object","properties":{"object":{"type":"string"},"id":{"type":"string","format":"uuid"},"status":{"$ref":"#/components/schemas/type_:OrderStatus"},"business_id":{"type":"string","format":"uuid"},"subproducts":{"type":"array","items":{"$ref":"#/components/schemas/type_:OrderSubproductsItem"}},"completed_at":{"type":["string","null"],"format":"date-time"},"monitoring":{"type":"boolean"},"product":{"$ref":"#/components/schemas/type_:OrderProduct"},"requester":{"$ref":"#/components/schemas/type_:OrderRequester"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}},"required":["object","id","status","business_id","product","created_at","updated_at"],"title":"Order"},"type_:BusinessItem":{"type":"object","properties":{"object":{"type":"string"},"id":{"type":"string","format":"uuid"},"external_id":{"type":["string","null"]},"unique_external_id":{"type":["string","null"]},"name":{"type":"string"},"status":{"$ref":"#/components/schemas/type_:BusinessItemStatus","description":"Current status of the business verification"},"tags":{"type":"array","items":{"type":"string"}},"review":{"oneOf":[{"$ref":"#/components/schemas/type_:Review"},{"type":"null"}]},"assignee":{"oneOf":[{"$ref":"#/components/schemas/type_:User"},{"type":"null"}]},"website":{"oneOf":[{"$ref":"#/components/schemas/type_:BusinessItemWebsite"},{"type":"null"}]},"orders":{"type":"array","items":{"$ref":"#/components/schemas/type_:Order"}},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}},"required":["object","id","name","status","created_at","updated_at"],"description":"Simplified business object returned in list endpoints","title":"BusinessItem"},"type_businesses:ListBusinessesResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/type_:BusinessItem"}},"object":{"type":"string"},"has_more":{"type":"boolean"},"total_count":{"type":"integer"}},"required":["object","has_more"],"title":"ListBusinessesResponse"},"type_businesses:BusinessRequestParamTin":{"type":"object","properties":{"tin":{"type":"string"}},"title":"BusinessRequestParamTin"},"type_:SubmittedAddressFull":{"type":"object","properties":{"full_address":{"type":"string","description":"Complete address as a single string"}},"required":["full_address"],"title":"SubmittedAddressFull"},"type_:SubmittedAddressComponentState":{"type":"string","enum":["AL","AK","AZ","AR","CA","CO","CT","DE","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY"],"title":"SubmittedAddressComponentState"},"type_:SubmittedAddressComponent":{"type":"object","properties":{"address_line_1":{"type":"string"},"address_line_2":{"type":"string"},"city":{"type":"string"},"state":{"$ref":"#/components/schemas/type_:SubmittedAddressComponentState"},"postal_code":{"type":"string"},"country":{"type":"string"}},"required":["address_line_1","city","state"],"title":"SubmittedAddressComponent"},"type_businesses:BusinessRequestParamAddressesItem":{"oneOf":[{"$ref":"#/components/schemas/type_:SubmittedAddressFull"},{"$ref":"#/components/schemas/type_:SubmittedAddressComponent"}],"title":"BusinessRequestParamAddressesItem"},"type_businesses:BusinessRequestParamWebsite":{"type":"object","properties":{"url":{"type":"string","format":"uri","description":"The website URL for the business"}},"description":"Website information for the business. Required when name and addresses are not provided when ordering the web_analysis and/or industry_classification subproducts.","title":"BusinessRequestParamWebsite"},"type_:SubmittedPerson":{"type":"object","properties":{"name":{"type":"string","description":"Full name of the person"},"title":{"type":"string","description":"Job title or role"},"email":{"type":"string","format":"email"},"phone":{"type":"string"}},"required":["name"],"title":"SubmittedPerson"},"type_businesses:BusinessRequestParamOrdersItemProduct":{"type":"string","enum":["identity","liens","adverse_media","bankruptcies","business_enrichment","documents","enhanced_screenings","kyc","litigations","people_litigations","people_bankruptcies","people_tax_liens","people_ucc_liens","people_criminal_history","tin","website","business_verification_qualify","business_verification_verify","tax_liens","ucc_liens","email_risk"],"description":"The product to order.","title":"BusinessRequestParamOrdersItemProduct"},"type_businesses:BusinessRequestParamOrdersItemSubproductsItem":{"type":"string","enum":["articles_of_incorporation","certificate_of_good_standing","articles_of_incorporation_with_fallback","ucc_documents","web_analysis","industry_classification"],"title":"BusinessRequestParamOrdersItemSubproductsItem"},"type_businesses:BusinessRequestParamOrdersItemOptions":{"type":"object","properties":{"person_match":{"type":"boolean","description":"When true on a `tin` order, enables person-name matching against IRS records."}},"description":"Per-order configuration flags.","title":"BusinessRequestParamOrdersItemOptions"},"type_businesses:BusinessRequestParamOrdersItem":{"type":"object","properties":{"product":{"$ref":"#/components/schemas/type_businesses:BusinessRequestParamOrdersItemProduct","description":"The product to order."},"subproducts":{"type":"array","items":{"$ref":"#/components/schemas/type_businesses:BusinessRequestParamOrdersItemSubproductsItem"},"description":"Subproducts to include with the order."},"options":{"$ref":"#/components/schemas/type_businesses:BusinessRequestParamOrdersItemOptions","description":"Per-order configuration flags."}},"required":["product"],"title":"BusinessRequestParamOrdersItem"},"type_:BusinessStatus":{"type":"string","enum":["open","pending","in_audit","in_review","approved","rejected"],"description":"Current status of the business verification","title":"BusinessStatus"},"type_:RequesterType":{"type":"string","enum":["account","user"],"title":"RequesterType"},"type_:Requester":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"type":{"$ref":"#/components/schemas/type_:RequesterType"},"name":{"type":"string"},"requested_at":{"type":"string","format":"date-time"}},"required":["id","type","name","requested_at"],"title":"Requester"},"type_:BusinessSupportedDocumentTypesItem":{"type":"string","enum":["Articles of Incorporation","Certificate of Good Standing"],"title":"BusinessSupportedDocumentTypesItem"},"type_:Tin":{"type":"object","properties":{"name":{"type":["string","null"]},"mismatch":{"type":"boolean"},"unknown":{"type":"boolean"},"verified":{"type":["boolean","null"]},"error":{"type":["string","null"]},"updated_at":{"type":"string","format":"date-time"},"issued":{"type":["boolean","null"]},"verified_by":{"type":["string","null"]},"business_id":{"type":"string","format":"uuid"},"tin":{"type":"string"}},"required":["business_id","tin"],"title":"Tin"},"type_:Formation":{"type":"object","properties":{"entity_type":{"type":"string"},"formation_date":{"type":"string","format":"date"},"formation_state":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"sources":{"type":"array","items":{"$ref":"#/components/schemas/type_:Source"}}},"required":["created_at","updated_at"],"title":"Formation"},"type_:WebsiteObject":{"type":"string","enum":["website"],"title":"WebsiteObject"},"type_:WebsiteStatus":{"type":"string","enum":["online","offline","unknown"],"title":"WebsiteStatus"},"type_:WebsiteDomainRegistrar":{"type":"object","properties":{"organization":{"type":["string","null"]},"name":{"type":"string"},"url":{"type":["string","null"],"format":"uri"}},"title":"WebsiteDomainRegistrar"},"type_:WebsiteDomain":{"type":"object","properties":{"domain":{"type":"string"},"domain_id":{"type":["string","null"]},"creation_date":{"type":"string","format":"date-time"},"expiration_date":{"type":"string","format":"date-time"},"registrar":{"$ref":"#/components/schemas/type_:WebsiteDomainRegistrar"},"redirected":{"type":["boolean","null"],"description":"Whether the domain redirects to a different URL"},"url_shortener":{"type":["boolean","null"],"description":"Whether the domain uses a URL shortener service"},"resolved_url":{"type":["string","null"],"format":"uri","description":"The final URL after redirect resolution (present when redirected is true)"}},"title":"WebsiteDomain"},"type_:WebsitePagesItem":{"type":"object","properties":{"url":{"type":"string","format":"uri"},"category":{"type":"string"},"screenshot_url":{"type":"string","format":"uri"}},"title":"WebsitePagesItem"},"type_:NameType":{"type":"string","enum":["legal","dba"],"title":"NameType"},"type_:Name":{"type":"object","properties":{"object":{"type":"string"},"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"submitted":{"type":"boolean"},"type":{"oneOf":[{"$ref":"#/components/schemas/type_:NameType"},{"type":"null"}]},"business_id":{"type":"string","format":"uuid"},"sources":{"type":"array","items":{"$ref":"#/components/schemas/type_:Source"}}},"required":["object","id","name","submitted","business_id","sources"],"title":"Name"},"type_:WebsitePhoneNumberObject":{"type":"string","enum":["phone_number"],"title":"WebsitePhoneNumberObject"},"type_:WebsitePhoneNumber":{"type":"object","properties":{"object":{"$ref":"#/components/schemas/type_:WebsitePhoneNumberObject"},"id":{"type":"string","format":"uuid"},"number":{"type":"string"},"contact_type":{"type":["string","null"]},"recommended":{"type":["boolean","null"]},"submitted":{"type":"boolean"},"sources":{"type":["array","null"],"items":{"$ref":"#/components/schemas/type_:Source"}}},"title":"WebsitePhoneNumber"},"type_:WebsiteAddressesItem":{"type":"object","properties":{"object":{"type":"string"},"id":{"type":"string","format":"uuid"},"address_line1":{"type":["string","null"]},"address_line2":{"type":["string","null"]},"city":{"type":["string","null"]},"state":{"type":["string","null"]},"postal_code":{"type":["string","null"]},"full_address":{"type":"string"},"submitted":{"type":"boolean"},"sources":{"type":"array","items":{"$ref":"#/components/schemas/type_:Source"}}},"title":"WebsiteAddressesItem"},"type_:WebsiteEmailAddressesItemObject":{"type":"string","enum":["email_address"],"title":"WebsiteEmailAddressesItemObject"},"type_:WebsiteEmailAddressesItem":{"type":"object","properties":{"object":{"$ref":"#/components/schemas/type_:WebsiteEmailAddressesItemObject"},"email":{"type":"string"},"id":{"type":"string","format":"uuid"},"submitted":{"type":"boolean"},"sources":{"type":"array","items":{"$ref":"#/components/schemas/type_:Source"}}},"title":"WebsiteEmailAddressesItem"},"type_:WebsiteIndicatorType":{"type":"string","enum":["domain_age","top_level_domain","content_diversity","contact_info","compliance_info","page_count","broken_links","domain_consistency","update_frequency","filler_text","image_quality","last_updated","third_party_profile_links","us_business_presence","spelling_and_grammar","https","domain_ownership"],"title":"WebsiteIndicatorType"},"type_:WebsiteIndicatorRating":{"type":"string","enum":["positive","negative","neutral"],"title":"WebsiteIndicatorRating"},"type_:WebsiteIndicator":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/type_:WebsiteIndicatorType"},"name":{"type":"string"},"rating":{"$ref":"#/components/schemas/type_:WebsiteIndicatorRating"},"value":{"type":"string"},"description":{"type":"string"}},"required":["type","name","rating","value","description"],"title":"WebsiteIndicator"},"type_:WebsiteRatingQualityRating":{"type":"string","enum":["low","moderate","high","not_available"],"title":"WebsiteRatingQualityRating"},"type_:WebsiteRating":{"type":"object","properties":{"indicators":{"type":"array","items":{"$ref":"#/components/schemas/type_:WebsiteIndicator"}},"quality_rating":{"$ref":"#/components/schemas/type_:WebsiteRatingQualityRating"}},"required":["quality_rating"],"title":"WebsiteRating"},"type_:Website":{"type":"object","properties":{"object":{"$ref":"#/components/schemas/type_:WebsiteObject"},"id":{"type":"string","format":"uuid"},"url":{"type":["string","null"],"format":"uri","description":"The URL that was passed or found for the Business"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"status":{"$ref":"#/components/schemas/type_:WebsiteStatus"},"http_status_code":{"type":["integer","null"],"description":"HTTP response status code"},"title":{"type":["string","null"],"description":"Website page title"},"description":{"type":["string","null"],"description":"Website meta description"},"domain":{"oneOf":[{"$ref":"#/components/schemas/type_:WebsiteDomain"},{"type":"null"}],"description":"Domain registration and redirect information"},"pages":{"type":"array","items":{"$ref":"#/components/schemas/type_:WebsitePagesItem"},"description":"Website pages with screenshots"},"parked":{"type":["boolean","null"],"description":"Whether the domain is parked"},"submitted":{"type":"boolean","description":"Whether the website was submitted by user"},"error":{"type":["string","null"],"description":"Error message if website analysis failed"},"category":{"type":["string","null"],"description":"Website category classification"},"platform":{"type":["string","null"],"description":"Website platform (e.g., instagram.com, facebook.com)"},"posts_summary":{"type":["string","null"],"description":"Summary of posts found on the website or linked social media profiles"},"reviews_summary":{"type":["string","null"],"description":"Summary of reviews found on the website or linked third-party profiles"},"business_id":{"type":"string","format":"uuid"},"business_name_match":{"type":"boolean","description":"Whether website content matches business name"},"names":{"type":"array","items":{"$ref":"#/components/schemas/type_:Name"},"description":"Names found on website"},"phone_numbers":{"type":"array","items":{"$ref":"#/components/schemas/type_:WebsitePhoneNumber"},"description":"Phone numbers found on website"},"people":{"type":["array","null"],"items":{"type":"object","additionalProperties":{"description":"Any type"}},"description":"People found on website"},"addresses":{"type":"array","items":{"$ref":"#/components/schemas/type_:WebsiteAddressesItem"},"description":"Addresses found on website"},"email_addresses":{"type":["array","null"],"items":{"$ref":"#/components/schemas/type_:WebsiteEmailAddressesItem"},"description":"Email addresses found on website"},"rating":{"oneOf":[{"$ref":"#/components/schemas/type_:WebsiteRating"},{"type":"null"}]}},"required":["object","id","url","created_at","updated_at","status","parked","submitted","business_id","business_name_match","phone_numbers","addresses"],"title":"Website"},"type_:WatchlistAgency":{"type":"object","properties":{"abbr":{"type":"string"},"name":{"type":"string"},"org":{"type":"string"}},"required":["abbr","name","org"],"title":"WatchlistAgency"},"type_:WatchlistResultObject":{"type":"string","enum":["watchlist_result"],"title":"WatchlistResultObject"},"type_:WatchlistResultAddressesItem":{"type":"object","properties":{"full_address":{"type":"string"}},"title":"WatchlistResultAddressesItem"},"type_:WatchlistResult":{"type":"object","properties":{"object":{"$ref":"#/components/schemas/type_:WatchlistResultObject"},"id":{"type":"string","format":"uuid"},"status":{"type":"string"},"entity_name":{"type":"string"},"entity_aliases":{"type":"array","items":{"type":"string"}},"listed_at":{"type":["string","null"],"format":"date-time"},"agency_information_url":{"type":"string"},"agency_list_url":{"type":"string"},"score":{"type":["number","null"],"format":"double"},"addresses":{"type":"array","items":{"$ref":"#/components/schemas/type_:WatchlistResultAddressesItem"}},"url":{"type":["string","null"],"format":"uri"},"list_country":{"type":"string"},"list_url":{"type":["string","null"],"format":"uri"},"list_region":{"type":"string"},"categories":{"type":"array","items":{"type":"string"}}},"required":["object","id","status","entity_name","entity_aliases","agency_information_url","agency_list_url","score"],"title":"WatchlistResult"},"type_:WatchlistSource":{"type":"object","properties":{"object":{"type":"string"},"agency":{"type":"string"},"agency_abbr":{"type":"string"},"organization":{"type":"string"},"title":{"type":"string"},"abbr":{"type":"string"},"results":{"type":"array","items":{"$ref":"#/components/schemas/type_:WatchlistResult"}}},"required":["object","agency","agency_abbr","organization","title","abbr","results"],"title":"WatchlistSource"},"type_:Watchlist":{"type":"object","properties":{"object":{"type":"string"},"id":{"type":"string","format":"uuid"},"hit_count":{"type":"integer"},"agencies":{"type":"array","items":{"$ref":"#/components/schemas/type_:WatchlistAgency"}},"lists":{"type":"array","items":{"$ref":"#/components/schemas/type_:WatchlistSource"}},"people":{"type":"array","items":{"type":"object","additionalProperties":{"description":"Any type"}}}},"required":["object","id","hit_count","agencies","lists","people"],"title":"Watchlist"},"type_:BankruptcyObject":{"type":"string","enum":["bankruptcy"],"title":"BankruptcyObject"},"type_:BankruptcyCaseUpdatesItem":{"type":"object","properties":{"guid":{"type":"string"},"pub_date":{"type":"string"},"description":{"type":"string"}},"title":"BankruptcyCaseUpdatesItem"},"type_:BankruptcyDebtorsItem":{"type":"object","properties":{"name":{"type":"string"}},"title":"BankruptcyDebtorsItem"},"type_:Bankruptcy":{"type":"object","properties":{"object":{"$ref":"#/components/schemas/type_:BankruptcyObject"},"id":{"type":"string","format":"uuid"},"business_id":{"type":"string","format":"uuid"},"case_number":{"type":"string"},"case_updates":{"type":"array","items":{"$ref":"#/components/schemas/type_:BankruptcyCaseUpdatesItem"}},"chapter":{"type":"number","format":"double"},"court":{"type":"string"},"filing_date":{"type":["string","null"],"format":"date"},"debtors":{"type":"array","items":{"$ref":"#/components/schemas/type_:BankruptcyDebtorsItem"}}},"required":["object","id","business_id","case_number","case_updates","chapter","court","filing_date","debtors"],"title":"Bankruptcy"},"type_:CertificationObject":{"type":"string","enum":["certification"],"title":"CertificationObject"},"type_:CertificationCertificationType":{"type":"string","enum":["federal","self_certified"],"title":"CertificationCertificationType"},"type_:CertificationExternalSourcesItem":{"type":"object","properties":{"organization":{"type":"string"},"link":{"type":"string"}},"title":"CertificationExternalSourcesItem"},"type_:Certification":{"type":"object","properties":{"object":{"$ref":"#/components/schemas/type_:CertificationObject"},"id":{"type":"string","format":"uuid"},"business_id":{"type":"string","format":"uuid"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"entrance_date":{"type":["string","null"],"format":"date-time"},"exit_date":{"type":["string","null"],"format":"date-time"},"certification_id":{"type":["string","null"]},"name":{"type":"string"},"key":{"type":"string"},"certification_type":{"$ref":"#/components/schemas/type_:CertificationCertificationType"},"external_sources":{"type":"array","items":{"$ref":"#/components/schemas/type_:CertificationExternalSourcesItem"}}},"required":["object","name","key","certification_type","external_sources"],"title":"Certification"},"type_:DocumentObject":{"type":"string","enum":["document"],"title":"DocumentObject"},"type_:DocumentSource":{"type":"object","properties":{"type":{"type":"string","description":"Source type (e.g., registration)"},"id":{"type":"string","format":"uuid","description":"Source record ID"},"metadata":{"type":"object","additionalProperties":{"description":"Any type"},"description":"Additional source metadata"}},"title":"DocumentSource"},"type_:Document":{"type":"object","properties":{"object":{"$ref":"#/components/schemas/type_:DocumentObject"},"id":{"type":"string","format":"uuid"},"document_type":{"type":"string","description":"Type of document. Common values include: Initial_Filing, Certificate of Good Standing, Articles of Incorporation, Initial Filing (UCC1), Amendment (UCC3)"},"filename":{"type":"string","description":"Name of the document file"},"content_type":{"type":"string","description":"MIME type of the document"},"size":{"type":"integer","description":"File size in bytes"},"download_url":{"type":"string","format":"uri","description":"URL to download the document"},"created_at":{"type":"string","format":"date-time"},"source":{"$ref":"#/components/schemas/type_:DocumentSource"},"filing_date":{"type":["string","null"],"format":"date-time"},"metadata":{"type":"object","additionalProperties":{"description":"Any type"},"description":"Additional document metadata"}},"required":["object","id","document_type","filename","content_type","size","download_url","created_at"],"title":"Document"},"type_:LienObject":{"type":"string","enum":["lien"],"title":"LienObject"},"type_:LienType":{"type":"string","enum":["ucc","state","federal","attachment","judgment"],"description":"Type of lien","title":"LienType"},"type_:LienDebtorsItemType":{"type":"string","enum":["ORGANIZATION","INDIVIDUAL","UNKNOWN","Business"],"title":"LienDebtorsItemType"},"type_:LienDebtorsItemAddressesItem":{"type":"object","properties":{"full_address":{"type":"string"},"address_line1":{"type":"string"},"address_line2":{"type":["string","null"]},"city":{"type":"string"},"state":{"type":"string"},"postal_code":{"type":"string"}},"title":"LienDebtorsItemAddressesItem"},"type_:LienDebtorsItem":{"type":"object","properties":{"name":{"type":"string"},"type":{"$ref":"#/components/schemas/type_:LienDebtorsItemType"},"party_type":{"type":"string"},"organization_name":{"type":"string"},"entity_type":{"type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"},"addresses":{"type":"array","items":{"$ref":"#/components/schemas/type_:LienDebtorsItemAddressesItem"}}},"title":"LienDebtorsItem"},"type_:LienSecuredPartiesItemType":{"type":"string","enum":["ORGANIZATION","INDIVIDUAL"],"title":"LienSecuredPartiesItemType"},"type_:LienSecuredPartiesItemAddressesItem":{"type":"object","properties":{"full_address":{"type":"string"},"address_line1":{"type":"string"},"address_line2":{"type":["string","null"]},"city":{"type":"string"},"state":{"type":"string"},"postal_code":{"type":"string"}},"title":"LienSecuredPartiesItemAddressesItem"},"type_:LienSecuredPartiesItem":{"type":"object","properties":{"name":{"type":"string"},"type":{"$ref":"#/components/schemas/type_:LienSecuredPartiesItemType"},"role":{"type":"string"},"organization_name":{"type":"string"},"addresses":{"type":"array","items":{"$ref":"#/components/schemas/type_:LienSecuredPartiesItemAddressesItem"}}},"title":"LienSecuredPartiesItem"},"type_:LienState":{"type":"string","enum":["AL","AK","AZ","AR","CA","CO","CT","DE","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY"],"description":"State where the lien was filed","title":"LienState"},"type_:LienStatus":{"type":"string","enum":["created","pending","open","closing","closed","unknown","filed"],"description":"Current status of the lien","title":"LienStatus"},"type_:LienCollateralType":{"type":"string","enum":["Blanket","Collateral","Unknown","All Assets and Receivables","All Receivables","All Assets","Named Assets","Unavailable"],"title":"LienCollateralType"},"type_:LienAlternativeDesignation":{"type":"string","enum":["buyer_seller","bailee_bailor","consignee_consignor","lessee_lessor","licensee_licensor"],"title":"LienAlternativeDesignation"},"type_:LienStatusCategory":{"type":"string","enum":["active","open","closed","terminated","processing","unknown"],"description":"Categorized status of the lien","title":"LienStatusCategory"},"type_:Lien":{"type":"object","properties":{"object":{"$ref":"#/components/schemas/type_:LienObject"},"type":{"$ref":"#/components/schemas/type_:LienType","description":"Type of lien"},"id":{"type":"string","format":"uuid"},"business_id":{"type":"string","format":"uuid"},"debtors":{"type":"array","items":{"$ref":"#/components/schemas/type_:LienDebtorsItem"}},"secured_parties":{"type":"array","items":{"$ref":"#/components/schemas/type_:LienSecuredPartiesItem"}},"file_number":{"type":["string","null"],"description":"Filing number for the lien"},"state":{"$ref":"#/components/schemas/type_:LienState","description":"State where the lien was filed"},"status":{"$ref":"#/components/schemas/type_:LienStatus","description":"Current status of the lien"},"filing_date":{"type":["string","null"],"format":"date","description":"Date the lien was filed"},"updated_date":{"type":["string","null"],"format":"date","description":"Date the lien was last updated"},"lapse_date":{"type":["string","null"],"format":"date","description":"Date the lien lapses/expires"},"collateral":{"type":["string","null"],"description":"Description of collateral securing the lien"},"collateral_type":{"oneOf":[{"$ref":"#/components/schemas/type_:LienCollateralType"},{"type":"null"}],"description":"Type of collateral"},"negative_pledge":{"type":"boolean","description":"Whether this is a negative pledge"},"confirmation_number":{"type":["string","null"]},"loan_principal_amount_cents":{"type":["integer","null"],"description":"Loan principal amount in cents"},"source":{"type":["string","null"],"format":"uri","description":"Source URL for the lien data"},"packet_number":{"type":["string","null"]},"lien_termination":{"type":["object","null"],"additionalProperties":{"description":"Any type"},"description":"Lien termination details if terminated"},"liability_cents":{"type":["integer","null"],"description":"Liability amount in cents"},"alternative_designation":{"oneOf":[{"$ref":"#/components/schemas/type_:LienAlternativeDesignation"},{"type":"null"}]},"status_category":{"$ref":"#/components/schemas/type_:LienStatusCategory","description":"Categorized status of the lien"},"owner_id":{"type":"string","format":"uuid","description":"Polymorphic owner ID (typically business_id)"},"owner_type":{"type":"string","description":"Polymorphic owner type (typically Business)"},"filed_by_account":{"type":["boolean","null"],"description":"Whether the lien was filed by the account"},"documents":{"type":"array","items":{"$ref":"#/components/schemas/type_:Document"},"description":"Associated lien documents"}},"required":["object","type","id","business_id","debtors","secured_parties","file_number","state","status","filing_date","status_category","owner_id","owner_type","documents"],"title":"Lien"},"type_:AddressState":{"type":"string","enum":["AL","AK","AZ","AR","CA","CO","CT","DE","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY"],"title":"AddressState"},"type_:AddressPropertyType":{"type":"string","enum":["commercial","residential"],"title":"AddressPropertyType"},"type_:AddressDeliverabilityAnalysisSubType":{"type":"string","enum":["Deliverable","Undeliverable","Unknown"],"title":"AddressDeliverabilityAnalysisSubType"},"type_:AddressDeliverabilityAnalysisSubKey":{"type":"string","enum":["deliverable","undeliverable","unknown"],"title":"AddressDeliverabilityAnalysisSubKey"},"type_:AddressDeliverabilityAnalysis":{"type":"object","properties":{"message":{"type":"string"},"sub_type":{"$ref":"#/components/schemas/type_:AddressDeliverabilityAnalysisSubType"},"sub_key":{"$ref":"#/components/schemas/type_:AddressDeliverabilityAnalysisSubKey"}},"title":"AddressDeliverabilityAnalysis"},"type_:AddressIndicatorType":{"type":"string","enum":["valid_us_address","deliverability","geographical_location","registered_agent","private_mailbox","location_frequency","property_type","virtual_address"],"title":"AddressIndicatorType"},"type_:AddressIndicatorName":{"type":"string","enum":["Valid US address","Commercial registered agent","Geographical location","Private mailbox","Virtual address","Location frequency","Deliverability","Property type"],"title":"AddressIndicatorName"},"type_:AddressIndicatorRating":{"type":"string","enum":["positive","negative","neutral"],"title":"AddressIndicatorRating"},"type_:AddressIndicator":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/type_:AddressIndicatorType"},"name":{"$ref":"#/components/schemas/type_:AddressIndicatorName"},"rating":{"$ref":"#/components/schemas/type_:AddressIndicatorRating"},"value":{"type":"string"},"description":{"type":"string"}},"required":["type","name","rating","value","description"],"title":"AddressIndicator"},"type_:AddressRatingRiskRating":{"type":"string","enum":["low","moderate","high","not_available"],"title":"AddressRatingRiskRating"},"type_:AddressRating":{"type":"object","properties":{"indicators":{"type":"array","items":{"$ref":"#/components/schemas/type_:AddressIndicator"}},"risk_rating":{"$ref":"#/components/schemas/type_:AddressRatingRiskRating"}},"required":["risk_rating"],"title":"AddressRating"},"type_:Address":{"type":"object","properties":{"object":{"type":"string"},"id":{"type":"string","format":"uuid"},"address_line1":{"type":["string","null"]},"address_line2":{"type":["string","null"]},"city":{"type":["string","null"]},"state":{"oneOf":[{"$ref":"#/components/schemas/type_:AddressState"},{"type":"null"}]},"postal_code":{"type":["string","null"]},"full_address":{"type":"string"},"submitted":{"type":"boolean"},"latitude":{"type":["number","null"],"format":"double"},"longitude":{"type":["number","null"],"format":"double"},"property_type":{"oneOf":[{"$ref":"#/components/schemas/type_:AddressPropertyType"},{"type":"null"}]},"deliverable":{"type":"boolean"},"deliverability_analysis":{"oneOf":[{"$ref":"#/components/schemas/type_:AddressDeliverabilityAnalysis"},{"type":"null"}]},"street_view_available":{"type":["boolean","null"]},"labels":{"type":"array","items":{"type":"string"}},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"registered_agent_name":{"type":["string","null"]},"cmra":{"type":"boolean"},"business_id":{"type":"string","format":"uuid"},"location_count":{"type":["integer","null"]},"is_registered_agent":{"type":["boolean","null"]},"sources":{"type":"array","items":{"$ref":"#/components/schemas/type_:Source"}},"rating":{"$ref":"#/components/schemas/type_:AddressRating"}},"required":["object","id","full_address","submitted","created_at","updated_at","business_id","sources","rating"],"title":"Address"},"type_:PersonObject":{"type":"string","enum":["person"],"title":"PersonObject"},"type_:PersonTitlesItemObject":{"type":"string","enum":["person_title"],"title":"PersonTitlesItemObject"},"type_:PersonTitlesItem":{"type":"object","properties":{"object":{"$ref":"#/components/schemas/type_:PersonTitlesItemObject"},"title":{"type":"string"}},"title":"PersonTitlesItem"},"type_:LitigationCaseStatus":{"type":"string","enum":["OPEN","CLOSED","UNKNOWN"],"title":"LitigationCaseStatus"},"type_:Judgment":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"litigation_id":{"type":"string","format":"uuid"},"docket_entry_date":{"type":"string","format":"date"},"text":{"type":"string"},"amount_cents":{"type":["integer","null"],"description":"The judgment amount in cents. For example, 5000000 represents $50,000.00. Null if no monetary amount is associated with the judgment."},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}},"required":["id","litigation_id","docket_entry_date","text","created_at","updated_at"],"title":"Judgment"},"type_:LitigationPartiesItemRole":{"type":"string","enum":["Plaintiff","Defendant","Cross-Plaintiff","Cross-Defendant"],"title":"LitigationPartiesItemRole"},"type_:LitigationPartiesItem":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"role":{"$ref":"#/components/schemas/type_:LitigationPartiesItemRole"},"litigation_id":{"type":"string","format":"uuid"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}},"required":["id","name","role","litigation_id"],"title":"LitigationPartiesItem"},"type_:Litigation":{"type":"object","properties":{"object":{"type":"string"},"id":{"type":"string","format":"uuid"},"case_name":{"type":"string"},"case_number":{"type":"string"},"case_status":{"$ref":"#/components/schemas/type_:LitigationCaseStatus"},"case_type":{"type":"string"},"filing_date":{"type":"string","format":"date"},"judgments":{"type":"array","items":{"$ref":"#/components/schemas/type_:Judgment"}},"jurisdiction":{"type":"string"},"jurisdiction_state":{"type":["string","null"]},"party_type":{"type":"string"},"parties":{"type":"array","items":{"$ref":"#/components/schemas/type_:LitigationPartiesItem"}}},"required":["object","id","case_name","case_number","case_status","case_type","filing_date","party_type"],"title":"Litigation"},"type_:CriminalHistoryRecordObject":{"type":"string","enum":["criminal_history/record"],"title":"CriminalHistoryRecordObject"},"type_:CriminalHistoryRecordPerson":{"type":"object","properties":{"dob":{"type":["string","null"],"format":"date"}},"title":"CriminalHistoryRecordPerson"},"type_:CriminalHistoryCaseObject":{"type":"string","enum":["criminal_history/case"],"title":"CriminalHistoryCaseObject"},"type_:CriminalHistoryChargeObject":{"type":"string","enum":["criminal_history/charge"],"title":"CriminalHistoryChargeObject"},"type_:CriminalHistoryChargeDispositionsItem":{"type":"object","properties":{"disposition":{"type":["string","null"]},"disposition_date":{"type":["string","null"],"format":"date"},"disposition_type":{"type":["string","null"]}},"title":"CriminalHistoryChargeDispositionsItem"},"type_:CriminalHistoryChargeSentencesItem":{"type":"object","properties":{"details":{"type":"string"}},"title":"CriminalHistoryChargeSentencesItem"},"type_:CriminalHistoryCharge":{"type":"object","properties":{"object":{"$ref":"#/components/schemas/type_:CriminalHistoryChargeObject"},"category":{"type":["string","null"]},"charge_type":{"type":["string","null"]},"city":{"type":["string","null"]},"county":{"type":["string","null"]},"description":{"type":["string","null"]},"dispositions":{"type":"array","items":{"$ref":"#/components/schemas/type_:CriminalHistoryChargeDispositionsItem"}},"legal_code":{"type":["string","null"]},"offense_date":{"type":["string","null"],"format":"date"},"sentences":{"type":["array","null"],"items":{"$ref":"#/components/schemas/type_:CriminalHistoryChargeSentencesItem"}},"state":{"type":["string","null"]},"subcategory":{"type":["string","null"]},"subsubcategory":{"type":["string","null"]}},"required":["object"],"title":"CriminalHistoryCharge"},"type_:CriminalHistoryCase":{"type":"object","properties":{"object":{"$ref":"#/components/schemas/type_:CriminalHistoryCaseObject"},"arrest_date":{"type":["string","null"],"format":"date"},"case_number":{"type":["string","null"]},"case_type":{"type":["string","null"]},"court_county":{"type":["string","null"]},"court_name":{"type":["string","null"]},"file_date":{"type":["string","null"],"format":"date"},"status":{"type":["string","null"]},"title":{"type":["string","null"]},"arresting_agency":{"type":["string","null"]},"charges":{"type":"array","items":{"$ref":"#/components/schemas/type_:CriminalHistoryCharge"}}},"required":["object","charges"],"title":"CriminalHistoryCase"},"type_:CriminalHistoryRecord":{"type":"object","properties":{"object":{"$ref":"#/components/schemas/type_:CriminalHistoryRecordObject"},"id":{"type":"string","format":"uuid"},"category":{"type":"string"},"state":{"type":["string","null"]},"person":{"$ref":"#/components/schemas/type_:CriminalHistoryRecordPerson"},"cases":{"type":"array","items":{"$ref":"#/components/schemas/type_:CriminalHistoryCase"}}},"required":["object","id","category","cases"],"title":"CriminalHistoryRecord"},"type_:Person":{"type":"object","properties":{"object":{"$ref":"#/components/schemas/type_:PersonObject"},"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"submitted":{"type":"boolean"},"business_id":{"type":"string","format":"uuid"},"titles":{"type":"array","items":{"$ref":"#/components/schemas/type_:PersonTitlesItem"}},"people_bankruptcies":{"type":"array","items":{"type":"object","additionalProperties":{"description":"Any type"}}},"litigations":{"type":"array","items":{"$ref":"#/components/schemas/type_:Litigation"}},"liens":{"type":"array","items":{"$ref":"#/components/schemas/type_:Lien"}},"criminal_records":{"type":"array","items":{"$ref":"#/components/schemas/type_:CriminalHistoryRecord"}},"sources":{"type":"array","items":{"$ref":"#/components/schemas/type_:Source"}}},"title":"Person"},"type_:PhoneNumberObject":{"type":"string","enum":["phone_number"],"title":"PhoneNumberObject"},"type_:PhoneNumber":{"type":"object","properties":{"object":{"$ref":"#/components/schemas/type_:PhoneNumberObject"},"number":{"type":"string"},"contact_type":{"type":["string","null"]},"recommended":{"type":["boolean","null"]}},"title":"PhoneNumber"},"type_:EmailAddressObject":{"type":"string","enum":["email_address"],"title":"EmailAddressObject"},"type_:EmailAddressAddressType":{"type":"string","enum":["disposable","free","private"],"description":"Classification of the email address. Included when email risk data is present.","title":"EmailAddressAddressType"},"type_:EmailRatingRiskRating":{"type":"string","enum":["low","moderate","high"],"title":"EmailRatingRiskRating"},"type_:EmailIndicatorType":{"type":"string","enum":["email_validity","email_deliverability","email_domain_reputation","email_domain_configuration","email_account_activity","email_data_breach_exposure","email_address_type"],"title":"EmailIndicatorType"},"type_:EmailIndicatorRating":{"type":"string","enum":["positive","negative","neutral"],"title":"EmailIndicatorRating"},"type_:EmailIndicator":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/type_:EmailIndicatorType"},"name":{"type":"string"},"rating":{"$ref":"#/components/schemas/type_:EmailIndicatorRating"},"value":{"type":"string"},"description":{"type":"string"}},"required":["type","name","rating","value","description"],"title":"EmailIndicator"},"type_:EmailRating":{"type":"object","properties":{"risk_rating":{"$ref":"#/components/schemas/type_:EmailRatingRiskRating"},"indicators":{"type":"array","items":{"$ref":"#/components/schemas/type_:EmailIndicator"}}},"required":["risk_rating"],"title":"EmailRating"},"type_:EmailAddress":{"type":"object","properties":{"object":{"$ref":"#/components/schemas/type_:EmailAddressObject"},"id":{"type":"string","format":"uuid"},"email":{"type":"string"},"submitted":{"type":"boolean"},"sources":{"type":"array","items":{"$ref":"#/components/schemas/type_:Source"}},"domain":{"type":"string","description":"Domain portion of the email address. Included when email risk data is present."},"valid":{"type":"boolean","description":"Whether the email address is valid. Included when email risk data is present."},"deliverability":{"type":"string","description":"Likelihood that mail sent to this address will be delivered. Included when email risk data is present."},"disposable":{"type":"boolean","description":"Whether the email belongs to a disposable / temporary email service. Included when email risk data is present."},"address_type":{"$ref":"#/components/schemas/type_:EmailAddressAddressType","description":"Classification of the email address. Included when email risk data is present."},"business_id":{"type":"string","format":"uuid","description":"ID of the business the email address is associated with. Included when email risk data is present."},"domain_age":{"type":["string","null"],"format":"date-time","description":"UTC datetime the email's domain was first registered. Included when email risk data is present."},"first_seen":{"type":["string","null"],"format":"date-time","description":"UTC datetime the email was first observed by our data provider. Included when email risk data is present."},"rating":{"$ref":"#/components/schemas/type_:EmailRating"}},"required":["object","id","email","submitted"],"title":"EmailAddress"},"type_:ProfileType":{"type":"string","enum":["facebook","google","yelp","bbb","linkedin"],"title":"ProfileType"},"type_:ProfileMetadataReviewsItem":{"type":"object","properties":{"rating":{"type":"number","format":"double"},"posted_at":{"type":"string","format":"date-time"}},"title":"ProfileMetadataReviewsItem"},"type_:ProfileMetadata":{"type":"object","properties":{"name":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"full_address":{"type":"string"},"website_urls":{"type":"array","items":{"type":"string"}},"latitude":{"type":"number","format":"double"},"longitude":{"type":"number","format":"double"},"phone_number":{"type":"string"},"categories":{"type":"array","items":{"type":"string"}},"reviews":{"type":"array","items":{"$ref":"#/components/schemas/type_:ProfileMetadataReviewsItem"}},"recent_posts":{"type":"array","items":{"type":"object","additionalProperties":{"description":"Any type"}}},"recent_reviews":{"type":"array","items":{"type":"object","additionalProperties":{"description":"Any type"}}}},"title":"ProfileMetadata"},"type_:Profile":{"type":"object","properties":{"object":{"type":"string"},"id":{"type":"string","format":"uuid"},"type":{"$ref":"#/components/schemas/type_:ProfileType"},"external_id":{"type":["string","null"]},"url":{"type":"string","format":"uri"},"metadata":{"$ref":"#/components/schemas/type_:ProfileMetadata"},"rating":{"type":["number","null"],"format":"double"},"rating_count":{"type":["integer","null"]}},"required":["object","id","type","url"],"title":"Profile"},"type_:RegistrationState":{"type":"string","enum":["AL","AK","AZ","AR","CA","CO","CT","DE","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY"],"title":"RegistrationState"},"type_:Registration":{"type":"object","properties":{"object":{"type":"string"},"id":{"type":"string","format":"uuid"},"business_id":{"type":"string","format":"uuid"},"name":{"type":"string"},"status":{"type":"string"},"sub_status":{"type":["string","null"]},"status_details":{"type":["string","null"]},"jurisdiction":{"type":"string"},"entity_type":{"type":"string"},"file_number":{"type":"string"},"addresses":{"type":"array","items":{"type":"string"}},"officers":{"type":"array","items":{"type":"object","additionalProperties":{"description":"Any type"}}},"registered_agent":{"type":"object","additionalProperties":{"description":"Any type"}},"registration_date":{"type":"string","format":"date"},"state":{"$ref":"#/components/schemas/type_:RegistrationState"},"source":{"type":"string","format":"uri"}},"required":["object","id","business_id","name","status","jurisdiction","entity_type","file_number","state"],"title":"Registration"},"type_:IndustryClassificationObject":{"type":"string","enum":["industry_classification"],"title":"IndustryClassificationObject"},"type_:IndustryClassificationStatus":{"type":"string","enum":["pending","completed","failed"],"title":"IndustryClassificationStatus"},"type_:IndustryClassificationCategoriesItemClassificationSystem":{"type":"string","enum":["NAICS","MCC","Prohibited"],"title":"IndustryClassificationCategoriesItemClassificationSystem"},"type_:IndustryClassificationCategoriesItem":{"type":"object","properties":{"classification_system":{"$ref":"#/components/schemas/type_:IndustryClassificationCategoriesItemClassificationSystem"},"name":{"type":"string","description":"Industry name"},"sector":{"type":["string","null"],"description":"Industry sector in CONSTANT_CASE"},"category":{"type":"string","description":"Industry category in CONSTANT_CASE"},"score":{"type":"number","format":"double","description":"Classification confidence score (0.0 to 1.0)"},"high_risk":{"type":"boolean","description":"Whether this industry is considered high risk"},"naics_codes":{"type":"array","items":{"type":"string"},"description":"NAICS (2022) classification codes"},"sic_codes":{"type":"array","items":{"type":"string"},"description":"SIC classification codes"},"mcc_codes":{"type":"array","items":{"type":"string"},"description":"MCC classification codes"},"prohibited_labels":{"type":["array","null"],"items":{"type":"string"},"description":"Prohibited classification labels if applicable"}},"title":"IndustryClassificationCategoriesItem"},"type_:IndustryClassificationWebsiteStatus":{"type":"string","enum":["online","offline","unknown"],"title":"IndustryClassificationWebsiteStatus"},"type_:IndustryClassificationWebsite":{"type":"object","properties":{"status":{"$ref":"#/components/schemas/type_:IndustryClassificationWebsiteStatus"},"parked":{"type":"boolean"}},"title":"IndustryClassificationWebsite"},"type_:IndustryClassification":{"type":"object","properties":{"object":{"$ref":"#/components/schemas/type_:IndustryClassificationObject"},"id":{"type":"string","format":"uuid"},"status":{"$ref":"#/components/schemas/type_:IndustryClassificationStatus"},"categories":{"type":"array","items":{"$ref":"#/components/schemas/type_:IndustryClassificationCategoriesItem"}},"created_at":{"type":"string","format":"date-time"},"completed_at":{"type":["string","null"],"format":"date-time"},"website":{"oneOf":[{"$ref":"#/components/schemas/type_:IndustryClassificationWebsite"},{"type":"null"}]}},"required":["object","id","status","categories","created_at"],"title":"IndustryClassification"},"type_:MonitorEventTypesItemStatus":{"type":"string","enum":["active","unavailable","pending"],"title":"MonitorEventTypesItemStatus"},"type_:MonitorEventTypesItem":{"type":"object","properties":{"type":{"type":"string"},"enabled_at":{"type":["string","null"],"format":"date-time"},"status":{"$ref":"#/components/schemas/type_:MonitorEventTypesItemStatus"}},"title":"MonitorEventTypesItem"},"type_:Monitor":{"type":"object","properties":{"object":{"type":"string"},"id":{"type":"string","format":"uuid"},"created_at":{"type":"string","format":"date-time"},"event_types":{"type":"array","items":{"$ref":"#/components/schemas/type_:MonitorEventTypesItem"}}},"required":["object","id","created_at","event_types"],"title":"Monitor"},"type_:TaxExemptOrganization":{"type":"object","properties":{"object":{"type":"string"},"id":{"type":"string","format":"uuid"},"ein":{"type":"string"},"name":{"type":"string"},"section":{"type":["string","null"]},"ruling_date":{"type":["string","null"],"format":"date"},"tax_period":{"type":["string","null"],"format":"date"},"revoked_at":{"type":["string","null"],"format":"date-time"}},"title":"TaxExemptOrganization"},"type_:FmcsaRegistrationObject":{"type":"string","enum":["fmcsa_registration"],"title":"FmcsaRegistrationObject"},"type_:FmcsaRegistration":{"type":"object","properties":{"object":{"$ref":"#/components/schemas/type_:FmcsaRegistrationObject"},"id":{"type":"string","format":"uuid"},"dot_number":{"type":"string","description":"Department of Transportation (DOT) number"},"legal_name":{"type":"string","description":"Legal name of the carrier"},"dba_name":{"type":["string","null"],"description":"Doing Business As name"},"source":{"type":"string","format":"uri","description":"Source URL for the FMCSA registration data"},"addresses":{"type":"array","items":{"type":"string"},"description":"List of carrier addresses"}},"required":["object","id","dot_number","legal_name","source","addresses"],"title":"FmcsaRegistration"},"type_:LoanObject":{"type":"string","enum":["loan"],"title":"LoanObject"},"type_:LoanDetailsNaicsCode":{"type":"object","properties":{"code":{"type":"integer"},"title":{"type":"string"},"description":{"type":"string"}},"title":"LoanDetailsNaicsCode"},"type_:LoanDetails":{"type":"object","properties":{"gender":{"type":["string","null"]},"veteran":{"type":["string","null"]},"naics_code":{"oneOf":[{"$ref":"#/components/schemas/type_:LoanDetailsNaicsCode"},{"type":"null"}]},"non_profit":{"type":["string","null"]},"business_type":{"type":["string","null"]},"jobs_reported":{"type":["string","null"]},"race_ethnicity":{"type":["string","null"]}},"title":"LoanDetails"},"type_:Loan":{"type":"object","properties":{"object":{"$ref":"#/components/schemas/type_:LoanObject"},"id":{"type":"string","format":"uuid"},"issued_date":{"type":["string","null"],"format":"date"},"amount":{"type":["number","null"],"format":"double"},"lender":{"type":["string","null"]},"details":{"oneOf":[{"$ref":"#/components/schemas/type_:LoanDetails"},{"type":"null"}]}},"required":["object","id"],"title":"Loan"},"type_:PolicyActionResultPolicyAction":{"type":"object","properties":{"id":{"type":"string","description":"Policy action ID"},"action_type":{"type":"string","description":"Type of action"},"options":{"type":"object","additionalProperties":{"description":"Any type"},"description":"Action options"},"policy_version_id":{"type":"string","description":"Policy version ID"}},"title":"PolicyActionResultPolicyAction"},"type_:PolicyActionResult":{"type":"object","properties":{"object":{"type":"string"},"id":{"type":"string","description":"Policy action result ID"},"details":{"type":"object","additionalProperties":{"description":"Any type"},"description":"Action details"},"executed":{"type":"boolean","description":"Execution status"},"policy_action":{"$ref":"#/components/schemas/type_:PolicyActionResultPolicyAction"}},"title":"PolicyActionResult"},"type_:PolicyResult":{"type":"object","properties":{"object":{"type":"string"},"id":{"type":"string","description":"Policy result ID"},"result":{"type":"string","description":"Policy result outcome"},"created_at":{"type":"string","description":"Creation timestamp"},"matched":{"type":["string","null"],"description":"Match status"},"executed":{"type":"boolean","description":"Execution status"},"name":{"type":["string","null"],"description":"Policy name"},"details":{"type":"object","additionalProperties":{"description":"Any type"},"description":"Additional details"},"owner_id":{"type":"string","description":"Owner ID"},"owner_type":{"type":"string","description":"Owner type"},"business_id":{"type":"string","description":"Business ID"},"type_of":{"type":"string","description":"Type of policy result"},"policy_action_results":{"type":"array","items":{"$ref":"#/components/schemas/type_:PolicyActionResult"}}},"title":"PolicyResult"},"type_:PoliticallyExposedPersonScreeningResultsItemObject":{"type":"string","enum":["politically_exposed_person_screening_result"],"title":"PoliticallyExposedPersonScreeningResultsItemObject"},"type_:PoliticallyExposedPersonScreeningResultsItemHitType":{"type":"string","enum":["direct","direct_alias","association"],"title":"PoliticallyExposedPersonScreeningResultsItemHitType"},"type_:PoliticallyExposedPersonScreeningResultsItem":{"type":"object","properties":{"object":{"$ref":"#/components/schemas/type_:PoliticallyExposedPersonScreeningResultsItemObject"},"id":{"type":"string","format":"uuid"},"aliases":{"type":"array","items":{"type":"string"}},"birth_name":{"type":["string","null"]},"birth_place":{"type":["string","null"]},"citizenship_country":{"type":["string","null"]},"dob":{"type":["string","null"]},"employers":{"type":"array","items":{"type":"string"}},"hit_type":{"$ref":"#/components/schemas/type_:PoliticallyExposedPersonScreeningResultsItemHitType"},"memberships":{"type":"array","items":{"type":"object","additionalProperties":{"description":"Any type"}}},"name":{"type":"string"},"professional_history":{"type":"array","items":{"type":"string"}},"score":{"type":"number","format":"double"},"source_urls":{"type":"array","items":{"type":"string"}},"stakeholders":{"type":"array","items":{"type":"object","additionalProperties":{"description":"Any type"}}}},"title":"PoliticallyExposedPersonScreeningResultsItem"},"type_:PoliticallyExposedPersonScreeningSettingsMatchScore":{"type":"string","enum":["LOW","MEDIUM","HIGH"],"title":"PoliticallyExposedPersonScreeningSettingsMatchScore"},"type_:PoliticallyExposedPersonScreeningSettings":{"type":"object","properties":{"people":{"type":"string"},"match_score":{"$ref":"#/components/schemas/type_:PoliticallyExposedPersonScreeningSettingsMatchScore"}},"title":"PoliticallyExposedPersonScreeningSettings"},"type_:PoliticallyExposedPersonScreening":{"type":"object","properties":{"object":{"type":"string"},"id":{"type":"string","format":"uuid"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"results":{"type":"array","items":{"$ref":"#/components/schemas/type_:PoliticallyExposedPersonScreeningResultsItem"}},"settings":{"$ref":"#/components/schemas/type_:PoliticallyExposedPersonScreeningSettings"}},"required":["object","id","created_at","updated_at","results"],"title":"PoliticallyExposedPersonScreening"},"type_:AdverseMediaScreeningResultsItemObject":{"type":"string","enum":["adverse_media_screening_result"],"title":"AdverseMediaScreeningResultsItemObject"},"type_:AdverseMediaScreeningResultsItemItemsItemObject":{"type":"string","enum":["adverse_media_item"],"title":"AdverseMediaScreeningResultsItemItemsItemObject"},"type_:AdverseMediaScreeningResultsItemItemsItemFlagsRisksItemConfidenceLevel":{"type":"string","enum":["low","moderate","high"],"title":"AdverseMediaScreeningResultsItemItemsItemFlagsRisksItemConfidenceLevel"},"type_:AdverseMediaScreeningResultsItemItemsItemFlagsRisksItem":{"type":"object","properties":{"name":{"type":"string"},"confidence_level":{"$ref":"#/components/schemas/type_:AdverseMediaScreeningResultsItemItemsItemFlagsRisksItemConfidenceLevel"}},"title":"AdverseMediaScreeningResultsItemItemsItemFlagsRisksItem"},"type_:AdverseMediaScreeningResultsItemItemsItemFlagsSentimentsItemName":{"type":"string","enum":["positive","negative","neutral"],"title":"AdverseMediaScreeningResultsItemItemsItemFlagsSentimentsItemName"},"type_:AdverseMediaScreeningResultsItemItemsItemFlagsSentimentsItemConfidenceLevel":{"type":"string","enum":["low","moderate","high"],"title":"AdverseMediaScreeningResultsItemItemsItemFlagsSentimentsItemConfidenceLevel"},"type_:AdverseMediaScreeningResultsItemItemsItemFlagsSentimentsItem":{"type":"object","properties":{"name":{"$ref":"#/components/schemas/type_:AdverseMediaScreeningResultsItemItemsItemFlagsSentimentsItemName"},"confidence_level":{"$ref":"#/components/schemas/type_:AdverseMediaScreeningResultsItemItemsItemFlagsSentimentsItemConfidenceLevel"}},"title":"AdverseMediaScreeningResultsItemItemsItemFlagsSentimentsItem"},"type_:AdverseMediaScreeningResultsItemItemsItemFlags":{"type":"object","properties":{"risks":{"type":"array","items":{"$ref":"#/components/schemas/type_:AdverseMediaScreeningResultsItemItemsItemFlagsRisksItem"}},"sentiments":{"type":"array","items":{"$ref":"#/components/schemas/type_:AdverseMediaScreeningResultsItemItemsItemFlagsSentimentsItem"}}},"title":"AdverseMediaScreeningResultsItemItemsItemFlags"},"type_:AdverseMediaScreeningResultsItemItemsItem":{"type":"object","properties":{"object":{"$ref":"#/components/schemas/type_:AdverseMediaScreeningResultsItemItemsItemObject"},"source_name":{"type":"string"},"title":{"type":"string"},"url":{"type":"string","format":"uri"},"flags":{"$ref":"#/components/schemas/type_:AdverseMediaScreeningResultsItemItemsItemFlags"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}},"title":"AdverseMediaScreeningResultsItemItemsItem"},"type_:AdverseMediaScreeningResultsItem":{"type":"object","properties":{"object":{"$ref":"#/components/schemas/type_:AdverseMediaScreeningResultsItemObject"},"id":{"type":"string","format":"uuid"},"risk_scores":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"match_score":{"type":"number","format":"double"},"items":{"type":"array","items":{"$ref":"#/components/schemas/type_:AdverseMediaScreeningResultsItemItemsItem"}}},"title":"AdverseMediaScreeningResultsItem"},"type_:AdverseMediaScreeningExclusionSettings":{"type":"object","properties":{"criteria_match_threshold":{"type":"number","format":"double"},"max_people_screened":{"type":"integer"},"max_names_screened":{"type":"integer"},"people":{"type":"array","items":{"type":"object","additionalProperties":{"description":"Any type"}}}},"title":"AdverseMediaScreeningExclusionSettings"},"type_:AdverseMediaScreening":{"type":"object","properties":{"object":{"type":"string"},"id":{"type":"string","format":"uuid"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"results":{"type":"array","items":{"$ref":"#/components/schemas/type_:AdverseMediaScreeningResultsItem"}},"exclusion_settings":{"$ref":"#/components/schemas/type_:AdverseMediaScreeningExclusionSettings"}},"required":["object","id","created_at","updated_at","results"],"title":"AdverseMediaScreening"},"type_:SignalRequester":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"type":{"type":"string"},"name":{"type":"string"}},"required":["id","type","name"],"title":"SignalRequester"},"type_:SignalReasonsItemCategory":{"type":"string","enum":["identification","verification","evaluation"],"title":"SignalReasonsItemCategory"},"type_:SignalReasonsItemCode":{"type":"string","enum":["I301","I302","I304","I102","I103","I107","I108","I109","I111","I601","I603","I201","I202","I203","I204","V010","V011","V101","V102","V103","V104","V501","V502","V503","V505","V748","V749","V750","V751","V752","V753","V801","V1101","V1201","V1302","E500","E501","E502","E503","E1101","E1102","E1201"],"title":"SignalReasonsItemCode"},"type_:SignalReasonsItem":{"type":"object","properties":{"category":{"$ref":"#/components/schemas/type_:SignalReasonsItemCategory"},"group":{"type":"string"},"description":{"type":"string"},"code":{"$ref":"#/components/schemas/type_:SignalReasonsItemCode"},"importance":{"type":"number","format":"double"}},"required":["category","group","description","code"],"title":"SignalReasonsItem"},"type_:Signal":{"type":"object","properties":{"object":{"type":"string"},"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"tin":{"type":["string","null"]},"external_id":{"type":["string","null"]},"model_slug":{"type":"string"},"score":{"type":["number","null"],"format":"double"},"business_id":{"type":["string","null"],"format":"uuid"},"batch_id":{"type":["string","null"],"format":"uuid"},"requester":{"$ref":"#/components/schemas/type_:SignalRequester"},"reasons":{"type":"array","items":{"$ref":"#/components/schemas/type_:SignalReasonsItem"}},"addresses":{"type":"array","items":{"type":"string"}},"people":{"type":"array","items":{"type":"string"}},"created_at":{"type":"string","format":"date-time"}},"required":["object","id","name","created_at"],"title":"Signal"},"type_:SubmittedAttributeOrdersItem":{"type":"object","properties":{"product":{"type":"string"}},"title":"SubmittedAttributeOrdersItem"},"type_:SubmittedAttribute":{"type":"object","properties":{"object":{"type":"string"},"name":{"type":"string"},"entity_type":{"type":["string","null"]},"addresses":{"type":"array","items":{"type":"object","additionalProperties":{"description":"Any type"}}},"orders":{"type":["array","null"],"items":{"$ref":"#/components/schemas/type_:SubmittedAttributeOrdersItem"}},"people":{"type":"array","items":{"type":"object","additionalProperties":{"description":"Any type"}}},"phone_numbers":{"type":["array","null"],"items":{"type":"object","additionalProperties":{"description":"Any type"}}},"email_addresses":{"type":["array","null"],"items":{"type":"object","additionalProperties":{"description":"Any type"}}},"tags":{"type":["array","null"],"items":{"type":"string"}},"external_id":{"type":["string","null"]},"unique_external_id":{"type":["string","null"]},"tin":{"type":["object","null"],"additionalProperties":{"description":"Any type"}},"website":{"type":["object","null"],"additionalProperties":{"description":"Any type"}},"assignee_id":{"type":["string","null"]},"formation":{"type":["object","null"],"additionalProperties":{"description":"Any type"}},"names":{"type":["array","null"],"items":{"type":"object","additionalProperties":{"description":"Any type"}}},"profiles":{"type":["array","null"],"items":{"type":"object","additionalProperties":{"description":"Any type"}}}},"required":["object","name"],"title":"SubmittedAttribute"},"type_:Subscription":{"type":"object","properties":{"object":{"type":"string"},"id":{"type":"string","format":"uuid"}},"title":"Subscription"},"type_:BusinessSubscriptionAvailabilityBankruptcy":{"type":"string","enum":["subscribable","account_unsubscribable"],"title":"BusinessSubscriptionAvailabilityBankruptcy"},"type_:BusinessSubscriptionAvailabilityCertification":{"type":"string","enum":["subscribable","account_unsubscribable"],"title":"BusinessSubscriptionAvailabilityCertification"},"type_:BusinessSubscriptionAvailabilityRegistration":{"type":"string","enum":["subscribable","account_unsubscribable"],"title":"BusinessSubscriptionAvailabilityRegistration"},"type_:BusinessSubscriptionAvailabilityTin":{"type":"string","enum":["subscribable","account_unsubscribable"],"title":"BusinessSubscriptionAvailabilityTin"},"type_:BusinessSubscriptionAvailabilityWatchlistResult":{"type":"string","enum":["subscribable","account_unsubscribable"],"title":"BusinessSubscriptionAvailabilityWatchlistResult"},"type_:BusinessSubscriptionAvailabilityLien":{"type":"string","enum":["subscribable","account_unsubscribable"],"title":"BusinessSubscriptionAvailabilityLien"},"type_:BusinessSubscriptionAvailability":{"type":"object","properties":{"bankruptcy":{"$ref":"#/components/schemas/type_:BusinessSubscriptionAvailabilityBankruptcy"},"certification":{"$ref":"#/components/schemas/type_:BusinessSubscriptionAvailabilityCertification"},"registration":{"$ref":"#/components/schemas/type_:BusinessSubscriptionAvailabilityRegistration"},"tin":{"$ref":"#/components/schemas/type_:BusinessSubscriptionAvailabilityTin"},"watchlist_result":{"$ref":"#/components/schemas/type_:BusinessSubscriptionAvailabilityWatchlistResult"},"lien":{"$ref":"#/components/schemas/type_:BusinessSubscriptionAvailabilityLien"}},"title":"BusinessSubscriptionAvailability"},"type_:Business":{"type":"object","properties":{"object":{"type":"string"},"id":{"type":"string","format":"uuid"},"external_id":{"type":["string","null"]},"unique_external_id":{"type":["string","null"]},"name":{"type":"string"},"status":{"$ref":"#/components/schemas/type_:BusinessStatus","description":"Current status of the business verification"},"tags":{"type":"array","items":{"type":"string"}},"requester":{"oneOf":[{"$ref":"#/components/schemas/type_:Requester"},{"type":"null"}]},"assignee_id":{"type":["string","null"],"format":"uuid"},"supported_document_types":{"type":"array","items":{"$ref":"#/components/schemas/type_:BusinessSupportedDocumentTypesItem"}},"review":{"oneOf":[{"$ref":"#/components/schemas/type_:Review"},{"type":"null"}]},"tin":{"oneOf":[{"$ref":"#/components/schemas/type_:Tin"},{"type":"null"}]},"business_batch_id":{"type":["string","null"],"format":"uuid"},"formation":{"oneOf":[{"$ref":"#/components/schemas/type_:Formation"},{"type":"null"}]},"website":{"oneOf":[{"$ref":"#/components/schemas/type_:Website"},{"type":"null"}]},"watchlist":{"oneOf":[{"$ref":"#/components/schemas/type_:Watchlist"},{"type":"null"}]},"bankruptcies":{"type":"array","items":{"$ref":"#/components/schemas/type_:Bankruptcy"}},"certifications":{"type":"array","items":{"$ref":"#/components/schemas/type_:Certification"}},"documents":{"type":"array","items":{"$ref":"#/components/schemas/type_:Document"}},"liens":{"type":"array","items":{"$ref":"#/components/schemas/type_:Lien"}},"names":{"type":"array","items":{"$ref":"#/components/schemas/type_:Name"}},"addresses":{"type":"array","items":{"$ref":"#/components/schemas/type_:Address"}},"people":{"type":"array","items":{"$ref":"#/components/schemas/type_:Person"}},"phone_numbers":{"type":"array","items":{"$ref":"#/components/schemas/type_:PhoneNumber"}},"email_addresses":{"type":"array","items":{"$ref":"#/components/schemas/type_:EmailAddress"}},"profiles":{"type":"array","items":{"$ref":"#/components/schemas/type_:Profile"}},"registrations":{"type":"array","items":{"$ref":"#/components/schemas/type_:Registration"}},"orders":{"type":"array","items":{"$ref":"#/components/schemas/type_:Order"}},"industry_classification":{"oneOf":[{"$ref":"#/components/schemas/type_:IndustryClassification"},{"type":"null"}]},"monitor":{"oneOf":[{"$ref":"#/components/schemas/type_:Monitor"},{"type":"null"}]},"tax_exempt_organization":{"oneOf":[{"$ref":"#/components/schemas/type_:TaxExemptOrganization"},{"type":"null"}]},"fmcsa_registrations":{"type":"array","items":{"$ref":"#/components/schemas/type_:FmcsaRegistration"}},"loans":{"type":["array","null"],"items":{"$ref":"#/components/schemas/type_:Loan"}},"litigations":{"type":"array","items":{"$ref":"#/components/schemas/type_:Litigation"}},"policy_results":{"type":"array","items":{"$ref":"#/components/schemas/type_:PolicyResult"}},"politically_exposed_person_screening":{"oneOf":[{"$ref":"#/components/schemas/type_:PoliticallyExposedPersonScreening"},{"type":"null"}]},"adverse_media_screening":{"oneOf":[{"$ref":"#/components/schemas/type_:AdverseMediaScreening"},{"type":"null"}]},"signal":{"oneOf":[{"$ref":"#/components/schemas/type_:Signal"},{"type":"null"}]},"submitted":{"$ref":"#/components/schemas/type_:SubmittedAttribute"},"subscription":{"oneOf":[{"$ref":"#/components/schemas/type_:Subscription"},{"type":"null"}]},"subscription_availability":{"oneOf":[{"$ref":"#/components/schemas/type_:BusinessSubscriptionAvailability"},{"type":"null"}]},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}},"required":["object","id","name","status","created_at","updated_at"],"title":"Business"},"type_:ErrorResponseErrorsItem":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"title":"ErrorResponseErrorsItem"},"type_:ErrorResponse":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/type_:ErrorResponseErrorsItem"}}},"required":["errors"],"title":"ErrorResponse"},"type_businesses:BusinessUpdateParamStatus":{"type":"string","enum":["in_review","approved","rejected"],"description":"Status to set for the business (only final statuses allowed)","title":"BusinessUpdateParamStatus"},"type_businesses:BusinessUpdateParamTin":{"type":"object","properties":{"tin":{"type":"string"}},"title":"BusinessUpdateParamTin"},"type_businesses:BusinessUpdateParamAddressesItem":{"oneOf":[{"$ref":"#/components/schemas/type_:SubmittedAddressFull"},{"$ref":"#/components/schemas/type_:SubmittedAddressComponent"}],"title":"BusinessUpdateParamAddressesItem"},"type_orders:ListOrdersResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/type_:Order"}},"object":{"type":"string"},"has_more":{"type":"boolean"},"total_count":{"type":"integer"}},"required":["object","has_more"],"title":"ListOrdersResponse"},"type_orders:OrderRequestParamProduct":{"type":"string","enum":["identity","liens","adverse_media","bankruptcies","business_enrichment","documents","enhanced_screenings","kyc","litigations","people_litigations","people_bankruptcies","people_tax_liens","people_ucc_liens","people_criminal_history","tin","website","business_verification_qualify","business_verification_verify","tax_liens","ucc_liens","email_risk"],"description":"Product type for the order","title":"OrderRequestParamProduct"},"type_orders:OrderRequestParamSubproductsItem":{"type":"string","enum":["articles_of_incorporation","certificate_of_good_standing","articles_of_incorporation_with_fallback","ucc_documents","web_analysis","industry_classification"],"title":"OrderRequestParamSubproductsItem"},"type_orders:OrderRequestParamOptions":{"type":"object","properties":{"person_match":{"type":"boolean"}},"description":"Additional options for the order","title":"OrderRequestParamOptions"},"type_:BusinessBatchAccount":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"slug":{"type":"string"},"pilot":{"type":"boolean"}},"required":["id","name","slug","pilot"],"title":"BusinessBatchAccount"},"type_:BusinessBatch":{"type":"object","properties":{"object":{"type":"string"},"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"filename":{"type":"string"},"business_count":{"type":"integer"},"completed_business_count":{"type":"integer"},"created_at":{"type":"string","format":"date-time"},"account":{"$ref":"#/components/schemas/type_:BusinessBatchAccount"}},"required":["object","id","name","filename","business_count","completed_business_count","created_at","account"],"title":"BusinessBatch"},"type_businessBatches:ListBusinessBatchesResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/type_:BusinessBatch"}},"object":{"type":"string"},"has_more":{"type":"boolean"},"total_count":{"type":"integer"}},"required":["object","has_more"],"title":"ListBusinessBatchesResponse"},"type_signals:ListSignalsResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/type_:Signal"}},"object":{"type":"string"},"has_more":{"type":"boolean"},"total_count":{"type":"integer"}},"required":["object","has_more"],"title":"ListSignalsResponse"},"type_:MonitoringEventTypesParam":{"type":"object","properties":{"event_types":{"type":"array","items":{"type":"string"},"description":"Array of event types to monitor, or [\"*\"] for all types"}},"required":["event_types"],"title":"MonitoringEventTypesParam"},"type_monitoring:BulkDisableMonitorsParamMonitorTypesItem":{"type":"string","enum":["bankruptcy","certification","registration","tin","watchlist_result","lien"],"title":"BulkDisableMonitorsParamMonitorTypesItem"},"type_liens:LienRequestParamState":{"type":"string","enum":["AL","AK","AZ","AR","CA","CO","CT","DE","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY"],"description":"State where the lien will be filed. Use `state` for a single state or `states` for multiple states. If both are provided, `states` takes precedence.","title":"LienRequestParamState"},"type_liens:LienRequestParamStatesItem":{"type":"string","enum":["AL","AK","AZ","AR","CA","CO","CT","DE","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY"],"title":"LienRequestParamStatesItem"},"type_:LienAddressState":{"type":"string","enum":["AL","AK","AZ","AR","CA","CO","CT","DE","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY"],"title":"LienAddressState"},"type_:LienAddress":{"type":"object","properties":{"address_line1":{"type":"string"},"address_line2":{"type":"string"},"city":{"type":"string"},"state":{"$ref":"#/components/schemas/type_:LienAddressState"},"postal_code":{"type":"string"}},"title":"LienAddress"},"type_liens:LienRequestParamDebtorsItem":{"type":"object","properties":{"organization_name":{"type":"string","description":"Debtor organization name"},"tin":{"type":"string","description":"Tax identification number (required for certain states)"},"addresses":{"type":"array","items":{"$ref":"#/components/schemas/type_:LienAddress"}}},"title":"LienRequestParamDebtorsItem"},"type_liens:LienRequestParamSecuredPartiesItemRole":{"type":"string","enum":["assignee","assignor"],"description":"Role (assignee or assignor)","title":"LienRequestParamSecuredPartiesItemRole"},"type_liens:LienRequestParamSecuredPartiesItem":{"type":"object","properties":{"organization_name":{"type":"string","description":"Secured party organization name"},"role":{"$ref":"#/components/schemas/type_liens:LienRequestParamSecuredPartiesItemRole","description":"Role (assignee or assignor)"},"addresses":{"type":"array","items":{"$ref":"#/components/schemas/type_:LienAddress"}}},"title":"LienRequestParamSecuredPartiesItem"},"type_liens:LienRequestParamSecuredPartyRole":{"type":"string","enum":["assignee","assignor"],"description":"Role (assignee or assignor)","title":"LienRequestParamSecuredPartyRole"},"type_liens:LienRequestParamSecuredParty":{"type":"object","properties":{"organization_name":{"type":"string","description":"Secured party organization name"},"role":{"$ref":"#/components/schemas/type_liens:LienRequestParamSecuredPartyRole","description":"Role (assignee or assignor)"},"addresses":{"type":"array","items":{"$ref":"#/components/schemas/type_:LienAddress"}}},"description":"Single secured party (alternative to secured_parties array)","title":"LienRequestParamSecuredParty"},"type_liens:LienBatchRequestParamLiensItemState":{"type":"string","enum":["AL","AK","AZ","AR","CA","CO","CT","DE","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY"],"description":"State where the lien will be filed","title":"LienBatchRequestParamLiensItemState"},"type_liens:LienBatchRequestParamLiensItemDebtorsItem":{"type":"object","properties":{"organization_name":{"type":"string","description":"Debtor organization name"},"tin":{"type":"string","description":"Tax identification number (required for certain states)"},"addresses":{"type":"array","items":{"$ref":"#/components/schemas/type_:LienAddress"}}},"title":"LienBatchRequestParamLiensItemDebtorsItem"},"type_liens:LienBatchRequestParamLiensItemSecuredPartiesItemRole":{"type":"string","enum":["assignee","assignor"],"title":"LienBatchRequestParamLiensItemSecuredPartiesItemRole"},"type_liens:LienBatchRequestParamLiensItemSecuredPartiesItem":{"type":"object","properties":{"organization_name":{"type":"string"},"role":{"$ref":"#/components/schemas/type_liens:LienBatchRequestParamLiensItemSecuredPartiesItemRole"},"addresses":{"type":"array","items":{"$ref":"#/components/schemas/type_:LienAddress"}}},"title":"LienBatchRequestParamLiensItemSecuredPartiesItem"},"type_liens:LienBatchRequestParamLiensItem":{"type":"object","properties":{"state":{"$ref":"#/components/schemas/type_liens:LienBatchRequestParamLiensItemState","description":"State where the lien will be filed"},"debtors":{"type":"array","items":{"$ref":"#/components/schemas/type_liens:LienBatchRequestParamLiensItemDebtorsItem"},"description":"Array of debtor details"},"secured_parties":{"type":"array","items":{"$ref":"#/components/schemas/type_liens:LienBatchRequestParamLiensItemSecuredPartiesItem"},"description":"Secured party details for this entry. Falls back to account defaults if not provided."},"collateral":{"type":"string","description":"Collateral description. Falls back to account default if not provided."},"loan_principal_amount_cents":{"type":"integer","description":"Loan principal amount in cents"},"packet_number":{"type":"string","description":"Packet number for the filing. Auto-generated if not provided."},"alternative_designation":{"type":"string","description":"Alternative designation (for Tennessee filings)"}},"required":["state","debtors"],"title":"LienBatchRequestParamLiensItem"},"type_:CreateLienFilingsInBatchRequestUnprocessableEntityErrorBody":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"],"title":"CreateLienFilingsInBatchRequestUnprocessableEntityErrorBody"},"type_lienTerminations:CreateLienTerminationResponse":{"type":"object","properties":{"id":{"type":"string","description":"Lien termination ID"},"lien_id":{"type":"string","description":"Associated lien ID"},"status":{"type":"string","description":"Termination status"},"packet_number":{"type":"string","description":"Filing packet number"},"created_at":{"type":"string","description":"Creation timestamp"},"updated_at":{"type":"string","description":"Last update timestamp"}},"title":"CreateLienTerminationResponse"},"type_:PolicyResultsList":{"type":"object","properties":{"object":{"type":"string"},"data":{"type":"array","items":{"$ref":"#/components/schemas/type_:PolicyResult"}},"url":{"type":"string","description":"API endpoint URL"}},"required":["object","data"],"title":"PolicyResultsList"},"type_actions:ListActionsRequestObjectType":{"type":"string","enum":["businesses","watchlist_result"],"title":"ListActionsRequestObjectType"},"type_:ActionType":{"type":"string","enum":["add_sources","add_attributes","update_address_risk","verify_tin","decision","dismissal"],"description":"The action type that was performed","title":"ActionType"},"type_:ActionObjectType":{"type":"string","enum":["Business","Watchlist::Result"],"description":"The type of object the action was performed on","title":"ActionObjectType"},"type_:ActionEffectOperation":{"type":"string","enum":["created","updated","linked"],"description":"The type of change that was made","title":"ActionEffectOperation"},"type_:ActionEffectTarget":{"type":"object","properties":{"object":{"type":"string","description":"The type of the affected resource"},"id":{"type":"string","format":"uuid","description":"The ID of the affected resource"}},"required":["object","id"],"title":"ActionEffectTarget"},"type_:ActionEffect":{"type":"object","properties":{"operation":{"$ref":"#/components/schemas/type_:ActionEffectOperation","description":"The type of change that was made"},"diff":{"type":["object","null"],"additionalProperties":{"description":"Any type"},"description":"Before/after values for each changed field"},"target":{"oneOf":[{"$ref":"#/components/schemas/type_:ActionEffectTarget"},{"type":"null"}]}},"required":["operation","diff","target"],"title":"ActionEffect"},"type_:ActionActorActorType":{"type":"string","enum":["account","user","run"],"description":"The type of actor","title":"ActionActorActorType"},"type_:ActionActor":{"type":"object","properties":{"actor_type":{"$ref":"#/components/schemas/type_:ActionActorActorType","description":"The type of actor"},"data":{"type":"object","additionalProperties":{"description":"Any type"},"description":"Actor details (varies by actor type)"}},"required":["actor_type"],"title":"ActionActor"},"type_:Action":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"type":{"$ref":"#/components/schemas/type_:ActionType","description":"The action type that was performed"},"object_type":{"$ref":"#/components/schemas/type_:ActionObjectType","description":"The type of object the action was performed on"},"object_id":{"type":"string","format":"uuid","description":"The ID of the object the action was performed on"},"created_at":{"type":"string","format":"date-time"},"note":{"type":["string","null"],"description":"Optional text note describing the reason for the action"},"metadata":{"type":"object","additionalProperties":{"description":"Any type"},"description":"Additional metadata associated with the action"},"effects":{"type":"array","items":{"$ref":"#/components/schemas/type_:ActionEffect"},"description":"List of effects describing what changed"},"actors":{"type":"array","items":{"$ref":"#/components/schemas/type_:ActionActor"},"description":"List of actors describing who initiated the action"}},"required":["id","type","object_type","object_id","created_at","effects","actors"],"title":"Action"},"type_actions:ListActionsResponse":{"type":"object","properties":{"object":{"type":"string"},"data":{"type":"array","items":{"$ref":"#/components/schemas/type_:Action"}},"url":{"type":"string"}},"required":["object","data"],"title":"ListActionsResponse"},"type_actions:ActionRequestParamObjectType":{"type":"string","enum":["businesses","watchlist_result"],"description":"Type of object to perform the action on","title":"ActionRequestParamObjectType"},"type_actions:ActionRequestParamType":{"type":"string","enum":["add_sources","add_attributes","verify_tin","decision","dismissal"],"description":"The type of action to perform","title":"ActionRequestParamType"},"type_actions:GetActionRequestObjectType":{"type":"string","enum":["businesses","watchlist_result"],"title":"GetActionRequestObjectType"},"type_:TinMatchAvailability":{"type":"object","properties":{"available":{"type":"boolean","description":"Whether the TIN match service is currently available"}},"required":["available"],"title":"TinMatchAvailability"},"type_:ConnectionConnectingPeopleItem":{"type":"object","properties":{"name":{"type":"string"},"titles":{"type":"array","items":{"type":"string"}},"sources":{"type":"array","items":{"$ref":"#/components/schemas/type_:Source"}}},"title":"ConnectionConnectingPeopleItem"},"type_:ConnectionConnectingAddressesItem":{"type":"object","properties":{"full_address":{"type":"string"},"labels":{"type":"array","items":{"type":"string"}},"sources":{"type":"array","items":{"$ref":"#/components/schemas/type_:Source"}}},"title":"ConnectionConnectingAddressesItem"},"type_:ConnectionConnectingBusinessesItem":{"type":"object","properties":{"name":{"type":"string"},"titles":{"type":"array","items":{"type":"string"}},"sources":{"type":"array","items":{"$ref":"#/components/schemas/type_:Source"}}},"title":"ConnectionConnectingBusinessesItem"},"type_:Connection":{"type":"object","properties":{"object":{"type":"string"},"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"confidence":{"type":"number","format":"double"},"connected_business_id":{"type":["string","null"],"format":"uuid"},"connecting_people":{"type":"array","items":{"$ref":"#/components/schemas/type_:ConnectionConnectingPeopleItem"}},"connecting_addresses":{"type":"array","items":{"$ref":"#/components/schemas/type_:ConnectionConnectingAddressesItem"}},"connecting_businesses":{"type":"array","items":{"$ref":"#/components/schemas/type_:ConnectionConnectingBusinessesItem"}}},"required":["object","id","name","confidence","connecting_people","connecting_addresses","connecting_businesses"],"title":"Connection"},"type_connections:GetV1BusinessesBusinessIdConnectionsResponse":{"type":"object","properties":{"object":{"type":"string"},"data":{"type":"array","items":{"$ref":"#/components/schemas/type_:Connection"}},"url":{"type":"string"},"has_more":{"type":"boolean"},"total_count":{"type":"integer"}},"required":["object","data"],"title":"GetV1BusinessesBusinessIdConnectionsResponse"},"type_:RegistrationRequestState":{"type":"string","enum":["AL","AK","AZ","AR","CA","CO","CT","DE","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY"],"description":"US state abbreviation","title":"RegistrationRequestState"},"type_:RegistrationRequest":{"type":"object","properties":{"object":{"type":"string"},"id":{"type":"string","format":"uuid"},"state":{"$ref":"#/components/schemas/type_:RegistrationRequestState","description":"US state abbreviation"},"status":{"type":"string","description":"Request status"},"tax_registration_types":{"type":["array","null"],"items":{"type":"string"},"description":"Types of tax registrations requested"},"company_id":{"type":"string","format":"uuid"},"external_id":{"type":["string","null"]},"submitted_at":{"type":["string","null"]},"created_at":{"type":"string"},"agencies":{"type":"array","items":{"type":"object","additionalProperties":{"description":"Any type"}},"description":"Tax agency registrations"},"items":{"type":"array","items":{"type":"object","additionalProperties":{"description":"Any type"}},"description":"Registration items"},"tax_registration":{"type":["object","null"],"additionalProperties":{"description":"Any type"},"description":"Tax registration details"},"invite_link":{"type":"string","format":"uri"}},"required":["object","id","state","status","tax_registration_types","company_id","created_at","agencies","items","invite_link"],"title":"RegistrationRequest"},"type_registrationRequests:ListRegistrationRequestsResponse":{"type":"object","properties":{"object":{"type":"string"},"data":{"type":"array","items":{"$ref":"#/components/schemas/type_:RegistrationRequest"}},"url":{"type":"string"}},"title":"ListRegistrationRequestsResponse"},"type_registrationRequests:RegistrationRequestParamState":{"type":"string","enum":["AL","AK","AZ","AR","CA","CO","CT","DE","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY"],"description":"US state abbreviation (required)","title":"RegistrationRequestParamState"},"type_registrationRequests:GetRegistrationRequestGuestDashboardResponse":{"type":"object","properties":{"guest_dashboard_url":{"type":"string","format":"uri"}},"required":["guest_dashboard_url"],"title":"GetRegistrationRequestGuestDashboardResponse"},"type_:AgentInformationRequestContact":{"type":"object","properties":{"first_name":{"type":"string"},"last_name":{"type":"string"},"email":{"type":"string","format":"email"},"phone":{"type":"string"}},"title":"AgentInformationRequestContact"},"type_:AgentInformationRequestCompany":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"legal_name":{"type":["string","null"]},"dba_name":{"type":["string","null"]},"external_id":{"type":["string","null"]}},"required":["id"],"title":"AgentInformationRequestCompany"},"type_:AgentInformationRequest":{"type":"object","properties":{"object":{"type":"string"},"id":{"type":"string","format":"uuid"},"created_at":{"type":"string","format":"date-time"},"url":{"type":["string","null"],"format":"uri"},"information_requested":{"type":"string","description":"Description of what information is required"},"contact":{"$ref":"#/components/schemas/type_:AgentInformationRequestContact"},"company":{"$ref":"#/components/schemas/type_:AgentInformationRequestCompany"}},"required":["object","id","created_at","information_requested","company"],"title":"AgentInformationRequest"},"type_informationRequests:ListInformationRequestsResponse":{"type":"object","properties":{"object":{"type":"string"},"data":{"type":"array","items":{"$ref":"#/components/schemas/type_:AgentInformationRequest"}},"url":{"type":"string"},"has_more":{"type":"boolean"},"count":{"type":"integer"}},"title":"ListInformationRequestsResponse"},"type_applications:CreateApplicationResponse":{"type":"object","properties":{"object":{"type":"string"},"id":{"type":"string","format":"uuid"},"company_id":{"type":"string","format":"uuid"},"status":{"type":"string"},"invite_link":{"type":"string","format":"uri"}},"title":"CreateApplicationResponse"},"type_companies:CreateCompanyRequestAddressesItem":{"type":"object","properties":{"address_line1":{"type":"string"},"address_line2":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"postal_code":{"type":"string"},"address_type":{"type":"string"}},"title":"CreateCompanyRequestAddressesItem"},"type_:AgentCompanyParentAccount":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"slug":{"type":"string"}},"title":"AgentCompanyParentAccount"},"type_:AgentCompany":{"type":"object","properties":{"object":{"type":"string"},"id":{"type":"string","format":"uuid"},"legal_name":{"type":"string","description":"Legal name of the company"},"dba_name":{"type":["string","null"],"description":"Doing business as name"},"external_id":{"type":["string","null"],"description":"External identifier for the company"},"account_id":{"type":"string","format":"uuid","description":"Account ID the company belongs to"},"parent_account":{"$ref":"#/components/schemas/type_:AgentCompanyParentAccount"}},"required":["object","id","legal_name","account_id"],"title":"AgentCompany"},"type_:AgentJurisdiction":{"type":"object","properties":{"object":{"type":"string"},"slug":{"type":"string","description":"Unique identifier for the jurisdiction"},"type":{"type":"string","description":"Type of tax (e.g., City Tax, State Tax)"},"label":{"type":"string","description":"Display label for the jurisdiction"},"name":{"type":"string","description":"Full name of the jurisdiction"},"agency_name":{"type":"string","description":"Name of the tax agency"},"agency_slug":{"type":"string","description":"Unique identifier for the agency"},"agency_items":{"type":"array","items":{"type":"string"},"description":"List of items collected by the agency"},"city":{"type":["string","null"],"description":"City name if applicable"},"state":{"type":"string","description":"US state abbreviation"}},"required":["object","slug","name","state"],"title":"AgentJurisdiction"},"type_jurisdictions:SearchJurisdictionsResponse":{"type":"object","properties":{"object":{"type":"string"},"data":{"type":"array","items":{"$ref":"#/components/schemas/type_:AgentJurisdiction"}},"url":{"type":"string"},"has_more":{"type":"boolean"},"total_count":{"type":"integer"}},"title":"SearchJurisdictionsResponse"},"type_jurisdictions:ListJurisdictionsResponseSearchConfig":{"type":"object","properties":{"hint":{"type":"string"},"help_text":{"type":["string","null"]},"help_url":{"type":["string","null"]}},"title":"ListJurisdictionsResponseSearchConfig"},"type_jurisdictions:ListJurisdictionsResponse":{"type":"object","properties":{"object":{"type":"string"},"data":{"type":"array","items":{"$ref":"#/components/schemas/type_:AgentJurisdiction"}},"search_config":{"oneOf":[{"$ref":"#/components/schemas/type_jurisdictions:ListJurisdictionsResponseSearchConfig"},{"type":"null"}]}},"title":"ListJurisdictionsResponse"},"type_questions:ListQuestionsRequestCategoriesItem":{"type":"string","enum":["state_tax_withholdings","state_unemployment_insurance","foreign_qualification","annual_filing"],"title":"ListQuestionsRequestCategoriesItem"},"type_:AgentQuestionType":{"type":"string","enum":["text","number","date","date_part","select","multiselect","boolean","address","document","account","textarea","phone","officers_table","string"],"description":"Input type for the question.","title":"AgentQuestionType"},"type_:AgentQuestionValidationDateItem":{"type":"object","properties":{"before":{"type":"boolean","description":"If true, the answer must be before the reference date."},"date":{"type":["string","null"],"description":"ISO 8601 timestamp used as the reference date."},"key":{"type":"string","description":"Key of another question whose answer is used as the reference date."},"message":{"type":"string","description":"Error message displayed when validation fails."}},"required":["before"],"title":"AgentQuestionValidationDateItem"},"type_:AgentQuestionValidation":{"type":"object","properties":{"date":{"type":"array","items":{"$ref":"#/components/schemas/type_:AgentQuestionValidationDateItem"},"description":"Array of date-based validation rules."},"format":{"type":"array","items":{"type":"string"},"description":"Array of accepted format patterns for text input."},"min_value":{"type":"integer","description":"Minimum accepted numeric value."}},"description":"Validation rules for the answer.","title":"AgentQuestionValidation"},"type_:AgentQuestionCompanyDependenciesItemItemValue":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"The value to compare against.","title":"AgentQuestionCompanyDependenciesItemItemValue"},"type_:AgentQuestionCompanyDependenciesItemItemComparator":{"type":"string","enum":["==","!=",">","<",">=","<=","starts_with","len_gt","missing_suffix","has_special_chars"],"description":"Comparison operator. Defaults to == (equality). For array values, membership is checked.","title":"AgentQuestionCompanyDependenciesItemItemComparator"},"type_:AgentQuestionCompanyDependenciesItemItem":{"type":"object","properties":{"field":{"type":"string","description":"The company property to evaluate (e.g., entity_type, non_profit, formation_state, household)."},"value":{"$ref":"#/components/schemas/type_:AgentQuestionCompanyDependenciesItemItemValue","description":"The value to compare against."},"comparator":{"oneOf":[{"$ref":"#/components/schemas/type_:AgentQuestionCompanyDependenciesItemItemComparator"},{"type":"null"}],"description":"Comparison operator. Defaults to == (equality). For array values, membership is checked."}},"required":["field","value"],"title":"AgentQuestionCompanyDependenciesItemItem"},"type_:AgentQuestionQuestionDependencyValue":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"The value(s) the dependent question's answer must match.","title":"AgentQuestionQuestionDependencyValue"},"type_:AgentQuestionQuestionDependencyComparator":{"type":"string","enum":["==","!=",">","<",">=","<=","len_gt"],"description":"Comparison operator. Defaults to == (equality).","title":"AgentQuestionQuestionDependencyComparator"},"type_:AgentQuestionQuestionDependency":{"type":"object","properties":{"key":{"type":"string","description":"The key of the question this depends on."},"value":{"$ref":"#/components/schemas/type_:AgentQuestionQuestionDependencyValue","description":"The value(s) the dependent question's answer must match."},"comparator":{"oneOf":[{"$ref":"#/components/schemas/type_:AgentQuestionQuestionDependencyComparator"},{"type":"null"}],"description":"Comparison operator. Defaults to == (equality)."}},"required":["key","value"],"description":"Defines a dependency on another question's answer. The question is only shown when the dependency condition is met.","title":"AgentQuestionQuestionDependency"},"type_:AgentQuestionWarningDateItem":{"type":"object","properties":{"before":{"type":"boolean","description":"If true, warn when the answer is before the reference date."},"date":{"type":["string","null"],"description":"ISO 8601 timestamp used as the reference date."},"key":{"type":"string","description":"Key of another question whose answer is used as the reference date."},"offset_days":{"type":"integer","description":"Number of days to offset from the reference date."},"message":{"type":"string","description":"Warning message displayed to the user."}},"required":["before","message"],"title":"AgentQuestionWarningDateItem"},"type_:AgentQuestionWarning":{"type":"object","properties":{"date":{"type":"array","items":{"$ref":"#/components/schemas/type_:AgentQuestionWarningDateItem"},"description":"Array of date-based warning rules."}},"description":"Warning rules for the question.","title":"AgentQuestionWarning"},"type_:AgentQuestion":{"type":"object","properties":{"key":{"type":"string","description":"Unique identifier for the question. Use this key when submitting answers."},"label":{"type":"string","description":"Human-readable display text for the question."},"type":{"$ref":"#/components/schemas/type_:AgentQuestionType","description":"Input type for the question."},"categories":{"type":["array","null"],"items":{"type":"string"},"description":"Registration types this question applies to."},"optional":{"type":["boolean","null"],"description":"Whether the question is optional."},"validation":{"oneOf":[{"$ref":"#/components/schemas/type_:AgentQuestionValidation"},{"type":"null"}],"description":"Validation rules for the answer."},"company_dependencies":{"type":["array","null"],"items":{"type":"array","items":{"$ref":"#/components/schemas/type_:AgentQuestionCompanyDependenciesItemItem"}},"description":"Conditions under which this question is shown, based on company properties. Each element is an array of conditions that are ANDed together; the outer array elements are ORed. For example, [[{field: A}, {field: B}], [{field: C}]] means (A AND B) OR C."},"options":{"type":["array","null"],"items":{"type":"string"},"description":"Available options for select and multiselect type questions."},"sublabel":{"type":["string","null"],"description":"Additional descriptive text displayed below the question label."},"components":{"type":["array","null"],"items":{"type":"string"},"description":"For date_part type questions, specifies which date components to display."},"question_dependency":{"oneOf":[{"$ref":"#/components/schemas/type_:AgentQuestionQuestionDependency"},{"type":"null"}],"description":"Defines a dependency on another question's answer. The question is only shown when the dependency condition is met."},"warning":{"oneOf":[{"$ref":"#/components/schemas/type_:AgentQuestionWarning"},{"type":"null"}],"description":"Warning rules for the question."},"api_only":{"type":["boolean","null"],"description":"If true, this question is only used for API submissions."},"tooltip":{"type":["string","null"],"description":"Help text displayed in a tooltip alongside the question."},"jurisdiction_slugs":{"type":["array","null"],"items":{"type":"string"},"description":"Jurisdiction slugs this question applies to."},"updated_at":{"type":["string","null"],"description":"Date the question was last updated (YYYY-MM-DD)."},"ai_validated":{"type":["boolean","null"],"description":"Whether the question answer is validated by AI."}},"required":["key","label","type"],"title":"AgentQuestion"},"type_questions:ListQuestionsResponseDataOneItem":{"type":"object","properties":{"state":{"type":"string"},"questions":{"type":"array","items":{"$ref":"#/components/schemas/type_:AgentQuestion"}}},"title":"ListQuestionsResponseDataOneItem"},"type_questions:ListQuestionsResponseData":{"oneOf":[{"type":"array","items":{"$ref":"#/components/schemas/type_:AgentQuestion"}},{"type":"array","items":{"$ref":"#/components/schemas/type_questions:ListQuestionsResponseDataOneItem"}},{"type":"object","additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/type_:AgentQuestion"}}}],"title":"ListQuestionsResponseData"},"type_questions:ListQuestionsResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/type_questions:ListQuestionsResponseData"}},"title":"ListQuestionsResponse"},"type_:AgentMailState":{"type":"string","enum":["AL","AK","AZ","AR","CA","CO","CT","DE","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY"],"description":"State from associated mailable","title":"AgentMailState"},"type_:AgentMailSource":{"type":"object","properties":{"type":{"type":"string","description":"Type of the source object"},"id":{"type":["string","null"],"format":"uuid","description":"ID of the source object"}},"title":"AgentMailSource"},"type_:AgentMailCompany":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"legal_name":{"type":["string","null"]},"dba_name":{"type":["string","null"]},"provider_company_id":{"type":["string","null"]},"external_id":{"type":["string","null"]},"parent_account_name":{"type":["string","null"]}},"title":"AgentMailCompany"},"type_:AgentMail":{"type":"object","properties":{"object":{"type":"string"},"id":{"type":"string","format":"uuid"},"arrived_at":{"type":["string","null"],"format":"date-time"},"external_id":{"type":["string","null"]},"sender_name":{"type":["string","null"]},"recipient_name":{"type":["string","null"]},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"mail_viewed":{"type":"boolean"},"agency_name":{"type":["string","null"]},"tag_names":{"type":"array","items":{"type":"string"},"description":"List of tags associated with the mail item"},"internal_status":{"type":"string","description":"Internal processing status"},"notes":{"type":["string","null"]},"document_url":{"type":["string","null"],"format":"uri"},"summary_payload":{"type":["object","null"],"additionalProperties":{"description":"Any type"}},"suggested_mail_tag":{"type":["string","null"]},"suggested_partner_name":{"type":["string","null"]},"suggested_action_request":{"type":"boolean"},"mailbox_name":{"type":["string","null"]},"registration_request_id":{"type":["string","null"],"format":"uuid"},"state":{"oneOf":[{"$ref":"#/components/schemas/type_:AgentMailState"},{"type":"null"}],"description":"State from associated mailable"},"source":{"$ref":"#/components/schemas/type_:AgentMailSource"},"company":{"$ref":"#/components/schemas/type_:AgentMailCompany"},"document":{"type":["object","null"],"additionalProperties":{"description":"Any type"},"description":"Associated document details"}},"required":["object","id","created_at","updated_at","mail_viewed","tag_names","suggested_action_request","source","company"],"title":"AgentMail"},"type_mail:ListMailItemsResponse":{"type":"object","properties":{"object":{"type":"string"},"data":{"type":"array","items":{"$ref":"#/components/schemas/type_:AgentMail"}},"url":{"type":"string"},"has_more":{"type":"boolean"},"count":{"type":"integer"}},"title":"ListMailItemsResponse"},"type_:AgentsAgent":{"type":"object","properties":{"object":{"type":"string","description":"Object type identifier."},"id":{"type":"string","format":"uuid","description":"Unique identifier for the agent"},"type":{"type":"string","description":"The agent type identifier"},"name":{"type":"string","description":"Human-readable name of the agent"},"description":{"type":"string","description":"Description of the agent's capabilities"},"created_at":{"type":"string","format":"date-time","description":"Timestamp when the agent was created."},"updated_at":{"type":"string","format":"date-time","description":"Timestamp when the agent was last updated."}},"required":["object","id","type","created_at","updated_at"],"description":"An agent that can execute workflows.","title":"AgentsAgent"},"type_agents:ListAgentsResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/type_:AgentsAgent"}}},"required":["data"],"title":"ListAgentsResponse"},"type_:AgentsThreadStatus":{"type":"string","enum":["running","completed","error","interrupted"],"description":"Current lifecycle status of the agent thread.","title":"AgentsThreadStatus"},"type_:AgentsStepType":{"type":"string","enum":["activity","output","interrupt","error"],"description":"Category of step output.","title":"AgentsStepType"},"type_:AgentsStepStatus":{"type":"string","enum":["running","completed","error"],"description":"Current execution status for the step.","title":"AgentsStepStatus"},"type_:AgentsStepResultResolution":{"type":"string","enum":["auto_approve","skip"],"description":"How the interrupt was resolved. Present only on completed interrupt steps when an interrupt policy auto-approved or skipped the interrupt. Absent for manual resolutions.","title":"AgentsStepResultResolution"},"type_:AgentsStepResult":{"type":"object","properties":{"resolution":{"$ref":"#/components/schemas/type_:AgentsStepResultResolution","description":"How the interrupt was resolved. Present only on completed interrupt steps when an interrupt policy auto-approved or skipped the interrupt. Absent for manual resolutions."}},"description":"Structured result payload for the step.","title":"AgentsStepResult"},"type_:AgentsSource":{"type":"object","properties":{"url":{"type":"string","format":"uri","description":"Canonical source URL."},"source_name":{"type":"string","description":"Human-readable source name."},"source_tier":{"type":"string","description":"Source quality or trust tier."},"source_type":{"type":"string","description":"Source category."}},"required":["url"],"description":"A source reference used by an agent artifact.","title":"AgentsSource"},"type_:AgentsArtifact":{"type":"object","properties":{"title":{"type":"string","description":"Human-readable title for the artifact."},"type":{"type":"string","description":"Artifact type identifier."},"confidence":{"type":["string","null"],"description":"Optional confidence label for artifact quality."},"summary":{"type":["string","null"],"description":"Optional summary of the artifact contents."},"sources":{"type":"array","items":{"$ref":"#/components/schemas/type_:AgentsSource"},"description":"Source references used to produce the artifact."}},"required":["title","type"],"description":"A structured artifact produced by an agent step.","title":"AgentsArtifact"},"type_:AgentsStep":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the step."},"run_id":{"type":"string","format":"uuid","description":"Identifier of the agent run that produced the step."},"agent":{"type":"string","description":"Agent identifier that generated this step."},"type":{"$ref":"#/components/schemas/type_:AgentsStepType","description":"Category of step output."},"name":{"type":"string","description":"Internal step name."},"label":{"type":"string","description":"Human-readable step label."},"parent_step_id":{"type":["string","null"],"format":"uuid","description":"Parent step identifier for nested steps."},"status":{"$ref":"#/components/schemas/type_:AgentsStepStatus","description":"Current execution status for the step."},"started_at":{"type":"string","format":"date-time","description":"Timestamp when the step started."},"completed_at":{"type":["string","null"],"format":"date-time","description":"Timestamp when the step completed."},"steps":{"type":"array","items":{"$ref":"#/components/schemas/type_:AgentsStep"},"description":"Nested child steps."},"result":{"$ref":"#/components/schemas/type_:AgentsStepResult","description":"Structured result payload for the step."},"artifacts":{"type":"array","items":{"$ref":"#/components/schemas/type_:AgentsArtifact"},"description":"Artifacts produced by the step."}},"required":["id","run_id","type","name","label","status","started_at"],"description":"A step in an agent workflow execution timeline.","title":"AgentsStep"},"type_:AgentsThread":{"type":"object","properties":{"object":{"type":"string","description":"Object type identifier."},"id":{"type":"string","format":"uuid","description":"Unique identifier for the agent thread."},"created_at":{"type":"string","format":"date-time","description":"Timestamp when the agent thread was created."},"updated_at":{"type":"string","format":"date-time","description":"Timestamp when the agent thread was last updated."},"status":{"$ref":"#/components/schemas/type_:AgentsThreadStatus","description":"Current lifecycle status of the agent thread."},"metadata":{"type":["object","null"],"additionalProperties":{"description":"Any type"},"description":"Internal metadata associated with the agent thread."},"requester":{"type":["object","null"],"additionalProperties":{"description":"Any type"},"description":"Requester context associated with the agent thread."},"steps":{"type":"array","items":{"$ref":"#/components/schemas/type_:AgentsStep"},"description":"Execution steps emitted by the underlying agent state"}},"required":["object","id","created_at","updated_at","status"],"description":"A conversation thread for agent workflows.","title":"AgentsThread"},"type_threads:ListAgentThreadsResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/type_:AgentsThread"}},"object":{"type":"string"},"has_more":{"type":"boolean"},"total_count":{"type":"integer"}},"required":["object","has_more"],"title":"ListAgentThreadsResponse"},"type_:AgentsRunStatus":{"type":"string","enum":["running","completed","error","interrupted"],"description":"Current lifecycle status of the agent run.","title":"AgentsRunStatus"},"type_:AgentsRunRequester":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Identifier of the requesting user or account."},"name":{"type":"string","description":"Display name of the requester."},"email":{"type":["string","null"],"format":"email","description":"Email address of the requester. Populated for user requesters and `null` for account requesters."}},"required":["id","name"],"description":"Principal that initiated the run. Populated with the authenticated user's identity when a session caller initiates the run, and with the account when an API key caller initiates the run. `null` for system-initiated runs.","title":"AgentsRunRequester"},"type_:AgentsRunOutput":{"type":"object","properties":{"artifacts":{"type":"array","items":{"$ref":"#/components/schemas/type_:AgentsArtifact"},"description":"Artifacts produced by the agent during this run."}},"required":["artifacts"],"description":"Artifact envelope produced by the agent. Non-null only when `status` is `completed`; `null` for `running`, `interrupted`, and `error` runs.","title":"AgentsRunOutput"},"type_:AgentsRunInterruptsItem":{"type":"object","properties":{"id":{"type":"string","description":"Identifier of the interrupt request."},"value":{"type":"object","additionalProperties":{"description":"Any type"},"description":"Agent-defined interrupt payload. Shape varies by agent, but typically carries `agent` (the sub-agent that raised the interrupt), `label` (human-readable prompt), and `artifacts` (proposed changes awaiting review). The orchestrator agent (`cip_orchestrator`) wraps sub-agent interrupts under a `proposals` array with `type: combined_proposal`."},"agent":{"type":["string","null"],"description":"Agent type that raised the interrupt. Lifted from `value.agent` and surfaced at the top level for convenience; omitted when the interrupt did not declare an agent."}},"required":["id","value"],"title":"AgentsRunInterruptsItem"},"type_:AgentsRun":{"type":"object","properties":{"object":{"type":"string","description":"Object type identifier."},"id":{"type":"string","format":"uuid","description":"Unique identifier for the agent run."},"created_at":{"type":"string","format":"date-time","description":"Timestamp when the agent run record was created."},"updated_at":{"type":"string","format":"date-time","description":"Timestamp when the agent run record was last updated."},"status":{"$ref":"#/components/schemas/type_:AgentsRunStatus","description":"Current lifecycle status of the agent run."},"thread_id":{"type":"string","format":"uuid","description":"Identifier of the agent thread this run belongs to."},"agent":{"type":"string","description":"Agent type that produced this run (for example, `cip_orchestrator`)."},"requester":{"oneOf":[{"$ref":"#/components/schemas/type_:AgentsRunRequester"},{"type":"null"}],"description":"Principal that initiated the run. Populated with the authenticated user's identity when a session caller initiates the run, and with the account when an API key caller initiates the run. `null` for system-initiated runs."},"started_at":{"type":["string","null"],"format":"date-time","description":"Timestamp when the agent run started."},"ended_at":{"type":["string","null"],"format":"date-time","description":"Timestamp when the agent run finished."},"output":{"oneOf":[{"$ref":"#/components/schemas/type_:AgentsRunOutput"},{"type":"null"}],"description":"Artifact envelope produced by the agent. Non-null only when `status` is `completed`; `null` for `running`, `interrupted`, and `error` runs."},"interrupts":{"type":"array","items":{"$ref":"#/components/schemas/type_:AgentsRunInterruptsItem"},"description":"Pending interrupt requests awaiting input. Empty when the run is not interrupted. To resume a run, POST the interrupt's `id` along with the caller-supplied input to `POST /v1/runs/{id}/resume`."},"steps":{"type":"array","items":{"$ref":"#/components/schemas/type_:AgentsStep"},"description":"Top-level execution steps for this run. Opt-in: pass `?include=steps` on `GET /v1/runs/{id}` (or `POST /v1/runs/{id}/resume`) to populate this field. Omitted by default to avoid the cost of fetching step state from the underlying execution backend."}},"required":["object","id","created_at","updated_at","status"],"description":"A single agent run execution within an agent thread.","title":"AgentsRun"},"type_runs:ListAgentRunsResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/type_:AgentsRun"}},"object":{"type":"string"},"has_more":{"type":"boolean"},"total_count":{"type":"integer"}},"required":["object","has_more"],"title":"ListAgentRunsResponse"},"type_runs:AgentsRunFeedbackRequestParamRating":{"type":"string","enum":["POSITIVE","NEGATIVE"],"description":"Rating value to record for this artifact.","title":"AgentsRunFeedbackRequestParamRating"},"type_:AgentsRunFeedbackRating":{"type":"string","enum":["POSITIVE","NEGATIVE"],"description":"Rating value submitted by the reviewer.","title":"AgentsRunFeedbackRating"},"type_:AgentsRunFeedbackReviewerType":{"type":"string","enum":["User","Account"],"description":"Class of the reviewer record.","title":"AgentsRunFeedbackReviewerType"},"type_:AgentsRunFeedbackReviewer":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/type_:AgentsRunFeedbackReviewerType","description":"Class of the reviewer record."},"id":{"type":"string","format":"uuid","description":"Identifier of the reviewer record."}},"required":["type","id"],"description":"The actor that submitted the feedback. Sidepanel/session callers attribute to a User; API-key callers attribute to the Account.","title":"AgentsRunFeedbackReviewer"},"type_:AgentsRunFeedback":{"type":"object","properties":{"object":{"type":"string","description":"Object type identifier."},"id":{"type":"string","format":"uuid","description":"Unique identifier for the feedback record."},"run_id":{"type":"string","format":"uuid","description":"Identifier of the agent run the feedback is attached to."},"rating":{"$ref":"#/components/schemas/type_:AgentsRunFeedbackRating","description":"Rating value submitted by the reviewer."},"artifact_id":{"type":"string","format":"uuid","description":"Identifier of the artifact within the run that was rated."},"comment":{"type":["string","null"],"description":"Optional free-text comment submitted with the rating."},"reviewer":{"$ref":"#/components/schemas/type_:AgentsRunFeedbackReviewer","description":"The actor that submitted the feedback. Sidepanel/session callers attribute to a User; API-key callers attribute to the Account."},"superseded_prior":{"type":"boolean","description":"True if a prior active rating from the same reviewer for the same (run, artifact) tuple was superseded by this new rating."},"created_at":{"type":"string","format":"date-time","description":"Timestamp when the feedback was created."}},"required":["object","id","run_id","rating","artifact_id","comment","reviewer","superseded_prior","created_at"],"description":"POSITIVE or NEGATIVE rating on an agent run artifact.","title":"AgentsRunFeedback"},"type_identities:BusinessIdentityRequestParamEntityType":{"type":"string","enum":["LLC","CORPORATION","NON_PROFIT","PARTNERSHIP","TRUST"],"description":"Entity type filter","title":"BusinessIdentityRequestParamEntityType"},"type_identities:BusinessIdentityRequestParamAddressesItem":{"type":"object","properties":{"address_line1":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"postal_code":{"type":"string"}},"title":"BusinessIdentityRequestParamAddressesItem"},"type_:BusinessIdentityNamesItemType":{"type":"string","enum":["legal","dba"],"title":"BusinessIdentityNamesItemType"},"type_:BusinessIdentityNamesItem":{"type":"object","properties":{"name":{"type":"string"},"type":{"$ref":"#/components/schemas/type_:BusinessIdentityNamesItemType"}},"title":"BusinessIdentityNamesItem"},"type_:BusinessIdentityAddressesItem":{"type":"object","properties":{"full_address":{"type":"string"},"address_line1":{"type":"string"},"address_line2":{"type":["string","null"]},"city":{"type":"string"},"state":{"type":"string"},"postal_code":{"type":"string"},"labels":{"type":"array","items":{"type":"string"}}},"title":"BusinessIdentityAddressesItem"},"type_:BusinessIdentityPeopleItem":{"type":"object","properties":{"name":{"type":"string"},"titles":{"type":"array","items":{"type":"string"}}},"title":"BusinessIdentityPeopleItem"},"type_:BusinessIdentityEntityType":{"type":"string","enum":["LLC","CORPORATION","NON_PROFIT","PARTNERSHIP","TRUST"],"description":"Business entity type","title":"BusinessIdentityEntityType"},"type_:BusinessIdentity":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for this autocomplete result"},"names":{"type":"array","items":{"$ref":"#/components/schemas/type_:BusinessIdentityNamesItem"},"description":"Business names (legal or DBA)"},"addresses":{"type":"array","items":{"$ref":"#/components/schemas/type_:BusinessIdentityAddressesItem"},"description":"Known business addresses"},"people":{"type":"array","items":{"$ref":"#/components/schemas/type_:BusinessIdentityPeopleItem"},"description":"Associated persons"},"entity_type":{"oneOf":[{"$ref":"#/components/schemas/type_:BusinessIdentityEntityType"},{"type":"null"}],"description":"Business entity type"}},"description":"Business result from autocomplete search","title":"BusinessIdentity"},"type_:BusinessIdentityList":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/type_:BusinessIdentity"}}},"description":"List of business identity autocomplete results","title":"BusinessIdentityList"},"type_:PrefillBusinessNamesItemType":{"type":"string","enum":["legal","dba"],"title":"PrefillBusinessNamesItemType"},"type_:PrefillBusinessNamesItem":{"type":"object","properties":{"name":{"type":"string"},"type":{"oneOf":[{"$ref":"#/components/schemas/type_:PrefillBusinessNamesItemType"},{"type":"null"}]}},"title":"PrefillBusinessNamesItem"},"type_:PrefillBusinessAddressesItem":{"type":"object","properties":{"full_address":{"type":"string"},"address_line1":{"type":"string"},"address_line2":{"type":["string","null"]},"city":{"type":"string"},"state":{"type":"string"},"postal_code":{"type":"string"},"labels":{"type":"array","items":{"type":"string"}}},"title":"PrefillBusinessAddressesItem"},"type_:PrefillBusinessTin":{"type":"object","properties":{"last_four":{"type":"string","description":"Last four digits of the TIN"},"tin_type":{"type":"string","description":"Type of TIN (EIN, SSN, etc.)"}},"description":"TIN information if verified","title":"PrefillBusinessTin"},"type_:PrefillBusinessFormation":{"type":"object","properties":{"entity_type":{"type":["string","null"]}},"description":"Formation details","title":"PrefillBusinessFormation"},"type_:PrefillBusinessIndustryClassificationsItem":{"type":"object","properties":{"name":{"type":"string"},"score":{"type":"number","format":"double"},"sector":{"type":["string","null"]},"category":{"type":["string","null"]},"high_risk":{"type":"boolean"},"mcc_codes":{"type":["array","null"],"items":{"type":"string"}},"sic_codes":{"type":["array","null"],"items":{"type":"string"}},"naics_codes":{"type":["array","null"],"items":{"type":"string"}},"prohibited_labels":{"type":"array","items":{"type":"string"}},"classification_system":{"type":"string"}},"title":"PrefillBusinessIndustryClassificationsItem"},"type_:PrefillBusinessPeopleItem":{"type":"object","properties":{"name":{"type":"string"},"titles":{"type":"array","items":{"type":"string"}}},"title":"PrefillBusinessPeopleItem"},"type_:PrefillBusinessWebsite":{"type":"object","properties":{"url":{"type":"string"}},"description":"Website information","title":"PrefillBusinessWebsite"},"type_:PrefillBusiness":{"type":"object","properties":{"object":{"type":"string"},"names":{"type":"array","items":{"$ref":"#/components/schemas/type_:PrefillBusinessNamesItem"},"description":"Business names"},"addresses":{"type":"array","items":{"$ref":"#/components/schemas/type_:PrefillBusinessAddressesItem"},"description":"Business addresses"},"tin":{"oneOf":[{"$ref":"#/components/schemas/type_:PrefillBusinessTin"},{"type":"null"}],"description":"TIN information if verified"},"formation":{"$ref":"#/components/schemas/type_:PrefillBusinessFormation","description":"Formation details"},"industry_classifications":{"type":["array","null"],"items":{"$ref":"#/components/schemas/type_:PrefillBusinessIndustryClassificationsItem"},"description":"Industry classifications"},"people":{"type":"array","items":{"$ref":"#/components/schemas/type_:PrefillBusinessPeopleItem"},"description":"Associated persons"},"website":{"oneOf":[{"$ref":"#/components/schemas/type_:PrefillBusinessWebsite"},{"type":"null"}],"description":"Website information"}},"description":"Prefilled business information","title":"PrefillBusiness"},"type_webhooks:WebhookCreateParamOidcAuthMethod":{"type":"string","enum":["private_key_jwt","client_secret"],"description":"OIDC authentication method for obtaining access tokens. Required when configuring OIDC. 'private_key_jwt' — requires oidc_client_id, oidc_token_endpoint, oidc_access_token_ttl_seconds. 'client_secret' — requires oidc_client_id, oidc_client_secret, oidc_token_endpoint, oidc_access_token_ttl_seconds. Both methods optionally accept oidc_scope and oidc_resource_uri.","title":"WebhookCreateParamOidcAuthMethod"},"type_webhooks:WebhookUpdateParamOidcAuthMethod":{"type":"string","enum":["private_key_jwt","client_secret"],"description":"OIDC authentication method for obtaining access tokens. Required when configuring OIDC. 'private_key_jwt' — requires oidc_client_id, oidc_token_endpoint, oidc_access_token_ttl_seconds. 'client_secret' — requires oidc_client_id, oidc_client_secret, oidc_token_endpoint, oidc_access_token_ttl_seconds. Both methods optionally accept oidc_scope and oidc_resource_uri.","title":"WebhookUpdateParamOidcAuthMethod"},"type_:OidcKeyKeysItem":{"type":"object","properties":{"kty":{"type":"string","description":"Key type"},"use":{"type":"string","description":"Key usage"},"alg":{"type":"string","description":"Algorithm"},"kid":{"type":"string","description":"Key ID"},"x5t":{"type":"string","description":"X.509 certificate thumbprint"},"n":{"type":"string","description":"RSA modulus"},"e":{"type":"string","description":"RSA public exponent"},"x5c":{"type":"array","items":{"type":"string"},"description":"X.509 certificate chain"}},"title":"OidcKeyKeysItem"},"type_:OidcKey":{"type":"object","properties":{"keys":{"type":"array","items":{"$ref":"#/components/schemas/type_:OidcKeyKeysItem"}}},"required":["keys"],"title":"OidcKey"},"type_documents:ListDocumentsResponse":{"type":"object","properties":{"object":{"type":"string"},"data":{"type":"array","items":{"$ref":"#/components/schemas/type_:Document"}}},"title":"ListDocumentsResponse"},"type_documents:GetDocumentDownloadUrlResponse":{"type":"object","properties":{"data":{"type":"string","format":"uri"}},"title":"GetDocumentDownloadUrlResponse"}},"securitySchemes":{"bearer_auth":{"type":"http","scheme":"bearer"}}}}