{ "message": "invite not found", "object": "error"}
{"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":"schemas/error","slug":"/schemas/error","pageMetadata":{"title":"Error","description":"Describes an error encountered while processing a request. It provides a message to help identify the cause and context of the failure.","openapi-schema":"openapi/application-api.json ErrorResponse","href":"/schemas/error"},"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: \"Describes an error encountered while processing a request. It provides a message to help identify the cause and context of the failure.\"\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":"Error","description":"Describes an error encountered while processing a request. It provides a message to help identify the cause and context of the failure.","openapi-schema":"openapi/application-api.json ErrorResponse","href":"/schemas/error"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"schemaData":{"type":"object","required":["message","object"],"properties":{"message":{"type":"string","example":"invite not found","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"object":{"type":"string","example":"error","isRequired":true,"uniqueKey":"object","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object","example":{"title":"Example","value":{"message":"invite not found","object":"error"}}},"originalFileLocation":"openapi/application-api.json"},"subdomain":"theguarantors-2e3c1083","siteName":"The Guarantors API","title":"Error - The Guarantors API","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-09-23T18:09:18.818Z","originalFileLocation":"schemas/error.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=\"Describes an error encountered while processing a request. It provides a message to help identify the cause and context of the failure.\">\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=\"Error - The Guarantors API\">\u003cmeta data-mint-head property=\"og:description\" content=\"Describes an error encountered while processing a request. It provides a message to help identify the cause and context of the failure.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"The Guarantors API\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.theguarantors.com/schemas/error\">\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=Schemas\u0026amp;title=Error\u0026amp;description=Describes+an+error+encountered+while+processing+a+request.+It+provides+a+message+to+help+identify+the+cause+and+context+of+the+failure.\u0026amp;theme=24319ea74a156df9f19e7c2d\u0026amp;signature=6c28a048268d0f862de66ab6db3232e2c2b4ebe298c4dbcf74e9f750ce2e06a1\">\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=\"Error - The Guarantors API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Describes an error encountered while processing a request. It provides a message to help identify the cause and context of the failure.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://theguarantors-2e3c1083.mintlify.site/_mintlify/api/og/v2?division=Schemas\u0026amp;title=Error\u0026amp;description=Describes+an+error+encountered+while+processing+a+request.+It+provides+a+message+to+help+identify+the+cause+and+context+of+the+failure.\u0026amp;theme=24319ea74a156df9f19e7c2d\u0026amp;signature=6c28a048268d0f862de66ab6db3232e2c2b4ebe298c4dbcf74e9f750ce2e06a1\">\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/schemas/error\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/schemas/error.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/schemas/error#webpage\",\"url\":\"https://docs.theguarantors.com/schemas/error\",\"name\":\"Error\",\"description\":\"Describes an error encountered while processing a request. It provides a message to help identify the cause and context of the failure.\",\"dateModified\":\"2026-09-23T18:09:18.818Z\",\"isPartOf\":{\"@id\":\"https://docs.theguarantors.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.theguarantors.com/schemas/error#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.theguarantors.com/schemas/error#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Schemas\",\"item\":\"https://docs.theguarantors.com/schemas/invite\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Error\",\"item\":\"https://docs.theguarantors.com/schemas/error\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.theguarantors.com/schemas/error#apireference\",\"headline\":\"Error\",\"name\":\"Error\",\"description\":\"Describes an error encountered while processing a request. It provides a message to help identify the cause and context of the failure.\",\"url\":\"https://docs.theguarantors.com/schemas/error\",\"mainEntityOfPage\":{\"@id\":\"https://docs.theguarantors.com/schemas/error#webpage\"},\"dateModified\":\"2026-09-23T18:09:18.818Z\",\"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","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","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","description":"An individual who has a Lease Guarantee and/or Security Deposit Replacement surety bond with TheGuarantors. This individual is one of the future residents or tenants and is associated with the lease.","href":"/schemas/principal"},{"title":"Error","href":"/schemas/error"}]}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/changelog"}]}]},"basePath":"","title":"Error - 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"]}
