{"docsConfig":{"theme":"maple","$schema":"https://mintlify.com/docs.json","name":"Heron","colors":{"primary":"#CD461D","light":"#FF835E","dark":"#CD461D"},"logo":{"light":"https://mintcdn.com/herondata/AkuG3WZNjPMLrlAs/logo/light.svg?fit=max\u0026auto=format\u0026n=AkuG3WZNjPMLrlAs\u0026q=85\u0026s=3fdaeef2943a89b32ca67895d004d0b9","dark":"https://mintcdn.com/herondata/AkuG3WZNjPMLrlAs/logo/dark.svg?fit=max\u0026auto=format\u0026n=AkuG3WZNjPMLrlAs\u0026q=85\u0026s=3e602c236a03e92457e96c309ce44d03","href":"https://herondata.io"},"favicon":"https://mintcdn.com/herondata/AkuG3WZNjPMLrlAs/favicon.svg?fit=max\u0026auto=format\u0026n=AkuG3WZNjPMLrlAs\u0026q=85\u0026s=d4ad7da2a98a69e7d704364b0877e1a5","background":{"color":{"light":"#F9FAF0","dark":"#15160C"}},"navbar":{"links":[{"href":"mailto:[email protected]","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://dashboard.herondata.io"}},"footer":{"socials":{"github":"https://github.com/herondata","linkedin":"https://www.linkedin.com/company/heron-data"}},"fonts":{"family":"Season Sans","weight":400,"source":"fonts/SeasonSans-Regular.woff2","format":"woff2"},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Heron","icon":"house","href":"https://herondata.io"},{"anchor":"Dashboard","icon":"chart-line","href":"https://dashboard.herondata.io"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"herondata","hasAudioNarration":false,"actualSubdomain":"herondata","customDomains":["docs.herondata.io"],"gitSource":{"type":"github","owner":"heron-data","repo":"mintlify","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae13fab3abe138c6768d187","collectionId":"4d3f7f5a-208a-48e1-8965-5a339531c2eb","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae13fab3abe138c6768d187"},"feedback":{"thumbs":true,"issues":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ae13fab3abe138c6768d187","clientVersion":"0.0.4006","searchFilterCounts":[{"language":"default","tag":"API Reference","count":316},{"language":"default","tag":"EndUsers","count":33},{"language":"default","tag":"Documentation","count":24},{"language":"default","tag":"EndUserFiles","count":22},{"language":"default","tag":"Integrations","count":18},{"language":"default","tag":"EndUserCalculations","count":18},{"language":"default","tag":"EndUserEntity","count":17},{"language":"default","tag":"EndUserIntegrations","count":16},{"language":"default","tag":"Tags","count":9},{"language":"default","tag":"Webhooks","count":8}]},"assistantConfig":{},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"@font-face{font-family:\"Season Sans\";src:url(/fonts/SeasonSans-Medium.woff2) format(\"woff2\");font-weight:500;font-style:normal;font-display:swap}.font-bold,.font-semibold,.sidebar-group a,b,h1,h2,h3,h4,h5,h6,strong{font-weight:500}html:not(.dark) #content-area,html:not(.dark) #content.prose{color:#4a1809;--tw-prose-body:#4a1809;--tw-prose-headings:#4a1809;--tw-prose-lead:#4a1809;--tw-prose-bold:#4a1809;--tw-prose-counters:#4a1809;--tw-prose-bullets:rgb(74 24 9 / 0.5);--tw-prose-th-borders:rgb(74 24 9 / 0.2);--tw-prose-td-borders:rgb(74 24 9 / 0.12)}html:not(.dark) #content-area :not(pre)>code{background-color:#ebedd9;border-color:#dcdfbe}html.dark #content-area :not(pre)>code{background-color:#2d2e20;border-color:#5a5c40}html:not(.dark) .sidebar-group a.text-gray-700{color:rgb(74 24 9/.72)}#content-area :not(code,pre,kbd,pre *),#sidebar-content :not(code,kbd),#table-of-contents-content a{font-weight:500}"}],"page":{"pagePath":"api-reference/enduserintegrations/upload-inscribe","slug":"/api-reference/enduserintegrations/upload-inscribe","pageMetadata":{"title":"Upload Inscribe","description":"Upload Inscribe JSON for a specified end user to translate into Heron Data format and add transactions for the end user\n","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/end_users/{end_user_id_or_heron_id}/inscribe","href":"/api-reference/enduserintegrations/upload-inscribe","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: \"Upload Inscribe JSON for a specified end user to translate into Heron Data format and add transactions for the end user\"\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":"Upload Inscribe","description":"Upload Inscribe JSON for a specified end user to translate into Heron Data format and add transactions for the end user\n","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/end_users/{end_user_id_or_heron_id}/inscribe","href":"/api-reference/enduserintegrations/upload-inscribe","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"description":"Upload Inscribe JSON for a specified end user to translate into Heron Data format and add transactions for the end user\n","parameters":["3c65a87d-c31e-4a28-810c-84b35faa582c"],"requestBody":"d78a37fd-420b-48c6-8632-9205353fc601","responses":{"201":"f7c6b2c6-5bcd-490f-85c6-2eb8ca54472d"},"security":["46ce61cd-121d-449a-9033-f41c82e8a0a3"],"summary":"Upload Inscribe","tags":["EndUserIntegrations"],"method":"post","type":"path","servers":["2b573ebb-0457-4c4b-aa37-caeff11570d9"],"path":"/api/end_users/{end_user_id_or_heron_id}/inscribe","baseUrlOptions":["https://app.herondata.io"],"title":"Upload Inscribe","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"3c65a87d-c31e-4a28-810c-84b35faa582c":{"description":"The `end_user_id` or `heron_id` of EndUser to upload","in":"path","name":"end_user_id_or_heron_id","required":true,"schema":{"type":"string","isRequired":true,"description":"The `end_user_id` or `heron_id` of EndUser to upload","uniqueKey":"","typeLabel":"string"}}},"requestBody":{"content":{"application/json":{"schema":{"properties":{"customer_name":{"oneOf":[{"type":"string","uniqueKey":"customer_name.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"customer_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer_name","typeLabel":"string | null"},"parsed_details":{"properties":{"bank_accounts":{"items":{"properties":{"account_type":{"oneOf":[{"type":"string","uniqueKey":"parsed_details.bank_accounts.items.[INDEX].account_type.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"parsed_details.bank_accounts.items.[INDEX].account_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"parsed_details.bank_accounts.items.[INDEX].account_type","typeLabel":"string | null"},"beginning_balance":{"oneOf":[{"type":"object","properties":{"confidence":{"type":"number","uniqueKey":"parsed_details.bank_accounts.items.[INDEX].beginning_balance.oneOf.0.confidence","typeLabel":"number"},"normalized":{"type":"integer","uniqueKey":"parsed_details.bank_accounts.items.[INDEX].beginning_balance.oneOf.0.normalized","typeLabel":"integer"},"raw":{"type":"string","uniqueKey":"parsed_details.bank_accounts.items.[INDEX].beginning_balance.oneOf.0.raw","typeLabel":"string"}},"uniqueKey":"parsed_details.bank_accounts.items.[INDEX].beginning_balance.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"parsed_details.bank_accounts.items.[INDEX].beginning_balance.oneOf.1","typeLabel":"null"}],"uniqueKey":"parsed_details.bank_accounts.items.[INDEX].beginning_balance","typeLabel":"object | null"},"ending_balance":{"oneOf":[{"type":"object","properties":{"confidence":{"type":"number","uniqueKey":"parsed_details.bank_accounts.items.[INDEX].ending_balance.oneOf.0.confidence","typeLabel":"number"},"normalized":{"type":"integer","uniqueKey":"parsed_details.bank_accounts.items.[INDEX].ending_balance.oneOf.0.normalized","typeLabel":"integer"},"raw":{"type":"string","uniqueKey":"parsed_details.bank_accounts.items.[INDEX].ending_balance.oneOf.0.raw","typeLabel":"string"}},"uniqueKey":"parsed_details.bank_accounts.items.[INDEX].ending_balance.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"parsed_details.bank_accounts.items.[INDEX].ending_balance.oneOf.1","typeLabel":"null"}],"uniqueKey":"parsed_details.bank_accounts.items.[INDEX].ending_balance","typeLabel":"object | null"},"institution_name":{"oneOf":[{"type":"string","uniqueKey":"parsed_details.bank_accounts.items.[INDEX].institution_name.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"parsed_details.bank_accounts.items.[INDEX].institution_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"parsed_details.bank_accounts.items.[INDEX].institution_name","typeLabel":"string | null"},"number":{"properties":{"confidence":{"type":"number","uniqueKey":"parsed_details.bank_accounts.items.[INDEX].number.confidence","typeLabel":"number"},"normalized":{"type":"string","uniqueKey":"parsed_details.bank_accounts.items.[INDEX].number.normalized","typeLabel":"string"},"raw":{"type":"string","uniqueKey":"parsed_details.bank_accounts.items.[INDEX].number.raw","typeLabel":"string"}},"type":"object","uniqueKey":"parsed_details.bank_accounts.items.[INDEX].number","typeLabel":"object"},"transactions":{"items":{"properties":{"amount":{"type":"integer","uniqueKey":"parsed_details.bank_accounts.items.[INDEX].transactions.items.[INDEX].amount","typeLabel":"integer"},"date":{"format":"date","type":"string","uniqueKey":"parsed_details.bank_accounts.items.[INDEX].transactions.items.[INDEX].date","typeLabel":"string\u003cdate>"},"description":{"type":"string","uniqueKey":"parsed_details.bank_accounts.items.[INDEX].transactions.items.[INDEX].description","typeLabel":"string"},"id":{"type":"string","uniqueKey":"parsed_details.bank_accounts.items.[INDEX].transactions.items.[INDEX].id","typeLabel":"string"}},"type":"object","uniqueKey":"parsed_details.bank_accounts.items.[INDEX].transactions.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"parsed_details.bank_accounts.items.[INDEX].transactions","typeLabel":"object[]"},"transactions_match_balances":{"oneOf":[{"type":"boolean","uniqueKey":"parsed_details.bank_accounts.items.[INDEX].transactions_match_balances.oneOf.0","typeLabel":"boolean"},{"type":"null","uniqueKey":"parsed_details.bank_accounts.items.[INDEX].transactions_match_balances.oneOf.1","typeLabel":"null"}],"uniqueKey":"parsed_details.bank_accounts.items.[INDEX].transactions_match_balances","typeLabel":"boolean | null"}},"type":"object","uniqueKey":"parsed_details.bank_accounts.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"parsed_details.bank_accounts","typeLabel":"object[]"},"name":{"properties":{"raw":{"type":"string","uniqueKey":"parsed_details.name.raw","typeLabel":"string"}},"type":"object","uniqueKey":"parsed_details.name","typeLabel":"object"}},"type":"object","uniqueKey":"parsed_details","typeLabel":"object"}},"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"customer_name":"\u003cstring>","parsed_details":{"bank_accounts":[{"account_type":"\u003cstring>","beginning_balance":{"confidence":123,"normalized":123,"raw":"\u003cstring>"},"ending_balance":{"confidence":123,"normalized":123,"raw":"\u003cstring>"},"institution_name":"\u003cstring>","number":{"confidence":123,"normalized":"\u003cstring>","raw":"\u003cstring>"},"transactions":[{"amount":123,"date":"2023-12-25","description":"\u003cstring>","id":"\u003cstring>"}],"transactions_match_balances":true}],"name":{"raw":"\u003cstring>"}}}}},"exampleType":"generated"}},"required":true,"exampleType":"generated"},"responses":{"f7c6b2c6-5bcd-490f-85c6-2eb8ca54472d":{"content":{"application/json":{"schema":{"properties":{"_summary":{"properties":{"request_id":{"description":"Unique UUID per request","type":"string","uniqueKey":"_summary.request_id","typeLabel":"string"}},"type":"object","uniqueKey":"_summary","typeLabel":"object"}},"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"_summary":{"request_id":"\u003cstring>"}}}},"exampleType":"generated"}},"description":"OK","exampleType":"generated"}},"security":{"46ce61cd-121d-449a-9033-f41c82e8a0a3":{"ApiKeyAuth":{"in":"header","name":"x-api-key","type":"apiKey","scopes":[],"schemeName":"ApiKeyAuth"}}},"servers":{"2b573ebb-0457-4c4b-aa37-caeff11570d9":{"description":"Production","url":"https://app.herondata.io"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"in":"header","name":"x-api-key","type":"apiKey","scopes":[],"schemeName":"ApiKeyAuth"},"schema":{"title":"x-api-key","type":"string","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"ApiKeyAuth","name":"x-api-key"}],"title":"ApiKeyAuth"}]},"originalFileLocation":"https://app.herondata.io/swagger"},"subdomain":"herondata","siteName":"Heron","title":"Upload Inscribe - Heron","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-28T00:20:04.711Z","originalFileLocation":"api-reference/enduserintegrations/upload-inscribe.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=\"Upload Inscribe JSON for a specified end user to translate into Heron Data format and add transactions for the end user\">\u003cmeta data-mint-head name=\"application-name\" content=\"Heron\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/herondata/sWOyxQaKY2vTRAyo/_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/herondata/sWOyxQaKY2vTRAyo/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/herondata/sWOyxQaKY2vTRAyo/_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/herondata/sWOyxQaKY2vTRAyo/_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/herondata/sWOyxQaKY2vTRAyo/_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/herondata/sWOyxQaKY2vTRAyo/_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/herondata/sWOyxQaKY2vTRAyo/_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/herondata/sWOyxQaKY2vTRAyo/_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/herondata/sWOyxQaKY2vTRAyo/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Upload Inscribe - Heron\">\u003cmeta data-mint-head property=\"og:description\" content=\"Upload Inscribe JSON for a specified end user to translate into Heron Data format and add transactions for the end user\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Heron\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.herondata.io/api-reference/enduserintegrations/upload-inscribe\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://herondata.mintlify.app/_mintlify/api/og/v2?division=EndUserIntegrations\u0026amp;title=Upload+Inscribe\u0026amp;description=Upload+Inscribe+JSON+for+a+specified+end+user+to+translate+into+Heron+Data+format+and+add+transactions+for+the+end+user%0A\u0026amp;theme=4464ed720a5ef3d226d9a192\u0026amp;signature=899f43c4974bc4e56e75da5b5a1056e151f7026538fb88fbedc9e6a350d18071\">\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=\"Upload Inscribe - Heron\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Upload Inscribe JSON for a specified end user to translate into Heron Data format and add transactions for the end user\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://herondata.mintlify.app/_mintlify/api/og/v2?division=EndUserIntegrations\u0026amp;title=Upload+Inscribe\u0026amp;description=Upload+Inscribe+JSON+for+a+specified+end+user+to+translate+into+Heron+Data+format+and+add+transactions+for+the+end+user%0A\u0026amp;theme=4464ed720a5ef3d226d9a192\u0026amp;signature=899f43c4974bc4e56e75da5b5a1056e151f7026538fb88fbedc9e6a350d18071\">\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/herondata/sWOyxQaKY2vTRAyo/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Heron\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#CD461D\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.herondata.io/api-reference/enduserintegrations/upload-inscribe\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/enduserintegrations/upload-inscribe.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.herondata.io/#organization\",\"name\":\"Heron\",\"url\":\"https://docs.herondata.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/herondata/AkuG3WZNjPMLrlAs/logo/light.svg?fit=max\u0026auto=format\u0026n=AkuG3WZNjPMLrlAs\u0026q=85\u0026s=3fdaeef2943a89b32ca67895d004d0b9\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.herondata.io#website\",\"name\":\"Heron\",\"url\":\"https://docs.herondata.io\",\"publisher\":{\"@id\":\"https://docs.herondata.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.herondata.io/api-reference/enduserintegrations/upload-inscribe#webpage\",\"url\":\"https://docs.herondata.io/api-reference/enduserintegrations/upload-inscribe\",\"name\":\"Upload Inscribe\",\"description\":\"Upload Inscribe JSON for a specified end user to translate into Heron Data format and add transactions for the end user\",\"dateModified\":\"2026-10-28T00:20:04.711Z\",\"isPartOf\":{\"@id\":\"https://docs.herondata.io#website\"},\"breadcrumb\":{\"@id\":\"https://docs.herondata.io/api-reference/enduserintegrations/upload-inscribe#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.herondata.io/api-reference/enduserintegrations/upload-inscribe#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"EndUserIntegrations\",\"item\":\"https://docs.herondata.io/api-reference/enduserintegrations/upload-decisionlogic-xml\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Upload Inscribe\",\"item\":\"https://docs.herondata.io/api-reference/enduserintegrations/upload-inscribe\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.herondata.io/api-reference/enduserintegrations/upload-inscribe#apireference\",\"headline\":\"Upload Inscribe\",\"name\":\"Upload Inscribe\",\"description\":\"Upload Inscribe JSON for a specified end user to translate into Heron Data format and add transactions for the end user\",\"url\":\"https://docs.herondata.io/api-reference/enduserintegrations/upload-inscribe\",\"mainEntityOfPage\":{\"@id\":\"https://docs.herondata.io/api-reference/enduserintegrations/upload-inscribe#webpage\"},\"dateModified\":\"2026-10-28T00:20:04.711Z\",\"publisher\":{\"@id\":\"https://docs.herondata.io/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.herondata.io#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Heron\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Heron","nav":{"global":{"anchors":[{"anchor":"Heron","icon":"house","href":"https://herondata.io"},{"anchor":"Dashboard","icon":"chart-line","href":"https://dashboard.herondata.io"}]},"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/get-started/quickstart"}]},{"tab":"API Reference","groups":[{"group":"Testing","pages":[{"title":"Get apihello world","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/hello_world","href":"/api-reference/testing/get-apihello_world"},{"title":"Get apihello worldauthenticated","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/hello_world/authenticated","href":"/api-reference/testing/get-apihello_worldauthenticated"}]},{"group":"Clear","pages":[]},{"group":"Courts","pages":[]},{"group":"FraudNetwork","pages":[]},{"group":"Secretary of State","pages":[]},{"group":"Analytics","pages":[{"title":"Get decline analytics for a user","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/analytics/decline","href":"/api-reference/analytics/get-decline-analytics-for-a-user"}]},{"group":"AppStore","pages":[{"title":"List available apps","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/app_store/list","href":"/api-reference/appstore/list-available-apps"}]},{"group":"Authentication","pages":[]},{"group":"Brokers","pages":[{"title":"List broker EndUsers with deal summary information","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/broker/end_users/summary","href":"/api-reference/brokers/list-broker-endusers-with-deal-summary-information"},{"title":"Get broker EndUser detail","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/broker/end_users/{end_user_id_or_heron_id}","href":"/api-reference/brokers/get-broker-enduser-detail"},{"title":"Link a broker decision record to a deal; its live decisions move onto that deal's submissions","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/broker/end_users/{end_user_id_or_heron_id}/deal_link/","href":"/api-reference/brokers/link-a-broker-decision-record-to-a-deal;-its-live-decisions-move-onto-that-deals-submissions"},{"title":"Dismiss a broker decision from deal-link review","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/broker/end_users/{end_user_id_or_heron_id}/deal_link/dismiss","href":"/api-reference/brokers/dismiss-a-broker-decision-from-deal-link-review"},{"title":"List deal-link candidates for a broker decision","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/broker/end_users/{end_user_id_or_heron_id}/deal_link_candidates/","href":"/api-reference/brokers/list-deal-link-candidates-for-a-broker-decision"}]},{"group":"API Reference","pages":[{"title":"List funder submissions with their current decision and offers","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/broker/end_users/{end_user_heron_id}/funder_submissions/","href":"/api-reference/list-funder-submissions-with-their-current-decision-and-offers"},{"title":"Validate an end user for configured funders","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/broker/end_users/{end_user_heron_id}/funder_submissions/preflight/","href":"/api-reference/validate-an-end-user-for-configured-funders"},{"title":"Submit an end user to multiple funders","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/broker/end_users/{end_user_heron_id}/funder_submissions/submit_to_funders/","href":"/api-reference/submit-an-end-user-to-multiple-funders"},{"title":"Resolve a held funder submission","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/broker/end_users/{end_user_heron_id}/funder_submissions/{submission_heron_id}/exclusion_resolution/","href":"/api-reference/resolve-a-held-funder-submission"},{"title":"List broker funder policies for current user","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/broker_funder_policies/","href":"/api-reference/list-broker-funder-policies-for-current-user"},{"title":"Bulk update broker funder policies","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger patch /api/broker_funder_policies/","href":"/api-reference/bulk-update-broker-funder-policies"},{"title":"Export broker funder policies as Excel","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/broker_funder_policies/export/","href":"/api-reference/export-broker-funder-policies-as-excel"},{"title":"Add a funder to broker's policies","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/broker_funder_policies/funders/","href":"/api-reference/add-a-funder-to-brokers-policies"},{"title":"Remove a funder from broker's policies","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger delete /api/broker_funder_policies/funders/{funder_heron_id}/","href":"/api-reference/remove-a-funder-from-brokers-policies"},{"title":"Upload funder policy file for parsing","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/broker_funder_policies/upload/","href":"/api-reference/upload-funder-policy-file-for-parsing"},{"title":"Get policy upload job status","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/broker_funder_policies/upload/status/","href":"/api-reference/get-policy-upload-job-status"},{"title":"Get specific policy upload job","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/broker_funder_policies/upload/{job_heron_id}/","href":"/api-reference/get-specific-policy-upload-job"},{"title":"List pending funder matches for a job","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/broker_funder_policies/upload/{job_heron_id}/pending/","href":"/api-reference/list-pending-funder-matches-for-a-job"},{"title":"Resolve a pending funder match","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/broker_funder_policies/upload/{job_heron_id}/pending/{index}/resolve/","href":"/api-reference/resolve-a-pending-funder-match"},{"title":"Skip a pending funder match","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/broker_funder_policies/upload/{job_heron_id}/pending/{index}/skip/","href":"/api-reference/skip-a-pending-funder-match"},{"title":"Get deal link entries for an end user","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_users/{end_user_heron_id}/deal_link/","href":"/api-reference/get-deal-link-entries-for-an-end-user"},{"title":"List funder policy evaluations for an end user","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_users/{end_user_heron_id}/funder_policy_evaluations/","href":"/api-reference/list-funder-policy-evaluations-for-an-end-user"},{"title":"Submit an end user to a single funder","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/end_users/{end_user_heron_id}/funder_submissions/{submission_heron_id}/submit_to_funder/","href":"/api-reference/submit-an-end-user-to-a-single-funder"},{"title":"List funder exclusion rules","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/funder_exclusion_rules/","href":"/api-reference/list-funder-exclusion-rules"},{"title":"Add sender matchers to many funder exclusion rules","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/funder_exclusion_rules/bulk/","href":"/api-reference/add-sender-matchers-to-many-funder-exclusion-rules"},{"title":"Delete many funder exclusion rules","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger delete /api/funder_exclusion_rules/bulk/","href":"/api-reference/delete-many-funder-exclusion-rules"},{"title":"Add and remove sender matchers across many funder exclusion rules","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger patch /api/funder_exclusion_rules/bulk/","href":"/api-reference/add-and-remove-sender-matchers-across-many-funder-exclusion-rules"},{"title":"Create or replace a funder exclusion rule","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger put /api/funder_exclusion_rules/{funder_heron_id}/","href":"/api-reference/create-or-replace-a-funder-exclusion-rule"},{"title":"Delete a funder exclusion rule","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger delete /api/funder_exclusion_rules/{funder_heron_id}/","href":"/api-reference/delete-a-funder-exclusion-rule"},{"title":"List funder integration states for the current broker","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/funder_integrations/","href":"/api-reference/list-funder-integration-states-for-the-current-broker"},{"title":"Link a funder to the current broker for self-service","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/funder_integrations/","href":"/api-reference/link-a-funder-to-the-current-broker-for-self-service"},{"title":"List funders available for self-service that the broker hasn't linked yet","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/funder_integrations/candidates/","href":"/api-reference/list-funders-available-for-self-service-that-the-broker-hasnt-linked-yet"},{"title":"Save staging or production form values for a funder integration","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger put /api/funder_integrations/{funder_heron_id}/","href":"/api-reference/save-staging-or-production-form-values-for-a-funder-integration"},{"title":"Remove a funder, or delete one environment's saved integration","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger delete /api/funder_integrations/{funder_heron_id}/","href":"/api-reference/remove-a-funder-or-delete-one-environments-saved-integration"},{"title":"Update a funder's submission channel and email configuration","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger patch /api/funder_integrations/{funder_heron_id}/","href":"/api-reference/update-a-funders-submission-channel-and-email-configuration"},{"title":"Trigger a staging or production test submission for this funder","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/funder_integrations/{funder_heron_id}/test/","href":"/api-reference/trigger-a-staging-or-production-test-submission-for-this-funder"},{"title":"Upsert a funder submission","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/funder_submissions/","href":"/api-reference/upsert-a-funder-submission"},{"title":"Get funder submission status","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/funder_submissions/{submission_heron_id}/","href":"/api-reference/get-funder-submission-status"},{"title":"Trigger a funder submission","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/funder_submissions/{submission_heron_id}/trigger/","href":"/api-reference/trigger-a-funder-submission"},{"title":"Search funders by name","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/funders/search/","href":"/api-reference/search-funders-by-name"},{"title":"Ingest end user data from a CRM webhook","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/ingestion/crm/{crm_integration_heron_id}","href":"/api-reference/ingest-end-user-data-from-a-crm-webhook"}]},{"group":"BrokerSubmissions","pages":[{"title":"Create broker submission","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/broker_submissions/","href":"/api-reference/brokersubmissions/create-broker-submission"},{"title":"List broker API keys for a given user.","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/broker_submissions/api_keys","href":"/api-reference/brokersubmissions/list-broker-api-keys-for-a-given-user"},{"title":"Generate broker API key","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/broker_submissions/api_keys/generate","href":"/api-reference/brokersubmissions/generate-broker-api-key"},{"title":"Delete broker API key","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger delete /api/broker_submissions/api_keys/{broker_funder_api_key_heron_id}","href":"/api-reference/brokersubmissions/delete-broker-api-key"},{"title":"Upload PDF files for broker submission","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/broker_submissions/{submission_heron_id}/files","href":"/api-reference/brokersubmissions/upload-pdf-files-for-broker-submission"},{"title":"Add details to broker submission","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/broker_submissions/{submission_heron_id}/update_information","href":"/api-reference/brokersubmissions/add-details-to-broker-submission"}]},{"group":"Categories","pages":[{"title":"Get categories","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/categories","href":"/api-reference/categories/get-categories"}]},{"group":"Policy","pages":[{"title":"List company attributes available for policy checks","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/company_attributes","href":"/api-reference/policy/list-company-attributes-available-for-policy-checks"},{"title":"Get the policy evaluations for an end user","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_users/{end_user_id_or_heron_id}/policy_evaluations","href":"/api-reference/policy/get-the-policy-evaluations-for-an-end-user"},{"title":"Get all policy definitions","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/policies","href":"/api-reference/policy/get-all-policy-definitions"},{"title":"Progress policies for an end user","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/policies/progress","href":"/api-reference/policy/progress-policies-for-an-end-user"}]},{"group":"Credentials","pages":[{"title":"List API keys","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/credentials/keys","href":"/api-reference/credentials/list-api-keys"},{"title":"Create a new API key","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/credentials/keys","href":"/api-reference/credentials/create-a-new-api-key"},{"title":"Delete an API key","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger delete /api/credentials/keys/{heron_id}","href":"/api-reference/credentials/delete-an-api-key"},{"title":"Activate an API key","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger put /api/credentials/keys/{heron_id}/activate","href":"/api-reference/credentials/activate-an-api-key"},{"title":"Deactivate an API key","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger put /api/credentials/keys/{heron_id}/deactivate","href":"/api-reference/credentials/deactivate-an-api-key"}]},{"group":"CrmIntegrations","pages":[{"title":"List CRM Integrations","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/crm_integrations","href":"/api-reference/crmintegrations/list-crm-integrations"},{"title":"Create a CRM integration","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/crm_integrations","href":"/api-reference/crmintegrations/create-a-crm-integration"},{"title":"Patch a CRM integration","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger patch /api/crm_integrations/{heron_id}","href":"/api-reference/crmintegrations/patch-a-crm-integration"}]},{"group":"EndUserDataSourceAccounts","pages":[{"title":"Update a data source account's account number","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/data_source_accounts/{dsa_heron_id_to_update}/update_number","href":"/api-reference/enduserdatasourceaccounts/update-a-data-source-accounts-account-number"},{"title":"Update a data source account","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger put /api/data_source_accounts/{heron_id}","href":"/api-reference/enduserdatasourceaccounts/update-a-data-source-account"},{"title":"Disable duplicate data source accounts for an end user","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/end_users/{end_user_id_or_heron_id}/data_source_accounts/disable_duplicates","href":"/api-reference/enduserdatasourceaccounts/disable-duplicate-data-source-accounts-for-an-end-user"}]},{"group":"EndUserDataSources","pages":[{"title":"Update a data source","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger put /api/data_sources/{heron_id}","href":"/api-reference/enduserdatasources/update-a-data-source"},{"title":"Get data source account summary","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_users/{end_user_id_or_heron_id}/data_source_account_summary","href":"/api-reference/enduserdatasources/get-data-source-account-summary"},{"title":"Get data sources","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_users/{end_user_id_or_heron_id}/data_sources","href":"/api-reference/enduserdatasources/get-data-sources"},{"title":"Get paginated data source summaries","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_users/{end_user_id_or_heron_id}/data_sources/summary","href":"/api-reference/enduserdatasources/get-paginated-data-source-summaries"}]},{"group":"EmailTemplates","pages":[{"title":"Get email templates","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/email_templates","href":"/api-reference/emailtemplates/get-email-templates"},{"title":"Create an email template","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/email_templates","href":"/api-reference/emailtemplates/create-an-email-template"},{"title":"Patch an email template","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger patch /api/email_templates/{heron_id}","href":"/api-reference/emailtemplates/patch-an-email-template"}]},{"group":"EndUsers","pages":[{"title":"Get EndUser emails","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_user_emails","href":"/api-reference/endusers/get-enduser-emails"},{"title":"List EndUsers","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_users","href":"/api-reference/endusers/list-endusers"},{"title":"Update EndUser","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger put /api/end_users","href":"/api-reference/endusers/update-enduser"},{"title":"Create EndUser","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/end_users","href":"/api-reference/endusers/create-enduser"},{"title":"List EndUsers with Summary Information","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_users/summary","href":"/api-reference/endusers/list-endusers-with-summary-information"},{"title":"Get EndUser background check dashboard payload","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_users/{end_user_heron_id}/background_check","href":"/api-reference/endusers/get-enduser-background-check-dashboard-payload"},{"title":"List an end user's background check affiliations","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_users/{end_user_heron_id}/background_check/affiliations","href":"/api-reference/endusers/list-an-end-users-background-check-affiliations"},{"title":"Request background check reports for affiliations","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/end_users/{end_user_heron_id}/background_check/affiliations/reports","href":"/api-reference/endusers/request-background-check-reports-for-affiliations"},{"title":"Confirm a candidate for an affiliate report","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/end_users/{end_user_heron_id}/background_check/affiliations/reports/confirm","href":"/api-reference/endusers/confirm-a-candidate-for-an-affiliate-report"},{"title":"Stop tracking an affiliate report","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger delete /api/end_users/{end_user_heron_id}/background_check/affiliations/reports/{ref}","href":"/api-reference/endusers/stop-tracking-an-affiliate-report"},{"title":"Get the pinned CLEAR candidate overrides for a background check","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_users/{end_user_heron_id}/background_check/override","href":"/api-reference/endusers/get-the-pinned-clear-candidate-overrides-for-a-background-check"},{"title":"Pin CLEAR candidate overrides for a background check","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/end_users/{end_user_heron_id}/background_check/override","href":"/api-reference/endusers/pin-clear-candidate-overrides-for-a-background-check"},{"title":"Clear all CLEAR candidate overrides for a background check","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger delete /api/end_users/{end_user_heron_id}/background_check/override","href":"/api-reference/endusers/clear-all-clear-candidate-overrides-for-a-background-check"},{"title":"Download the background check as a PDF","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_users/{end_user_heron_id}/background_check/pdf","href":"/api-reference/endusers/download-the-background-check-as-a-pdf"},{"title":"Download a subject's background check as XML","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_users/{end_user_heron_id}/background_check/subjects/{subject_key}/raw_report","href":"/api-reference/endusers/download-a-subjects-background-check-as-xml"},{"title":"View a criminal-record mug shot","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_users/{end_user_heron_id}/background_check/subjects/{subject_key}/records/{record_id}/mugshot","href":"/api-reference/endusers/view-a-criminal-record-mug-shot"},{"title":"Get an end user's background check verification","deprecated":true,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_users/{end_user_heron_id}/background_check/verification","href":"/api-reference/endusers/get-an-end-users-background-check-verification"},{"title":"Get the business and owner details of an end user","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_users/{end_user_heron_id}/details","href":"/api-reference/endusers/get-the-business-and-owner-details-of-an-end-user"},{"title":"Update the business and owner details of an end user","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger patch /api/end_users/{end_user_heron_id}/details","href":"/api-reference/endusers/update-the-business-and-owner-details-of-an-end-user"},{"title":"Get duplicate end users for an end user","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_users/{end_user_heron_id}/duplicate_end_users","href":"/api-reference/endusers/get-duplicate-end-users-for-an-end-user"},{"title":"Get an end user's fraud network scan","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_users/{end_user_heron_id}/fraud_detection/fraud_network","href":"/api-reference/endusers/get-an-end-users-fraud-network-scan"},{"title":"Get an end user's verification","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_users/{end_user_heron_id}/verification","href":"/api-reference/endusers/get-an-end-users-verification"},{"title":"Get EndUser by heron_id or end_user_id","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_users/{end_user_id_or_heron_id}","href":"/api-reference/endusers/get-enduser-by-heron_id-or-end_user_id"},{"title":"Delete EndUser by heron_id or end_user_id (sync)","deprecated":true,"version":null,"openapi":"https://app.herondata.io/swagger delete /api/end_users/{end_user_id_or_heron_id}","href":"/api-reference/endusers/delete-enduser-by-heron_id-or-end_user_id-sync"},{"title":"Delete EndUser by heron_id or end_user_id (async)","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/end_users/{end_user_id_or_heron_id}/delete","href":"/api-reference/endusers/delete-enduser-by-heron_id-or-end_user_id-async"},{"title":"Get EndUser emails","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_users/{end_user_id_or_heron_id}/emails","href":"/api-reference/endusers/get-enduser-emails-1"},{"title":"Get EndUser information","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_users/{end_user_id_or_heron_id}/end_user_information","href":"/api-reference/endusers/get-enduser-information"},{"title":"Patch EndUser information","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger patch /api/end_users/{end_user_id_or_heron_id}/end_user_information","href":"/api-reference/endusers/patch-enduser-information"},{"title":"Enrich transactions of EndUser","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/end_users/{end_user_id_or_heron_id}/enrich","href":"/api-reference/endusers/enrich-transactions-of-enduser"},{"title":"Get EndUser physical location","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_users/{end_user_id_or_heron_id}/location","href":"/api-reference/endusers/get-enduser-physical-location"},{"title":"Get EndUser processing status","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_users/{end_user_id_or_heron_id}/processing_status","href":"/api-reference/endusers/get-enduser-processing-status"},{"title":"Retrieve CRM sync events for an end user","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_users/{heron_id}/crm_sync","href":"/api-reference/endusers/retrieve-crm-sync-events-for-an-end-user"},{"title":"Trigger a CRM Sync for an End User","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/end_users/{heron_id}/crm_sync","href":"/api-reference/endusers/trigger-a-crm-sync-for-an-end-user"}]},{"group":"EndUserEmails","pages":[{"title":"Export an end user email as an EML file","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_user_emails/{heron_id}/export","href":"/api-reference/enduseremails/export-an-end-user-email-as-an-eml-file"}]},{"group":"EndUserEnrichers","pages":[{"title":"Start enricher execution for a specific end user asynchronously","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/end_user_enrichers/definitions/{enricher_definition_name}/start_enrich","href":"/api-reference/enduserenrichers/start-enricher-execution-for-a-specific-end-user-asynchronously"},{"title":"Get all fields for all enrichers for a given user","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_user_enrichers/fields","href":"/api-reference/enduserenrichers/get-all-fields-for-all-enrichers-for-a-given-user"},{"title":"Trigger enricher execution for a specific end user","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/end_user_enrichers/{end_user_heron_id}/enrich","href":"/api-reference/enduserenrichers/trigger-enricher-execution-for-a-specific-end-user"},{"title":"Get enrichment results for an end user","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_user_enrichers/{end_user_heron_id}/enricher_results","href":"/api-reference/enduserenrichers/get-enrichment-results-for-an-end-user"},{"title":"Get enricher result by enricher name and end user","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_user_enrichers/{end_user_heron_id}/enricher_results/{enricher_name}","href":"/api-reference/enduserenrichers/get-enricher-result-by-enricher-name-and-end-user"}]},{"group":"EndUserEntity","pages":[{"title":"Get the definitions for all end user entities","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_user_entities","href":"/api-reference/enduserentity/get-the-definitions-for-all-end-user-entities"},{"title":"Create an end user entity","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/end_user_entities","href":"/api-reference/enduserentity/create-an-end-user-entity"},{"title":"Export all saved attribute for all end users to an Excel file","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_user_entities/attribute_values/export","href":"/api-reference/enduserentity/export-all-saved-attribute-for-all-end-users-to-an-excel-file"},{"title":"Set the display order of end user entities","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger patch /api/end_user_entities/reorder","href":"/api-reference/enduserentity/set-the-display-order-of-end-user-entities"},{"title":"Create an end user entity attribute","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/end_user_entities/{entity_heron_id}/attributes","href":"/api-reference/enduserentity/create-an-end-user-entity-attribute"},{"title":"Set the display order of end user entity attributes","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger patch /api/end_user_entities/{entity_heron_id}/attributes/reorder","href":"/api-reference/enduserentity/set-the-display-order-of-end-user-entity-attributes"},{"title":"Delete an EndUserEntityAttribute","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger delete /api/end_user_entities/{entity_heron_id}/attributes/{attribute_heron_id}","href":"/api-reference/enduserentity/delete-an-enduserentityattribute"},{"title":"Update an end user entity","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger patch /api/end_user_entities/{entity_heron_id}/attributes/{attribute_heron_id}","href":"/api-reference/enduserentity/update-an-end-user-entity"},{"title":"Create an end user entity attribute","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/end_user_entities/{entity_heron_id}/attributes/{attribute_heron_id}/clone","href":"/api-reference/enduserentity/create-an-end-user-entity-attribute-1"},{"title":"Create an end user entity attribute source","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/end_user_entities/{entity_heron_id}/attributes/{attribute_heron_id}/sources","href":"/api-reference/enduserentity/create-an-end-user-entity-attribute-source"},{"title":"Delete an EndUserEntityAttribute","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger delete /api/end_user_entities/{entity_heron_id}/attributes/{attribute_heron_id}/sources/{source_heron_id}","href":"/api-reference/enduserentity/delete-an-enduserentityattribute-1"},{"title":"Upsert an end user entity","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger patch /api/end_user_entities/{entity_heron_id}/attributes/{attribute_heron_id}/sources/{source_heron_id}","href":"/api-reference/enduserentity/upsert-an-end-user-entity"},{"title":"Delete an EndUserEntity","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger delete /api/end_user_entities/{heron_id}","href":"/api-reference/enduserentity/delete-an-enduserentity"},{"title":"Update an end user entity","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger patch /api/end_user_entities/{heron_id}","href":"/api-reference/enduserentity/update-an-end-user-entity-1"},{"title":"Get the materialised end user entities for an end user","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_users/{end_user_heron_id}/entities","href":"/api-reference/enduserentity/get-the-materialised-end-user-entities-for-an-end-user"},{"title":"Bulk save entity attribute values by entity name and attribute name","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger put /api/end_users/{end_user_heron_id}/entities/values/bulk","href":"/api-reference/enduserentity/bulk-save-entity-attribute-values-by-entity-name-and-attribute-name"},{"title":"Upsert the attribute value for an end user entity attribute source","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/end_users/{end_user_heron_id}/entities/{entity_heron_id}","href":"/api-reference/enduserentity/upsert-the-attribute-value-for-an-end-user-entity-attribute-source"}]},{"group":"EndUserFiles","pages":[{"title":"All EndUserFiles","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_user_files","href":"/api-reference/enduserfiles/all-enduserfiles"},{"title":"Process file without creating EndUserFile record","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/end_user_files/process_standalone","href":"/api-reference/enduserfiles/process-file-without-creating-enduserfile-record"},{"title":"Get recent files by file class","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_user_files/recent_by_file_class","href":"/api-reference/enduserfiles/get-recent-files-by-file-class"},{"title":"Get file rename rules","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_user_files/rename_rules","href":"/api-reference/enduserfiles/get-file-rename-rules"},{"title":"Create a file rename rule","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/end_user_files/rename_rules","href":"/api-reference/enduserfiles/create-a-file-rename-rule"},{"title":"Get file rename rule variable slugs","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_user_files/rename_rules/slugs","href":"/api-reference/enduserfiles/get-file-rename-rule-variable-slugs"},{"title":"Update a file rename rule","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger patch /api/end_user_files/rename_rules/{heron_id}","href":"/api-reference/enduserfiles/update-a-file-rename-rule"},{"title":"Get a single end user file by Heron ID","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_user_files/{heron_id}","href":"/api-reference/enduserfiles/get-a-single-end-user-file-by-heron-id"},{"title":"Delete an EndUserFile","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger delete /api/end_user_files/{heron_id}","href":"/api-reference/enduserfiles/delete-an-enduserfile"},{"title":"Update the end user file's class","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger patch /api/end_user_files/{heron_id}","href":"/api-reference/enduserfiles/update-the-end-user-files-class"},{"title":"Get EndUserFile as a base64 string","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_user_files/{heron_id}/file","href":"/api-reference/enduserfiles/get-enduserfile-as-a-base64-string"},{"title":"Trigger async parsing of an end user file","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/end_user_files/{heron_id}/parse_file","href":"/api-reference/enduserfiles/trigger-async-parsing-of-an-end-user-file"},{"title":"Get parsed results from uploaded files","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_user_files/{heron_id}/parsed_results","href":"/api-reference/enduserfiles/get-parsed-results-from-uploaded-files"},{"title":"Trigger file's rename rule","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/end_user_files/{heron_id}/trigger_rename","href":"/api-reference/enduserfiles/trigger-files-rename-rule"},{"title":"Trigger splitting a combined end user file into its child files based on its page_classes","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/end_user_files/{heron_id}/trigger_split","href":"/api-reference/enduserfiles/trigger-splitting-a-combined-end-user-file-into-its-child-files-based-on-its-page_classes"},{"title":"Get EndUserFiles","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_users/{end_user_id_or_heron_id}/files","href":"/api-reference/enduserfiles/get-enduserfiles"},{"title":"Post EndUserFile","deprecated":true,"version":null,"openapi":"https://app.herondata.io/swagger post /api/end_users/{end_user_id_or_heron_id}/files","href":"/api-reference/enduserfiles/post-enduserfile"},{"title":"Download EndUserFiles","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_users/{end_user_id_or_heron_id}/files/download","href":"/api-reference/enduserfiles/download-enduserfiles"},{"title":"Download xlsx of parsed results from uploaded files","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_users/{end_user_id_or_heron_id}/files/parsed_results/xlsx","href":"/api-reference/enduserfiles/download-xlsx-of-parsed-results-from-uploaded-files"},{"title":"Get EndUserFile summaries","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_users/{end_user_id_or_heron_id}/files/summary","href":"/api-reference/enduserfiles/get-enduserfile-summaries"},{"title":"Post EndUserFile V2","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/end_users/{end_user_id_or_heron_id}/files/v2","href":"/api-reference/enduserfiles/post-enduserfile-v2"},{"title":"Start Workflow","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/end_users/{end_user_id_or_heron_id}/start_workflow","href":"/api-reference/enduserfiles/start-workflow"}]},{"group":"FileClass","pages":[{"title":"Get all file classes","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_user_files/file_classes","href":"/api-reference/fileclass/get-all-file-classes"},{"title":"Get file class groups enabled for a User","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/users/file_class_groups","href":"/api-reference/fileclass/get-file-class-groups-enabled-for-a-user"},{"title":"Get current file classes used in classification","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/users/file_classes","href":"/api-reference/fileclass/get-current-file-classes-used-in-classification"},{"title":"Add a FileClass to Classify for a User","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/users/file_classes/{file_class_name}","href":"/api-reference/fileclass/add-a-fileclass-to-classify-for-a-user"},{"title":"Remove a FileClass from Classification for a User","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger delete /api/users/file_classes/{file_class_name}","href":"/api-reference/fileclass/remove-a-fileclass-from-classification-for-a-user"}]},{"group":"EndUserQueries","pages":[]},{"group":"EndUserCalculations","pages":[{"title":"Get EndUser balance","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_users/balance","href":"/api-reference/endusercalculations/get-enduser-balance"},{"title":"Get EndUser forecasts","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_users/forecast","href":"/api-reference/endusercalculations/get-enduser-forecasts"},{"title":"Get EndUser statistics","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_users/statistics","href":"/api-reference/endusercalculations/get-enduser-statistics"},{"title":"Get EndUser anomalies","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_users/{end_user_id_or_heron_id}/anomalies","href":"/api-reference/endusercalculations/get-enduser-anomalies"},{"title":"Get EndUser bank statement summary","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_users/{end_user_id_or_heron_id}/bank_statement_summary","href":"/api-reference/endusercalculations/get-enduser-bank-statement-summary"},{"title":"Get EndUser metric benchmarks","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_users/{end_user_id_or_heron_id}/benchmarks","href":"/api-reference/endusercalculations/get-enduser-metric-benchmarks"},{"title":"Get EndUser debt candidates","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_users/{end_user_id_or_heron_id}/debt_candidates","href":"/api-reference/endusercalculations/get-enduser-debt-candidates"},{"title":"Export as a spreadsheet","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_users/{end_user_id_or_heron_id}/export_spreadsheet","href":"/api-reference/endusercalculations/export-as-a-spreadsheet"},{"title":"Get EndUser transactions grouped by counterparty or merchant","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_users/{end_user_id_or_heron_id}/grouped_transactions_report","href":"/api-reference/endusercalculations/get-enduser-transactions-grouped-by-counterparty-or-merchant"},{"title":"Get EndUser Heron Score (beta)","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_users/{end_user_id_or_heron_id}/heron_score","href":"/api-reference/endusercalculations/get-enduser-heron-score-beta"},{"title":"Get EndUser merchant summary","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_users/{end_user_id_or_heron_id}/merchant_summary","href":"/api-reference/endusercalculations/get-enduser-merchant-summary"},{"title":"Get EndUser named dates","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_users/{end_user_id_or_heron_id}/named_dates","href":"/api-reference/endusercalculations/get-enduser-named-dates"},{"title":"Get EndUser cashflow P\u0026L","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_users/{end_user_id_or_heron_id}/profit_and_loss","href":"/api-reference/endusercalculations/get-enduser-cashflow-p\u0026l"},{"title":"Update EndUser P\u0026L layout","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger put /api/end_users/{end_user_id_or_heron_id}/profit_and_loss_layout","href":"/api-reference/endusercalculations/update-enduser-p\u0026l-layout"},{"title":"Get EndUser recurring transactions report","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_users/{end_user_id_or_heron_id}/recurring_transactions_report","href":"/api-reference/endusercalculations/get-enduser-recurring-transactions-report"},{"title":"Get EndUser scorecard","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_users/{end_user_id_or_heron_id}/scorecard","href":"/api-reference/endusercalculations/get-enduser-scorecard"},{"title":"Request EndUser scorecard","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/end_users/{end_user_id_or_heron_id}/scorecard/async","href":"/api-reference/endusercalculations/request-enduser-scorecard"},{"title":"Get EndUser transaction data coverage","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_users/{end_user_id_or_heron_id}/transaction_data_coverage","href":"/api-reference/endusercalculations/get-enduser-transaction-data-coverage"}]},{"group":"EndUserAttributes","pages":[{"title":"Get EndUser attribute values","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_users/{end_user_heron_id}/company_attributes","href":"/api-reference/enduserattributes/get-enduser-attribute-values"}]},{"group":"EndUserAccounts","pages":[{"title":"Get Missing Accounts (beta)","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_users/{end_user_id_or_heron_id}/missing_accounts","href":"/api-reference/enduseraccounts/get-missing-accounts-beta"}]},{"group":"EnrichmentFeedback","pages":[{"title":"Bulk create category feedback for an end user","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/end_users/{end_user_id_or_heron_id}/bulk_category_feedback","href":"/api-reference/enrichmentfeedback/bulk-create-category-feedback-for-an-end-user"},{"title":"Bulk create merchant feedback for an end user","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/end_users/{end_user_id_or_heron_id}/merchant_feedback","href":"/api-reference/enrichmentfeedback/bulk-create-merchant-feedback-for-an-end-user"},{"title":"Revert merchant feedback for an end user","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/end_users/{end_user_id_or_heron_id}/merchant_feedback/revert","href":"/api-reference/enrichmentfeedback/revert-merchant-feedback-for-an-end-user"},{"title":"Create category, merchant feedback","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger put /api/transactions/{heron_id}/feedback","href":"/api-reference/enrichmentfeedback/create-category-merchant-feedback"}]},{"group":"EndUserFinancials","pages":[{"title":"Get EndUser's combined financials","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_users/{end_user_id_or_heron_id}/combined_financials","href":"/api-reference/enduserfinancials/get-endusers-combined-financials"}]},{"group":"EndUserIntegrations","pages":[{"title":"Upload DecisionLogic XML","description":"Upload DecisionLogic XML files for a specified end user to translate into Heron Data format and add transactions for the end user\n","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/end_users/{end_user_id_or_heron_id}/decision_logic","href":"/api-reference/enduserintegrations/upload-decisionlogic-xml"},{"title":"Upload Inscribe","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/end_users/{end_user_id_or_heron_id}/inscribe","href":"/api-reference/enduserintegrations/upload-inscribe"},{"title":"Get Integration Links","description":"Get a list of integration links for a specified end user\n","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_users/{end_user_id_or_heron_id}/integration_links","href":"/api-reference/enduserintegrations/get-integration-links"},{"title":"Upload Ocrolus","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/end_users/{end_user_id_or_heron_id}/ocrolus","href":"/api-reference/enduserintegrations/upload-ocrolus"},{"title":"Get PDFs","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_users/{end_user_id_or_heron_id}/pdfs","href":"/api-reference/enduserintegrations/get-pdfs"},{"title":"Parse all PDF","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/end_users/{end_user_id_or_heron_id}/pdfs/parse","href":"/api-reference/enduserintegrations/parse-all-pdf"},{"title":"Upload PDF","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/end_users/{end_user_id_or_heron_id}/pdfs/v1","href":"/api-reference/enduserintegrations/upload-pdf"},{"title":"Upload Plaid assets","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/end_users/{end_user_id_or_heron_id}/plaid/assets","href":"/api-reference/enduserintegrations/upload-plaid-assets"},{"title":"Upload Plaid transactions","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/end_users/{end_user_id_or_heron_id}/plaid/transactions","href":"/api-reference/enduserintegrations/upload-plaid-transactions"},{"title":"Upload Yodlee","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/end_users/{end_user_id_or_heron_id}/yodlee","href":"/api-reference/enduserintegrations/upload-yodlee"},{"title":"Get single PDF by heron_id","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/integrations/pdfs/{heron_id}","href":"/api-reference/enduserintegrations/get-single-pdf-by-heron_id"},{"title":"Update PDF attributes including status","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger put /api/integrations/pdfs/{heron_id}","href":"/api-reference/enduserintegrations/update-pdf-attributes-including-status"},{"title":"Send patch transactions for a pdf statement","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger patch /api/integrations/pdfs/{heron_id}/processed","href":"/api-reference/enduserintegrations/send-patch-transactions-for-a-pdf-statement"},{"title":"Reloads transactions for a pdf","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/integrations/pdfs/{heron_id}/reload_transactions","href":"/api-reference/enduserintegrations/reloads-transactions-for-a-pdf"},{"title":"Unloads transactions for a pdf","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/integrations/pdfs/{heron_id}/unload_transactions","href":"/api-reference/enduserintegrations/unloads-transactions-for-a-pdf"},{"title":"Update PDF currency","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/integrations/pdfs/{heron_id}/update_currency","href":"/api-reference/enduserintegrations/update-pdf-currency"}]},{"group":"EndUserRules","pages":[{"title":"Evaluate all rules for an end user","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_users/{end_user_id_or_heron_id}/evaluate_rules","href":"/api-reference/enduserrules/evaluate-all-rules-for-an-end-user"}]},{"group":"Integrations","pages":[{"title":"Send a Finicity Connect email to an end user","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/end_users/{end_user_id_or_heron_id}/finicity/connect","href":"/api-reference/integrations/send-a-finicity-connect-email-to-an-end-user"},{"title":"Trigger a cashflow report generation for an end user","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/end_users/{end_user_id_or_heron_id}/finicity/request_cashflow_report","href":"/api-reference/integrations/trigger-a-cashflow-report-generation-for-an-end-user"},{"title":"Trigger a statement reports generation for an end user","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/end_users/{end_user_id_or_heron_id}/finicity/request_statement_reports","href":"/api-reference/integrations/trigger-a-statement-reports-generation-for-an-end-user"},{"title":"Trigger a Finicity VOE transactions report generation for an end user","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/end_users/{end_user_id_or_heron_id}/finicity/request_voe_transactions_report","href":"/api-reference/integrations/trigger-a-finicity-voe-transactions-report-generation-for-an-end-user"},{"title":"Update an Integration Link","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger put /api/integration_links/{item_id}","href":"/api-reference/integrations/update-an-integration-link"},{"title":"List Integrations","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/integrations","href":"/api-reference/integrations/list-integrations"},{"title":"Create an integration","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/integrations","href":"/api-reference/integrations/create-an-integration"},{"title":"Update Integration","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger put /api/integrations/{heron_id}","href":"/api-reference/integrations/update-integration"},{"title":"Get IntegrationLinks by Integration","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/integrations/{heron_id}/links","href":"/api-reference/integrations/get-integrationlinks-by-integration"},{"title":"Refresh assets reports for integration links","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger put /api/integrations/{heron_id}/links","href":"/api-reference/integrations/refresh-assets-reports-for-integration-links"},{"title":"Create an integration Link","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/integrations/{heron_id}/links","href":"/api-reference/integrations/create-an-integration-link"},{"title":"(Soft-)Delete an integration link","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger delete /api/integrations/{heron_id}/links","href":"/api-reference/integrations/soft-delete-an-integration-link"},{"title":"Refresh an IntegrationLink","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/integrations/{heron_id}/links/{link_item_id}/refresh","href":"/api-reference/integrations/refresh-an-integrationlink"}]},{"group":"ISOApplication","pages":[{"title":"Upload an ISO application PDF for for an end user","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/end_users/{end_user_id_or_heron_id}/iso_application_form","href":"/api-reference/isoapplication/upload-an-iso-application-pdf-for-for-an-end-user"},{"title":"Get EndUser ISO Applications","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_users/{end_user_id_or_heron_id}/iso_applications","href":"/api-reference/isoapplication/get-enduser-iso-applications"},{"title":"Upload an ISO application PDF for automated scrubbing in under 15 seconds","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/iso_applications/","href":"/api-reference/isoapplication/upload-an-iso-application-pdf-for-automated-scrubbing-in-under-15-seconds"},{"title":"Upload an ISO application PDF for automated scrubbing in under 15 seconds (base64)","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/iso_applications/base64","href":"/api-reference/isoapplication/upload-an-iso-application-pdf-for-automated-scrubbing-in-under-15-seconds-base64"},{"title":"Reprocess a single ISO application","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/iso_applications/reprocess/{heron_id}","href":"/api-reference/isoapplication/reprocess-a-single-iso-application"},{"title":"Get the scrubbed results and data validations of an uploaded ISO application by its heron_id (prefixed \"iso_\")","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/iso_applications/{heron_id}","href":"/api-reference/isoapplication/get-the-scrubbed-results-and-data-validations-of-an-uploaded-iso-application-by-its-heron_id-prefixed-\"iso_\""}]},{"group":"Positions","pages":[{"title":"Get positions summary for end user","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_users/{end_user_id_or_heron_id}/positions","href":"/api-reference/positions/get-positions-summary-for-end-user"},{"title":"Get edits that no longer apply","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_users/{end_user_id_or_heron_id}/positions/stale_overrides","href":"/api-reference/positions/get-edits-that-no-longer-apply"},{"title":"Apply an edit that no longer applies to a rebuilt position","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/position_overrides/{override_heron_id}/reannotate","href":"/api-reference/positions/apply-an-edit-that-no-longer-applies-to-a-rebuilt-position"},{"title":"Get a position's edit history","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/positions/{position_heron_id}/overrides","href":"/api-reference/positions/get-a-positions-edit-history"},{"title":"Override a position's status, frequency or payment amount","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/positions/{position_heron_id}/overrides","href":"/api-reference/positions/override-a-positions-status-frequency-or-payment-amount"},{"title":"Remove a position's override","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger delete /api/positions/{position_heron_id}/overrides","href":"/api-reference/positions/remove-a-positions-override"},{"title":"Get transactions for a specific position","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/positions/{position_heron_id}/transactions","href":"/api-reference/positions/get-transactions-for-a-specific-position"}]},{"group":"Tags","pages":[{"title":"List an end user's tags","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_users/{end_user_id_or_heron_id}/tags","href":"/api-reference/tags/list-an-end-users-tags"},{"title":"Replace an end user's tags","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger put /api/end_users/{end_user_id_or_heron_id}/tags","href":"/api-reference/tags/replace-an-end-users-tags"},{"title":"Add tags to an end user","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/end_users/{end_user_id_or_heron_id}/tags","href":"/api-reference/tags/add-tags-to-an-end-user"},{"title":"Remove a tag from an end user","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger delete /api/end_users/{end_user_id_or_heron_id}/tags/{tag_heron_id}","href":"/api-reference/tags/remove-a-tag-from-an-end-user"},{"title":"List tags","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/tags","href":"/api-reference/tags/list-tags"},{"title":"Create a tag","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/tags","href":"/api-reference/tags/create-a-tag"},{"title":"Get a tag","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/tags/{heron_id}","href":"/api-reference/tags/get-a-tag"},{"title":"Delete a tag","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger delete /api/tags/{heron_id}","href":"/api-reference/tags/delete-a-tag"},{"title":"Update a tag","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger patch /api/tags/{heron_id}","href":"/api-reference/tags/update-a-tag"}]},{"group":"EnrichedTransactions","pages":[{"title":"Get end user transactions","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/end_users/{end_user_id_or_heron_id}/transactions","href":"/api-reference/enrichedtransactions/get-end-user-transactions"},{"title":"Get apitransactions","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/transactions/{reference_id_or_heron_id}","href":"/api-reference/enrichedtransactions/get-apitransactions"}]},{"group":"Transactions","pages":[{"title":"Create end user transactions (async)","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/end_users/{end_user_id_or_heron_id}/transactions","href":"/api-reference/transactions/create-end-user-transactions-async"},{"title":"Get apitransactions","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/transactions","href":"/api-reference/transactions/get-apitransactions"},{"title":"Enrich transactions (sync)","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/transactions","href":"/api-reference/transactions/enrich-transactions-sync"},{"title":"Delete transactions","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger delete /api/transactions","href":"/api-reference/transactions/delete-transactions"}]},{"group":"Funders","pages":[{"title":"Search funders by name","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/funders/","href":"/api-reference/funders/search-funders-by-name"},{"title":"List your linked funders","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/funders/linked","href":"/api-reference/funders/list-your-linked-funders"},{"title":"Get a single funder","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/funders/{heron_id}","href":"/api-reference/funders/get-a-single-funder"}]},{"group":"Interaction Logs","pages":[]},{"group":"MCP endpoints","pages":[]},{"group":"Merchants","pages":[{"title":"Extract merchant","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/merchants/extract","href":"/api-reference/merchants/extract-merchant"},{"title":"List merchant groups","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/merchants/groups","href":"/api-reference/merchants/list-merchant-groups"},{"title":"List merchants","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/merchants/list","href":"/api-reference/merchants/list-merchants"},{"title":"Search merchants","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/merchants/search","href":"/api-reference/merchants/search-merchants"},{"title":"Get merchant by ID","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/merchants/{heron_id}","href":"/api-reference/merchants/get-merchant-by-id"},{"title":"Set merchant group override","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger patch /api/merchants/{merchant_heron_id}/user_merchant_group","href":"/api-reference/merchants/set-merchant-group-override"}]},{"group":"OAuth","pages":[]},{"group":"Policy Versions","pages":[{"title":"List policy versions","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/policy_version","href":"/api-reference/policy-versions/list-policy-versions"},{"title":"Create a draft policy version with new check values","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger patch /api/policy_version/draft/check","href":"/api-reference/policy-versions/create-a-draft-policy-version-with-new-check-values"},{"title":"Publish the draft policy version","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/policy_version/publish","href":"/api-reference/policy-versions/publish-the-draft-policy-version"},{"title":"Get a policy version","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/policy_version/{version}","href":"/api-reference/policy-versions/get-a-policy-version"}]},{"group":"Policy Backtests","pages":[]},{"group":"Rules","pages":[{"title":"Get rules","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/rules/","href":"/api-reference/rules/get-rules"},{"title":"Create a single rule","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/rules/","href":"/api-reference/rules/create-a-single-rule"},{"title":"Get metrics","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/rules/metrics","href":"/api-reference/rules/get-metrics"},{"title":"Update rule by heron_id","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger put /api/rules/{heron_id}","href":"/api-reference/rules/update-rule-by-heron_id"},{"title":"Delete rule by heron_id","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger delete /api/rules/{heron_id}","href":"/api-reference/rules/delete-rule-by-heron_id"}]},{"group":"ParsedEndUserSubmission","pages":[{"title":"Get parsed submissions for an End User","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/submission_parsers/{end_user_heron_id}","href":"/api-reference/parsedendusersubmission/get-parsed-submissions-for-an-end-user"}]},{"group":"UserMerchantGroups","pages":[{"title":"This endpoint returns merchant groups categorized as pending, custom, or rejected.","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/user_merchant_groups","href":"/api-reference/usermerchantgroups/this-endpoint-returns-merchant-groups-categorized-as-pending-custom-or-rejected"}]},{"group":"Users","pages":[{"title":"Get user's company overview layout","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/users/company_overview_layout","href":"/api-reference/users/get-users-company-overview-layout"},{"title":"Save user's company overview layout","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger put /api/users/company_overview_layout","href":"/api-reference/users/save-users-company-overview-layout"},{"title":"Save user's settings","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger put /api/users/current/settings","href":"/api-reference/users/save-users-settings"}]},{"group":"Watermarks","pages":[{"title":"Retrieve user logo","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/watermarks/logo","href":"/api-reference/watermarks/retrieve-user-logo"},{"title":"Upload user logo","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/watermarks/logo","href":"/api-reference/watermarks/upload-user-logo"}]},{"group":"Webhooks","pages":[{"title":"Get webhooks","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/webhooks","href":"/api-reference/webhooks/get-webhooks"},{"title":"Create a webhook","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/webhooks","href":"/api-reference/webhooks/create-a-webhook"},{"title":"List webhook delivery attempts","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/webhooks/deliveries","href":"/api-reference/webhooks/list-webhook-delivery-attempts"},{"title":"Resend failed webhook deliveries","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/webhooks/deliveries/resend","href":"/api-reference/webhooks/resend-failed-webhook-deliveries"},{"title":"Get a webhook delivery attempt","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/webhooks/deliveries/{heron_id}","href":"/api-reference/webhooks/get-a-webhook-delivery-attempt"},{"title":"Get webhook topics","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/webhooks/topics","href":"/api-reference/webhooks/get-webhook-topics"},{"title":"Update a webhook","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger put /api/webhooks/{heron_id}","href":"/api-reference/webhooks/update-a-webhook"},{"title":"Delete a webhook","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger delete /api/webhooks/{heron_id}","href":"/api-reference/webhooks/delete-a-webhook"}]},{"group":"Workflows","pages":[{"title":"Start a workflow by Heron ID for an end user","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/workflow/start_by_heron_id","href":"/api-reference/workflows/start-a-workflow-by-heron-id-for-an-end-user"},{"title":"Start a workflow by name for an end user","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger post /api/workflow/start_by_name","href":"/api-reference/workflows/start-a-workflow-by-name-for-an-end-user"},{"title":"List workflows for the current user","deprecated":null,"version":null,"openapi":"https://app.herondata.io/swagger get /api/workflow/user/workflows","href":"/api-reference/workflows/list-workflows-for-the-current-user"}]}]}]},"title":"Upload Inscribe - Heron","buildId":"dpl_2xiSHD9XEvLsPGPcfoMtkLTB3dy9","deploymentId":"dpl_2xiSHD9XEvLsPGPcfoMtkLTB3dy9","dynamics":["c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["OpenApiReferenceProvider-DmVyH30O.js","utils-BHQqGGOd.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-CD-E4BIt.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Bp5Lq9Ds.js","snippetPresets-C4xAVCFP.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","Page-CBCH2P7b.js","ApiExamples-CgXVLxUC.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BF8I5oUf.js","shallow-Byd0lWnC.js","getApiPlaygroundDisplay-BGOZG1OK.js","CodeSnippet-CpvQL0CY.js","CodeSnippets-B8wkBKXa.js","getPastedJson-Ry3scI3Y.js","icon-D7a9HcdD.js","MethodPill-CJ8pmHhz.js","DuplicateIcon-rh1HJF0t.js","createIcon-DvGznqYs.js","DynamicMarkdown-Cc6AuSHS.js","SectionHeading-B4A0S-ep.js","axios-vUo_bRtp.js","Markdown-Cc16CX65.js","clsx-Cs6nMGht.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-zbf22OZA.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-C_fs-y5n.js"]}