Identifier of the event that triggered this webhook. It stays the same when a delivery is retried, so you can use it to deduplicate. Treat it as an opaque string; its format varies by event type.
{"docsConfig":{"theme":"luma","$schema":"https://mintlify.com/docs.json","name":"The Guarantors API","description":"Developer documentation for TheGuarantors Embed API: invites, applications, bonds, webhooks and the sandbox.","colors":{"primary":"#3DB157","light":"#3DB157","dark":"#3DB157"},"logo":{"light":"https://mintcdn.com/theguarantors-2e3c1083/1COSbAUD3YqBCY97/images/logo/light.svg?fit=max\u0026auto=format\u0026n=1COSbAUD3YqBCY97\u0026q=85\u0026s=90090207d22f93a49206278f09bbbff7","dark":"https://mintcdn.com/theguarantors-2e3c1083/1COSbAUD3YqBCY97/images/logo/dark.svg?fit=max\u0026auto=format\u0026n=1COSbAUD3YqBCY97\u0026q=85\u0026s=7bc091265f808f82f21f214c0ea22d2f"},"favicon":"https://mintcdn.com/theguarantors-2e3c1083/1COSbAUD3YqBCY97/images/logo/favicon.png?fit=max\u0026auto=format\u0026n=1COSbAUD3YqBCY97\u0026q=85\u0026s=73fef4218af15ee58b6e5ad76682046c","footer":{"socials":{"linkedin":"https://www.linkedin.com/company/the-guarantors","x":"https://twitter.com/The_Guarantors","facebook":"https://www.facebook.com/TheGuarantors","instagram":"https://www.instagram.com/theguarantors"},"links":[{"header":" ","items":[{"label":"Privacy Policy","href":"https://www.theguarantors.com/privacy"},{"label":"Terms of Service","href":"https://www.theguarantors.com/terms"},{"label":"Legal / Regulatory Notice","href":"https://www.theguarantors.com/legal-regulatory"}]},{"header":" ","items":[{"label":"Notice of Collection","href":"https://www.theguarantors.com/notice-of-collection"},{"label":"Trust Center","href":"https://trust.theguarantors.com"}]}]},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"theguarantors-2e3c1083","hasAudioNarration":false,"actualSubdomain":"theguarantors-2e3c1083","customDomains":["docs.theguarantors.com"],"gitSource":{"type":"github","owner":"theguarantors","repo":"tg-edge-service","deployBranch":"main","contentDirectory":"docs","isPrivate":true,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"REMOVE_BRANDING":{"status":"ENABLED"},"CONTEXTUAL_FEEDBACK":{"status":"ENABLED"},"CODE_SNIPPET_FEEDBACK":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6af20a0d60eda55d1f7e6246","clientVersion":"0.0.4094","searchFilterCounts":[{"language":"default","tag":"API Reference","count":40},{"language":"default","tag":"Application API","count":30},{"language":"default","tag":"Docs","count":12},{"language":"default","tag":"Schemas","count":10},{"language":"default","tag":"Applications","count":9},{"language":"default","tag":"Invites","count":7},{"language":"default","tag":"Core Concepts","count":6},{"language":"default","tag":"Invite Recipients","count":6},{"language":"default","tag":"Bonds","count":4},{"language":"default","tag":"Applicants","count":3}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"#content-area table td:first-child code{white-space:nowrap;overflow-wrap:normal}"}],"page":{"pagePath":"application-api/bonds/bondstatuscanceled","slug":"/application-api/bonds/bondstatuscanceled","pageMetadata":{"title":"bond.status.canceled","description":"An issued bond is canceled.","version":null,"deprecated":null,"sidebarTitle":"bond.status.canceled","openapi":"/openapi/application-api.json webhook bond.status.canceled","href":"/application-api/bonds/bondstatuscanceled","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"An issued bond is canceled.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"bond.status.canceled","description":"An issued bond is canceled.","version":null,"deprecated":null,"sidebarTitle":"bond.status.canceled","openapi":"/openapi/application-api.json webhook bond.status.canceled","href":"/application-api/bonds/bondstatuscanceled","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Bonds"],"summary":"bond.status.canceled","description":"An issued bond is canceled.","x-mint":{"metadata":{"title":"bond.status.canceled","sidebarTitle":"bond.status.canceled"}},"requestBody":"51edee65-75b0-4d8d-a6a6-cdb83c7a5dde","responses":{"200":"3e1b5d96-73f5-490e-a96f-fd368a7b2d8d"},"method":"post","type":"webhook","servers":["4c923e28-1932-4d68-820c-f5aa1183a0de"],"security":[],"path":"bond.status.canceled","baseUrlOptions":["https://api.theguarantors.com"],"title":"bond.status.canceled","codeSamples":[],"requiredOnlyExamples":false,"requestExamples":[{"language":"json","filename":"Example1","code":"{\n \"event_id\": \"48221047\",\n \"event_type\": \"bond.status.canceled\",\n \"occurred_at\": \"2025-07-28T18:27:54.690Z\",\n \"data\": {\n \"bond\": {\n \"id\": \"bond_7f29djw82kdpq9sl\",\n \"application_id\": \"sd_3k29dls92jf83kdl\",\n \"bond_number\": \"LG-2026-000123\",\n \"status\": \"canceled\",\n \"document_link\": \"https://api.theguarantors.com/v1/bonds/bond_7f29djw82kdpq9sl/document?token=v1.xxxxx\",\n \"obligee\": \"Acme Property Management LLC\",\n \"lease\": {\n \"start_date\": \"2026-03-01\",\n \"end_date\": \"2027-02-28\",\n \"monthly_rent\": 320000,\n \"unit_address\": {\n \"line1\": \"123 Main St\",\n \"line2\": \"Apt 5B\",\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"postal_code\": \"10001\",\n \"object\": \"address\"\n },\n \"object\": \"lease\"\n },\n \"principals\": [\n {\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"email\": \"jane.doe@example.com\",\n \"phone_number\": \"+12125551234\",\n \"applicant_id\": \"applc_e91hmctvoraymdpu\",\n \"object\": \"principal\"\n }\n ],\n \"coverage\": {\n \"lease_guarantee\": {\n \"coverage_unit\": \"months\",\n \"coverage_amount\": 12\n },\n \"security_deposit_replacement\": {\n \"coverage_unit\": \"months\",\n \"coverage_amount\": 1\n },\n \"object\": \"coverage\"\n },\n \"last_updated\": \"2026-03-15T14:15:22Z\",\n \"metadata\": {},\n \"object\": \"bond\"\n }\n }\n}"}],"requestExampleType":"webhook","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["event_id","event_type","occurred_at","data"],"properties":{"event_id":{"type":"string","description":"Identifier of the event that triggered this webhook. It stays the same when a delivery is retried, so you can use it to deduplicate. Treat it as an opaque string; its format varies by event type.","isRequired":true,"uniqueKey":"event_id","typeLabel":"string"},"event_type":{"type":"string","description":"Denotes the resource and what happened to it.","default":"bond.status.canceled","isRequired":true,"uniqueKey":"event_type","typeLabel":"string"},"occurred_at":{"type":"string","format":"date-time","example":"2025-07-28T18:27:54.690Z","description":"UTC timestamp when the source event occurred.","isRequired":true,"uniqueKey":"occurred_at","typeLabel":"string\u003cdate-time>"},"data":{"type":"object","additionalProperties":true,"properties":{"bond":{"type":"object","required":["application_id","bond_number","coverage","id","last_updated","lease","object","principals","property_id","status"],"properties":{"application_id":{"type":"string","example":"sd_01HQ8Z","isRequired":true,"uniqueKey":"data.bond.application_id","typeLabel":"string"},"bond_number":{"type":"string","example":"TG-2026-004182","isRequired":true,"uniqueKey":"data.bond.bond_number","typeLabel":"string"},"coverage":{"type":"object","description":"Defines the amount of rent and/or security deposit replacement for the surety bond.","required":["lease_guarantee","object","security_deposit_replacement"],"properties":{"lease_guarantee":{"type":"object","required":["coverage_amount","coverage_unit"],"properties":{"coverage_amount":{"type":"number","example":1,"isRequired":true,"uniqueKey":"data.bond.coverage.lease_guarantee.coverage_amount","typeLabel":"number"},"coverage_unit":{"type":"string","enum":["months","percentage_of_lease_length","amount"],"x-enum-varnames":["COVERAGE_UNIT_MONTHS","COVERAGE_UNIT_PROPORTION","COVERAGE_UNIT_AMOUNT"],"example":"months","isRequired":true,"uniqueKey":"data.bond.coverage.lease_guarantee.coverage_unit","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"data.bond.coverage.lease_guarantee","typeLabel":"object"},"object":{"type":"string","example":"coverage","isRequired":true,"uniqueKey":"data.bond.coverage.object","typeLabel":"string"},"security_deposit_replacement":{"type":"object","required":["coverage_amount","coverage_unit"],"properties":{"coverage_amount":{"type":"number","example":1,"isRequired":true,"uniqueKey":"data.bond.coverage.security_deposit_replacement.coverage_amount","typeLabel":"number"},"coverage_unit":{"type":"string","enum":["months","percentage_of_lease_length","amount"],"x-enum-varnames":["COVERAGE_UNIT_MONTHS","COVERAGE_UNIT_PROPORTION","COVERAGE_UNIT_AMOUNT"],"example":"months","isRequired":true,"uniqueKey":"data.bond.coverage.security_deposit_replacement.coverage_unit","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"data.bond.coverage.security_deposit_replacement","typeLabel":"object"}},"isRequired":true,"uniqueKey":"data.bond.coverage","typeLabel":"object"},"id":{"type":"string","example":"bond_01HQAB","isRequired":true,"uniqueKey":"data.bond.id","typeLabel":"string"},"last_updated":{"type":"string","format":"date-time","example":"2026-03-15T14:15:22Z","isRequired":true,"uniqueKey":"data.bond.last_updated","typeLabel":"string\u003cdate-time>"},"lease":{"type":"object","description":"The legal contract between a property manager and the tenant. A lease agreement contains information about the property, the address and duration of the lease, and financial terms like rent amount and security deposit information. Leases map 1:1 with TheGuarantors surety bonds. A single lease can have one or more applicants.","required":["monthly_rent","object","unit_address"],"properties":{"monthly_rent":{"description":"Monthly rent in cents.","type":"integer","minimum":1,"example":280000,"isRequired":true,"uniqueKey":"data.bond.lease.monthly_rent","typeLabel":"integer"},"object":{"type":"string","example":"lease","isRequired":true,"uniqueKey":"data.bond.lease.object","typeLabel":"string"},"unit_address":{"type":"object","description":"The unit address that would be printed on the lease, and therefore the Lease Guarantee surety bond. If you do not store the address with separate address line 1s and address line 2, put the full unit address in the address line 1.","required":["city","line1","object","postal_code","state"],"properties":{"city":{"description":"City which this address is located in","type":"string","example":"Brooklyn","isRequired":true,"uniqueKey":"data.bond.lease.unit_address.city","typeLabel":"string"},"line1":{"description":"Address line 1","type":"string","example":"412 Halsey St","isRequired":true,"uniqueKey":"data.bond.lease.unit_address.line1","typeLabel":"string"},"object":{"type":"string","example":"address","isRequired":true,"uniqueKey":"data.bond.lease.unit_address.object","typeLabel":"string"},"postal_code":{"description":"Postal or Zip code for this address","type":"string","example":"11233","isRequired":true,"uniqueKey":"data.bond.lease.unit_address.postal_code","typeLabel":"string"},"state":{"description":"State which this address is located in","type":"string","example":"NY","isRequired":true,"uniqueKey":"data.bond.lease.unit_address.state","typeLabel":"string"},"line2":{"oneOf":[{"description":"Address line 2","type":"string","example":"Apt 3R","uniqueKey":"data.bond.lease.unit_address.line2.oneOf.0","typeLabel":"string"},{"description":"Address line 2","type":"null","example":"Apt 3R","uniqueKey":"data.bond.lease.unit_address.line2.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.bond.lease.unit_address.line2","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"data.bond.lease.unit_address","typeLabel":"object"},"end_date":{"oneOf":[{"description":"The date when this lease expires.","type":"string","format":"date","example":"2027-08-31","uniqueKey":"data.bond.lease.end_date.oneOf.0","typeLabel":"string\u003cdate>"},{"description":"The date when this lease expires.","type":"null","format":"date","example":"2027-08-31","uniqueKey":"data.bond.lease.end_date.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.bond.lease.end_date","typeLabel":"string\u003cdate> | null"},"start_date":{"oneOf":[{"description":"The date when this lease takes effect.","type":"string","format":"date","example":"2026-09-01","uniqueKey":"data.bond.lease.start_date.oneOf.0","typeLabel":"string\u003cdate>"},{"description":"The date when this lease takes effect.","type":"null","format":"date","example":"2026-09-01","uniqueKey":"data.bond.lease.start_date.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.bond.lease.start_date","typeLabel":"string\u003cdate> | null"}},"isRequired":true,"uniqueKey":"data.bond.lease","typeLabel":"object"},"object":{"type":"string","example":"bond","isRequired":true,"uniqueKey":"data.bond.object","typeLabel":"string"},"principals":{"type":"array","items":{"type":"object","required":["applicant_id","email","first_name","last_name","object"],"properties":{"applicant_id":{"type":"string","example":"applc_01HQ9A","isRequired":true,"uniqueKey":"data.bond.principals.items.[INDEX].applicant_id","typeLabel":"string"},"email":{"type":"string","example":"dana.whitfield@example.com","isRequired":true,"uniqueKey":"data.bond.principals.items.[INDEX].email","typeLabel":"string"},"first_name":{"type":"string","example":"Dana","isRequired":true,"uniqueKey":"data.bond.principals.items.[INDEX].first_name","typeLabel":"string"},"last_name":{"type":"string","example":"Whitfield","isRequired":true,"uniqueKey":"data.bond.principals.items.[INDEX].last_name","typeLabel":"string"},"object":{"type":"string","example":"principal","isRequired":true,"uniqueKey":"data.bond.principals.items.[INDEX].object","typeLabel":"string"},"phone_number":{"oneOf":[{"type":"string","example":"+15551234567","uniqueKey":"data.bond.principals.items.[INDEX].phone_number.oneOf.0","typeLabel":"string"},{"type":"null","example":"+15551234567","uniqueKey":"data.bond.principals.items.[INDEX].phone_number.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.bond.principals.items.[INDEX].phone_number","typeLabel":"string | null"}},"uniqueKey":"data.bond.principals.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"data.bond.principals","typeLabel":"object[]"},"property_id":{"type":"string","example":"prop_01HQ7A","isRequired":true,"uniqueKey":"data.bond.property_id","typeLabel":"string"},"status":{"type":"string","enum":["issued","canceled"],"x-enum-varnames":["BOND_ISSUED","BOND_CANCELED"],"example":"issued","isRequired":true,"uniqueKey":"data.bond.status","typeLabel":"enum\u003cstring>"},"document_link":{"oneOf":[{"description":"A URL that returns the bond's PDF with a plain GET. No API key is needed.\nThe link is long-lived; if one ever stops working, fetch the bond again for a fresh link.\nTreat it as private, and don't parse or build it yourself. `null` when no PDF exists yet.\n\n**Downloading bond PDFs**\n\n| Status | Meaning |\n| --- | --- |\n| `200` | The bond's PDF, returned as `application/pdf`. |\n| `403` | The link is invalid. |\n| `404` | No PDF exists for this bond yet. |\n| `502`, `504` | The PDF couldn't be fetched right now. Try again later. |","type":"string","example":"https://api.theguarantors.com/v1/bonds/bond_7f29djw82kdpq9sl/document?token=v1.xxxxx","uniqueKey":"data.bond.document_link.oneOf.0","typeLabel":"string"},{"description":"A URL that returns the bond's PDF with a plain GET. No API key is needed.\nThe link is long-lived; if one ever stops working, fetch the bond again for a fresh link.\nTreat it as private, and don't parse or build it yourself. `null` when no PDF exists yet.\n\n**Downloading bond PDFs**\n\n| Status | Meaning |\n| --- | --- |\n| `200` | The bond's PDF, returned as `application/pdf`. |\n| `403` | The link is invalid. |\n| `404` | No PDF exists for this bond yet. |\n| `502`, `504` | The PDF couldn't be fetched right now. Try again later. |","type":"null","example":"https://api.theguarantors.com/v1/bonds/bond_7f29djw82kdpq9sl/document?token=v1.xxxxx","uniqueKey":"data.bond.document_link.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.bond.document_link","typeLabel":"string | null"},"metadata":{"oneOf":[{"description":"Key-value object. Use this field to include internal references, identifiers, or any additional data that helps link this lease to your internal system. Each key must be a string, and values can be strings, numbers, booleans, or null.","type":"object","uniqueKey":"data.bond.metadata.oneOf.0","typeLabel":"object"},{"description":"Key-value object. Use this field to include internal references, identifiers, or any additional data that helps link this lease to your internal system. Each key must be a string, and values can be strings, numbers, booleans, or null.","type":"null","uniqueKey":"data.bond.metadata.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.bond.metadata","typeLabel":"object | null"},"obligee":{"oneOf":[{"description":"The party that will be the obligee/claimant on the surety bond. This can be a limited liability company (LLC), a property management company, the property name, or the legal name of a sole proprietor owner.","type":"string","example":"Rivermark Residential LLC","uniqueKey":"data.bond.obligee.oneOf.0","typeLabel":"string"},{"description":"The party that will be the obligee/claimant on the surety bond. This can be a limited liability company (LLC), a property management company, the property name, or the legal name of a sole proprietor owner.","type":"null","example":"Rivermark Residential LLC","uniqueKey":"data.bond.obligee.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.bond.obligee","typeLabel":"string | null"},"penal_sum":{"oneOf":[{"description":"The maximum amount payable under the bond in cents. Calculated as monthly_rent*(lg_num_months_covered + sdr_num_months_covered)","type":"integer","example":560000,"uniqueKey":"data.bond.penal_sum.oneOf.0","typeLabel":"integer"},{"description":"The maximum amount payable under the bond in cents. Calculated as monthly_rent*(lg_num_months_covered + sdr_num_months_covered)","type":"null","example":560000,"uniqueKey":"data.bond.penal_sum.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.bond.penal_sum","typeLabel":"integer | null"},"premium":{"oneOf":[{"description":"The amount charged to the tenant for the bond in cents.","type":"integer","example":42000,"uniqueKey":"data.bond.premium.oneOf.0","typeLabel":"integer"},{"description":"The amount charged to the tenant for the bond in cents.","type":"null","example":42000,"uniqueKey":"data.bond.premium.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.bond.premium","typeLabel":"integer | null"}},"uniqueKey":"data.bond","typeLabel":"object"}},"isRequired":true,"uniqueKey":"data","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example1":{"title":"Example1","value":{"event_id":"48221047","event_type":"bond.status.canceled","occurred_at":"2025-07-28T18:27:54.690Z","data":{"bond":{"id":"bond_7f29djw82kdpq9sl","application_id":"sd_3k29dls92jf83kdl","bond_number":"LG-2026-000123","status":"canceled","document_link":"https://api.theguarantors.com/v1/bonds/bond_7f29djw82kdpq9sl/document?token=v1.xxxxx","obligee":"Acme Property Management LLC","lease":{"start_date":"2026-03-01","end_date":"2027-02-28","monthly_rent":320000,"unit_address":{"line1":"123 Main St","line2":"Apt 5B","city":"New York","state":"NY","postal_code":"10001","object":"address"},"object":"lease"},"principals":[{"first_name":"Jane","last_name":"Doe","email":"jane.doe@example.com","phone_number":"+12125551234","applicant_id":"applc_e91hmctvoraymdpu","object":"principal"}],"coverage":{"lease_guarantee":{"coverage_unit":"months","coverage_amount":12},"security_deposit_replacement":{"coverage_unit":"months","coverage_amount":1},"object":"coverage"},"last_updated":"2026-03-15T14:15:22Z","metadata":{},"object":"bond"}}}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"3e1b5d96-73f5-490e-a96f-fd368a7b2d8d":{"description":"Your endpoint should return 2xx","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}}},"security":{},"servers":{"4c923e28-1932-4d68-820c-f5aa1183a0de":{"url":"https://api.theguarantors.com"}}},"originalFileLocation":"openapi/application-api.json"},"subdomain":"theguarantors-2e3c1083","siteName":"The Guarantors API","title":"bond.status.canceled - The Guarantors API","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-09T17:59:59.648Z","originalFileLocation":"application-api/bonds/bondstatuscanceled.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"An issued bond is canceled.\">\u003cmeta data-mint-head name=\"application-name\" content=\"The Guarantors API\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/theguarantors-2e3c1083/tSXTvjNgqk32WtbT/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/theguarantors-2e3c1083/tSXTvjNgqk32WtbT/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/theguarantors-2e3c1083/tSXTvjNgqk32WtbT/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/theguarantors-2e3c1083/tSXTvjNgqk32WtbT/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/theguarantors-2e3c1083/tSXTvjNgqk32WtbT/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/theguarantors-2e3c1083/tSXTvjNgqk32WtbT/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/theguarantors-2e3c1083/tSXTvjNgqk32WtbT/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/theguarantors-2e3c1083/tSXTvjNgqk32WtbT/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/theguarantors-2e3c1083/tSXTvjNgqk32WtbT/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"bond.status.canceled - The Guarantors API\">\u003cmeta data-mint-head property=\"og:description\" content=\"An issued bond is canceled.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"The Guarantors API\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.theguarantors.com/application-api/bonds/bondstatuscanceled\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://theguarantors-2e3c1083.mintlify.site/_mintlify/api/og/v2?division=Bonds\u0026amp;title=bond.status.canceled\u0026amp;description=An+issued+bond+is+canceled.\u0026amp;theme=24319ea74a156df9f19e7c2d\u0026amp;signature=48847f3589db43cde28f36caf3e29a86c76e33adc499c6c86a2948d41aef0e04\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"bond.status.canceled - The Guarantors API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"An issued bond is canceled.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://theguarantors-2e3c1083.mintlify.site/_mintlify/api/og/v2?division=Bonds\u0026amp;title=bond.status.canceled\u0026amp;description=An+issued+bond+is+canceled.\u0026amp;theme=24319ea74a156df9f19e7c2d\u0026amp;signature=48847f3589db43cde28f36caf3e29a86c76e33adc499c6c86a2948d41aef0e04\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/theguarantors-2e3c1083/tSXTvjNgqk32WtbT/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"The Guarantors API\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#3DB157\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.theguarantors.com/application-api/bonds/bondstatuscanceled\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/application-api/bonds/bondstatuscanceled.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.theguarantors.com/#organization\",\"name\":\"The Guarantors API\",\"url\":\"https://docs.theguarantors.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/theguarantors-2e3c1083/1COSbAUD3YqBCY97/images/logo/light.svg?fit=max\u0026auto=format\u0026n=1COSbAUD3YqBCY97\u0026q=85\u0026s=90090207d22f93a49206278f09bbbff7\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.theguarantors.com#website\",\"name\":\"The Guarantors API\",\"url\":\"https://docs.theguarantors.com\",\"publisher\":{\"@id\":\"https://docs.theguarantors.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.theguarantors.com/application-api/bonds/bondstatuscanceled#webpage\",\"url\":\"https://docs.theguarantors.com/application-api/bonds/bondstatuscanceled\",\"name\":\"bond.status.canceled\",\"description\":\"An issued bond is canceled.\",\"dateModified\":\"2026-11-09T17:59:59.648Z\",\"isPartOf\":{\"@id\":\"https://docs.theguarantors.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.theguarantors.com/application-api/bonds/bondstatuscanceled#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.theguarantors.com/application-api/bonds/bondstatuscanceled#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Application API\",\"item\":\"https://docs.theguarantors.com/application-api/invites/create-an-invite\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Bonds\",\"item\":\"https://docs.theguarantors.com/application-api/bonds/retrieve-a-bond\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"bond.status.canceled\",\"item\":\"https://docs.theguarantors.com/application-api/bonds/bondstatuscanceled\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.theguarantors.com/application-api/bonds/bondstatuscanceled#apireference\",\"headline\":\"bond.status.canceled\",\"name\":\"bond.status.canceled\",\"description\":\"An issued bond is canceled.\",\"url\":\"https://docs.theguarantors.com/application-api/bonds/bondstatuscanceled\",\"mainEntityOfPage\":{\"@id\":\"https://docs.theguarantors.com/application-api/bonds/bondstatuscanceled#webpage\"},\"dateModified\":\"2026-11-09T17:59:59.648Z\",\"publisher\":{\"@id\":\"https://docs.theguarantors.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.theguarantors.com#website\"}}]}\u003c/script>","siteName":"The Guarantors API","nav":{"global":null,"tabs":[{"tab":"Docs","pages":[{"title":"Docs","href":"/quickstart"}]},{"tab":"API Reference","groups":[{"group":"Application API","pages":[{"group":"Invites","pages":[{"title":"Create an invite","deprecated":null,"version":null,"openapi":"/openapi/application-api.json post /v1/invites","href":"/application-api/invites/create-an-invite"},{"title":"Retrieve an invite","deprecated":null,"version":null,"openapi":"/openapi/application-api.json get /v1/invites/{id}","href":"/application-api/invites/retrieve-an-invite"},{"title":"List invites","deprecated":null,"version":null,"openapi":"/openapi/application-api.json get /v1/invites","href":"/application-api/invites/list-invites"},{"title":"Update an invite","deprecated":null,"version":null,"openapi":"/openapi/application-api.json patch /v1/invites/{id}","href":"/application-api/invites/update-an-invite"},{"title":"Cancel an invite","deprecated":null,"version":null,"openapi":"/openapi/application-api.json post /v1/invites/{id}/cancel","href":"/application-api/invites/cancel-an-invite"},{"title":"invite.updated","version":null,"deprecated":null,"sidebarTitle":"invite.updated","openapi":"/openapi/application-api.json webhook invite.updated","href":"/application-api/invites/inviteupdated"},{"title":"invite.status.canceled","version":null,"deprecated":null,"sidebarTitle":"invite.status.canceled","openapi":"/openapi/application-api.json webhook invite.status.canceled","href":"/application-api/invites/invitestatuscanceled"}]},{"group":"Invite Recipients","pages":[{"title":"Add an invite recipient","deprecated":null,"version":null,"openapi":"/openapi/application-api.json post /v1/invites/{id}/invite-recipients","href":"/application-api/invites/add-an-invite-recipient"},{"title":"Update an invite recipient","deprecated":null,"version":null,"openapi":"/openapi/application-api.json patch /v1/invite-recipients/{id}","href":"/application-api/invites/update-an-invite-recipient"},{"title":"Remove an invite recipient","deprecated":null,"version":null,"openapi":"/openapi/application-api.json delete /v1/invite-recipients/{id}","href":"/application-api/invites/remove-an-invite-recipient"},{"title":"invite_recipient.added","version":null,"deprecated":null,"sidebarTitle":"invite_recipient.added","openapi":"/openapi/application-api.json webhook invite_recipient.added","href":"/application-api/invites/invite_recipientadded"},{"title":"invite_recipient.updated","version":null,"deprecated":null,"sidebarTitle":"invite_recipient.updated","openapi":"/openapi/application-api.json webhook invite_recipient.updated","href":"/application-api/invites/invite_recipientupdated"},{"title":"invite_recipient.removed","version":null,"deprecated":null,"sidebarTitle":"invite_recipient.removed","openapi":"/openapi/application-api.json webhook invite_recipient.removed","href":"/application-api/invites/invite_recipientremoved"}]},{"group":"Applications","pages":[{"title":"Retrieve an application","deprecated":null,"version":null,"openapi":"/openapi/application-api.json get /v1/applications/{id}","href":"/application-api/applications/retrieve-an-application"},{"title":"Retrieve an application by invite","deprecated":null,"version":null,"openapi":"/openapi/application-api.json get /v1/invites/{invite_id}/application","href":"/application-api/applications/retrieve-an-application-by-invite"},{"title":"Cancel an application","deprecated":null,"version":null,"openapi":"/openapi/application-api.json post /v1/applications/{id}/cancel","href":"/application-api/applications/cancel-an-application"},{"title":"application.status.started","version":null,"deprecated":null,"sidebarTitle":"application.status.started","openapi":"/openapi/application-api.json webhook application.status.started","href":"/application-api/applications/applicationstatusstarted"},{"title":"application.status.submitted","version":null,"deprecated":null,"sidebarTitle":"application.status.submitted","openapi":"/openapi/application-api.json webhook application.status.submitted","href":"/application-api/applications/applicationstatussubmitted"},{"title":"application.status.pending","version":null,"deprecated":null,"sidebarTitle":"application.status.pending","openapi":"/openapi/application-api.json webhook application.status.pending","href":"/application-api/applications/applicationstatuspending"},{"title":"application.status.approved","version":null,"deprecated":null,"sidebarTitle":"application.status.approved","openapi":"/openapi/application-api.json webhook application.status.approved","href":"/application-api/applications/applicationstatusapproved"},{"title":"application.status.denied","version":null,"deprecated":null,"sidebarTitle":"application.status.denied","openapi":"/openapi/application-api.json webhook application.status.denied","href":"/application-api/applications/applicationstatusdenied"},{"title":"application.status.canceled","version":null,"deprecated":null,"sidebarTitle":"application.status.canceled","openapi":"/openapi/application-api.json webhook application.status.canceled","href":"/application-api/applications/applicationstatuscanceled"}]},{"group":"Applicants","pages":[{"title":"Retrieve an applicant","deprecated":null,"version":null,"openapi":"/openapi/application-api.json get /v1/applicants/{id}","href":"/application-api/applicants/retrieve-an-applicant"},{"title":"applicant.status.started","version":null,"deprecated":null,"sidebarTitle":"applicant.status.started","openapi":"/openapi/application-api.json webhook applicant.status.started","href":"/application-api/applicants/applicantstatusstarted"},{"title":"applicant.status.submitted","version":null,"deprecated":null,"sidebarTitle":"applicant.status.submitted","openapi":"/openapi/application-api.json webhook applicant.status.submitted","href":"/application-api/applicants/applicantstatussubmitted"}]},{"group":"Bonds","pages":[{"title":"Retrieve a bond","deprecated":null,"version":null,"openapi":"/openapi/application-api.json get /v1/bonds/{id}","href":"/application-api/bonds/retrieve-a-bond"},{"title":"List bonds for an application","deprecated":null,"version":null,"openapi":"/openapi/application-api.json get /v1/applications/{application_id}/bonds","href":"/application-api/bonds/list-bonds-for-an-application"},{"title":"bond.status.issued","description":"A bond is issued for an approved application.","version":null,"deprecated":null,"sidebarTitle":"bond.status.issued","openapi":"/openapi/application-api.json webhook bond.status.issued","href":"/application-api/bonds/bondstatusissued"},{"title":"bond.status.canceled","version":null,"deprecated":null,"sidebarTitle":"bond.status.canceled","openapi":"/openapi/application-api.json webhook bond.status.canceled","href":"/application-api/bonds/bondstatuscanceled"}]},{"group":"Webhooks","pages":[{"title":"Trigger a sandbox webhook","description":"Advances a sandbox entity to its next state and delivers the matching webhook. Sandbox only.","deprecated":null,"version":null,"openapi":"/openapi/application-api.json post /v1/webhooks/trigger","href":"/application-api/webhooks/trigger-a-sandbox-webhook"}]}]},{"group":"Schemas","pages":[{"title":"Invite","href":"/schemas/invite"},{"title":"InviteRecipient","href":"/schemas/invite-recipient"},{"title":"Lease","href":"/schemas/lease"},{"title":"Address","href":"/schemas/address"},{"title":"Coverage","href":"/schemas/coverage"},{"title":"Application","href":"/schemas/application"},{"title":"Applicant","href":"/schemas/applicant"},{"title":"Bond","href":"/schemas/bond"},{"title":"Principal","href":"/schemas/principal"},{"title":"Error","href":"/schemas/error"}]}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/changelog"}]}]},"basePath":"","title":"bond.status.canceled - The Guarantors API","buildId":"dpl_42LwxxU1kGN114H4XzwGYXa9ZDah","deploymentId":"dpl_42LwxxU1kGN114H4XzwGYXa9ZDah","dynamics":["c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["OpenApiReferenceProvider-C-hEh3I2.js","utils-CnF4QiUD.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-C7PVNbel.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-8ytevL2A.js","snippetPresets-BT1alx3v.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","Page-C945cI-W.js","ApiExamples-BLXC0i_W.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CyLIGI9_.js","shallow-DC0lGVIW.js","getApiPlaygroundDisplay-CgDQ85tN.js","CodeSnippet-6-I-Gpv9.js","CodeSnippets-BAk1kDdu.js","getPastedJson-B276RuWN.js","icon-BqP8etTm.js","MethodPill-DM6sbxG1.js","DuplicateIcon-PyJglOaE.js","createIcon-CMeOMAc_.js","DynamicMarkdown-BoyYAA8K.js","SectionHeading-DAYv3gvZ.js","axios-vUo_bRtp.js","Markdown-BhTTmazV.js","clsx-CR-RHrVC.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CBUH0-zX.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BmARFYNC.js"]}