{"docsConfig":{"$schema":"https://mintlify.com/docs.json","theme":"mint","name":"PathStack","colors":{"primary":"#2047FA","light":"#203dfa","dark":"#2047FA"},"favicon":"https://mintcdn.com/nuonic-39/IvvWU3allt6PGoB1/favicon.png?fit=max\u0026auto=format\u0026n=IvvWU3allt6PGoB1\u0026q=85\u0026s=13af1d1deb3e464f07af03b3c326ddd3","logo":{"light":"https://mintcdn.com/nuonic-39/syOOuB1ZSGS1zaSD/logo/light.png?fit=max\u0026auto=format\u0026n=syOOuB1ZSGS1zaSD\u0026q=85\u0026s=9b03c378d1fa1bbd0bfce37ccf17175c","dark":"https://mintcdn.com/nuonic-39/syOOuB1ZSGS1zaSD/logo/dark.png?fit=max\u0026auto=format\u0026n=syOOuB1ZSGS1zaSD\u0026q=85\u0026s=2e04739478900956a06ad5d8f726dfb1","href":"https://pathstack.io"},"api":{"openapi":["api-reference/openapi_2024-03-27.json","api-reference/openapi_2024-03-26.json"]},"navbar":{"links":[{"label":"Support","href":"mailto:support@pathstack.io"}],"primary":{"type":"button","label":"Sign up","href":"https://pathstack.io/register"}},"footer":{"socials":{"linkedin":"https://au.linkedin.com/company/nuonic"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"nuonic-39","hasAudioNarration":false,"actualSubdomain":"nuonic-39","customDomains":["docs.pathstack.io"],"gitSource":{"type":"github","owner":"nuonic","repo":"midland-docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6aa22862cf3ab925e991028c","collectionId":"26a2fba7-04c9-4265-8a37-e8d2acf3166e","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6aa22862cf3ab925e991028c"},"entitlements":{},"buildId":"6aa22862cf3ab925e991028c","clientVersion":"0.0.3971","searchFilterCounts":[{"language":"default","tag":"API Reference","count":83},{"language":"default","tag":"Endpoints","count":82},{"language":"default","tag":"Provider access guides","count":18},{"language":"default","tag":"Connections","count":14},{"language":"default","tag":"Milestones","count":12},{"language":"default","tag":"Documentation","count":12},{"language":"default","tag":"Devices","count":10},{"language":"default","tag":"Webhooks","count":10},{"language":"default","tag":"Legal","count":10},{"language":"default","tag":"Guides","count":9}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-v7-file-tree","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/2024-03-27/consumer/create-share-request","slug":"/api-reference/2024-03-27/consumer/create-share-request","pageMetadata":{"openapi":"openapi_2024-03-27 post /consumer/connection/share_request","title":"Create Share Request","description":"This endpoint creates a Share Request.\n\nThe created Share Request is returned in the response.","href":"/api-reference/2024-03-27/consumer/create-share-request"},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"This endpoint creates a Share Request.\"\n }), \"\\n\", _jsx(_components.p, {\n children: \"The created Share Request is returned in the response.\"\n })]\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":{"openapi":"openapi_2024-03-27 post /consumer/connection/share_request","title":"Create Share Request","description":"This endpoint creates a Share Request.\n\nThe created Share Request is returned in the response.","href":"/api-reference/2024-03-27/consumer/create-share-request"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Consumer"],"summary":"Create Share Request","description":"This endpoint creates a Share Request.\n\nThe created Share Request is returned in the response.","operationId":"create_share_request_consumer_connection_share_request_post","security":["0c621341-5c16-4f90-b3e4-806cf85964b4"],"parameters":["7ae62649-e530-45ce-8802-34160cb40475"],"requestBody":"eb1fd227-d416-41ee-81b8-5ba3663e7e62","responses":{"200":"dab7251f-0317-4d6c-92e5-809e111a7250","400":"51a30234-c88d-4d37-8c5c-63d8a8d9be7a","401":"1e77d113-a354-4fd8-bd00-8b64bd5ccbe0","403":"95ce619a-6ce6-4760-b048-b09b743ba92f","422":"00c06246-2f55-4616-8eea-d509cb6e3a24"},"method":"post","type":"path","servers":["d1803bc1-eb91-4a2e-b2b3-a72ddd7dd766"],"path":"/consumer/connection/share_request","baseUrlOptions":["https://api.pathstack.io"],"title":"Create Share Request","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"7ae62649-e530-45ce-8802-34160cb40475":{"name":"x-api-version","in":"header","required":false,"schema":{"type":"string","format":"date","default":"2024-03-27","title":"X-Api-Version","isRequired":false,"uniqueKey":"","typeLabel":"string\u003cdate>"},"examples":{"default":{"value":"2024-03-27"}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"email":{"type":"string","format":"email","title":"Email","isRequired":true,"uniqueKey":"email","typeLabel":"string\u003cemail>"},"filter":{"oneOf":[{"type":"object","title":"Filter","additionalProperties":true,"uniqueKey":"filter.oneOf.0","typeLabel":"Filter · object"},{"type":"null","title":"Filter","uniqueKey":"filter.oneOf.1","typeLabel":"null"}],"uniqueKey":"filter","typeLabel":"Filter · object | null"}},"type":"object","required":["email"],"title":"ShareRequestInput","uniqueKey":"","typeLabel":"ShareRequestInput · object"},"examples":{"Example":{"title":"Example","value":{"email":"jsmith@example.com","filter":{}}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"dab7251f-0317-4d6c-92e5-809e111a7250":{"description":"Successful Response","content":{"application/json":{"schema":{"properties":{"data":{"properties":{"id":{"type":"string","format":"uuid4","title":"Id","isRequired":true,"uniqueKey":"data.id","typeLabel":"string\u003cuuid4>"},"created_at":{"type":"string","title":"Created At","isRequired":true,"uniqueKey":"data.created_at","typeLabel":"string"},"responded_at":{"oneOf":[{"type":"string","title":"Responded At","isRequired":true,"uniqueKey":"data.responded_at.oneOf.0","typeLabel":"string"},{"type":"null","title":"Responded At","isRequired":true,"uniqueKey":"data.responded_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.responded_at","typeLabel":"string | null"},"consumer_tenant":{"properties":{"id":{"type":"string","format":"uuid4","title":"Id","isRequired":true,"uniqueKey":"data.consumer_tenant.id","typeLabel":"string\u003cuuid4>"},"name":{"type":"string","title":"Name","isRequired":true,"uniqueKey":"data.consumer_tenant.name","typeLabel":"string"}},"type":"object","required":["id","name"],"title":"ConsumerTenant","isRequired":true,"uniqueKey":"data.consumer_tenant","typeLabel":"ConsumerTenant · object"},"provider_email":{"type":"string","format":"email","title":"Provider Email","isRequired":true,"uniqueKey":"data.provider_email","typeLabel":"string\u003cemail>"},"provider_tenant_id":{"oneOf":[{"type":"string","title":"Provider Tenant Id","format":"uuid4","isRequired":true,"uniqueKey":"data.provider_tenant_id.oneOf.0","typeLabel":"string\u003cuuid4>"},{"type":"null","title":"Provider Tenant Id","isRequired":true,"uniqueKey":"data.provider_tenant_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.provider_tenant_id","typeLabel":"string\u003cuuid4> | null"},"filter_id":{"type":"string","format":"uuid4","title":"Filter Id","isRequired":true,"uniqueKey":"data.filter_id","typeLabel":"string\u003cuuid4>"},"share_code":{"type":"string","title":"Share Code","isRequired":true,"uniqueKey":"data.share_code","typeLabel":"string"},"accepted":{"oneOf":[{"type":"boolean","title":"Accepted","isRequired":true,"uniqueKey":"data.accepted.oneOf.0","typeLabel":"boolean"},{"type":"null","title":"Accepted","isRequired":true,"uniqueKey":"data.accepted.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.accepted","typeLabel":"boolean | null"}},"type":"object","required":["id","created_at","responded_at","consumer_tenant","provider_email","provider_tenant_id","filter_id","share_code","accepted"],"title":"ShareRequest","description":"Successful response payload","isRequired":true,"uniqueKey":"data","typeLabel":"ShareRequest · object"}},"type":"object","required":["data"],"title":"Success[ShareRequest]","uniqueKey":"","typeLabel":"Success[ShareRequest] · object"},"examples":{"Example":{"title":"Example","value":{"data":{"id":"\u003cstring>","created_at":"\u003cstring>","responded_at":"\u003cstring>","consumer_tenant":{"id":"\u003cstring>","name":"\u003cstring>"},"provider_email":"jsmith@example.com","provider_tenant_id":"\u003cstring>","filter_id":"\u003cstring>","share_code":"\u003cstring>","accepted":true}}}},"exampleType":"generated"}},"exampleType":"generated"},"51a30234-c88d-4d37-8c5c-63d8a8d9be7a":{"content":{"application/json":{"schema":{"properties":{"error":{"type":"object","properties":{"code":{"type":"integer","example":400,"title":"Error code","uniqueKey":"error.code","typeLabel":"integer"},"message":{"type":"string","example":"Invalid JWT format","title":"Error message","uniqueKey":"error.message","typeLabel":"string"}},"uniqueKey":"error","typeLabel":"object"}},"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":400,"message":"Invalid JWT format"}}}},"exampleType":"generated"}},"description":"Bad Request","exampleType":"generated"},"1e77d113-a354-4fd8-bd00-8b64bd5ccbe0":{"content":{"application/json":{"schema":{"properties":{"error":{"type":"object","properties":{"code":{"type":"integer","example":401,"title":"Error code","uniqueKey":"error.code","typeLabel":"integer"},"message":{"type":"string","example":"Authentication header is missing, or token is invalid/expired.","title":"Error message","uniqueKey":"error.message","typeLabel":"string"}},"uniqueKey":"error","typeLabel":"object"}},"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":401,"message":"Authentication header is missing, or token is invalid/expired."}}}},"exampleType":"generated"}},"description":"Unauthorized","exampleType":"generated"},"95ce619a-6ce6-4760-b048-b09b743ba92f":{"content":{"application/json":{"schema":{"properties":{"error":{"type":"object","properties":{"code":{"type":"integer","example":403,"title":"Error code","uniqueKey":"error.code","typeLabel":"integer"},"message":{"type":"string","example":"You do not have access to this resource","title":"Error message","uniqueKey":"error.message","typeLabel":"string"}},"uniqueKey":"error","typeLabel":"object"}},"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":403,"message":"You do not have access to this resource"}}}},"exampleType":"generated"}},"description":"Forbidden","exampleType":"generated"},"00c06246-2f55-4616-8eea-d509cb6e3a24":{"content":{"application/json":{"schema":{"properties":{"error":{"type":"object","properties":{"code":{"type":"integer","example":422,"title":"Error code","uniqueKey":"error.code","typeLabel":"integer"},"message":{"type":"string","example":"Field required","title":"Error message","uniqueKey":"error.message","typeLabel":"string"},"loc":{"items":{"oneOf":[{"type":"string","uniqueKey":"error.loc.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"integer","uniqueKey":"error.loc.items.[INDEX].oneOf.1","typeLabel":"integer"}],"uniqueKey":"error.loc.items.[INDEX]","typeLabel":"string | integer"},"type":"array","title":"Location","uniqueKey":"error.loc","typeLabel":"(string | integer)[]"},"msg":{"type":"string","title":"Message","uniqueKey":"error.msg","typeLabel":"string"},"type":{"type":"string","title":"Error Type","uniqueKey":"error.type","typeLabel":"string"}},"uniqueKey":"error","typeLabel":"object"}},"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":422,"message":"Field required","loc":["\u003cstring>"],"msg":"\u003cstring>","type":"\u003cstring>"}}}},"exampleType":"generated"}},"description":"Unprocessable Entity","exampleType":"generated"}},"security":{"0c621341-5c16-4f90-b3e4-806cf85964b4":{"JWTBearer":{"type":"http","scheme":"bearer","scopes":[]}}},"servers":{"d1803bc1-eb91-4a2e-b2b3-a72ddd7dd766":{"url":"https://api.pathstack.io","description":"PathStack production environment"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","scopes":[]},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"JWTBearer","name":"Authorization"}],"title":"JWTBearer"}]},"originalFileLocation":"api-reference/openapi_2024-03-27.json"},"subdomain":"nuonic-39","siteName":"PathStack","title":"Create Share Request - PathStack","navMaps":{"firstHrefInVersion":{"2024-03-27":{"href":"/api-reference/2024-03-27/consumer/create-share-request","matchLevel":0},"2024-03-26":{"href":"/api-reference/2024-03-26/consumer/create-share-request","matchLevel":1}},"firstHrefInLanguage":{}},"lastModified":"2025-09-09T05:07:59.591Z","originalFileLocation":"api-reference/2024-03-27/consumer/create-share-request.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=\"This endpoint creates a Share Request. The created Share Request is returned in the response.\">\u003cmeta data-mint-head name=\"application-name\" content=\"PathStack\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/nuonic-39/fYQpJWsv94JQUvWa/_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/nuonic-39/fYQpJWsv94JQUvWa/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/nuonic-39/fYQpJWsv94JQUvWa/_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/nuonic-39/fYQpJWsv94JQUvWa/_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/nuonic-39/fYQpJWsv94JQUvWa/_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/nuonic-39/fYQpJWsv94JQUvWa/_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/nuonic-39/fYQpJWsv94JQUvWa/_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/nuonic-39/fYQpJWsv94JQUvWa/_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/nuonic-39/fYQpJWsv94JQUvWa/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create Share Request - PathStack\">\u003cmeta data-mint-head property=\"og:description\" content=\"This endpoint creates a Share Request. The created Share Request is returned in the response.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"PathStack\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.pathstack.io/api-reference/2024-03-27/consumer/create-share-request\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://nuonic-39.mintlify.app/_mintlify/api/og/v2?division=Consumer\u0026amp;title=Create+Share+Request\u0026amp;description=This+endpoint+creates+a+Share+Request.%0A%0AThe+created+Share+Request+is+returned+in+the+response.\u0026amp;theme=cb7cc1e2641545070c649087\u0026amp;signature=d18df1a6531206956b4c5ca0dd4fdc1a172c5a37c7e614835ab7703968c0299b\">\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=\"Create Share Request - PathStack\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"This endpoint creates a Share Request. The created Share Request is returned in the response.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://nuonic-39.mintlify.app/_mintlify/api/og/v2?division=Consumer\u0026amp;title=Create+Share+Request\u0026amp;description=This+endpoint+creates+a+Share+Request.%0A%0AThe+created+Share+Request+is+returned+in+the+response.\u0026amp;theme=cb7cc1e2641545070c649087\u0026amp;signature=d18df1a6531206956b4c5ca0dd4fdc1a172c5a37c7e614835ab7703968c0299b\">\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/nuonic-39/fYQpJWsv94JQUvWa/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"PathStack\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#2047FA\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.pathstack.io/api-reference/2024-03-27/consumer/create-share-request\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/2024-03-27/consumer/create-share-request.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.pathstack.io/#organization\",\"name\":\"PathStack\",\"url\":\"https://docs.pathstack.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/nuonic-39/syOOuB1ZSGS1zaSD/logo/light.png?fit=max\u0026auto=format\u0026n=syOOuB1ZSGS1zaSD\u0026q=85\u0026s=9b03c378d1fa1bbd0bfce37ccf17175c\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.pathstack.io#website\",\"name\":\"PathStack\",\"url\":\"https://docs.pathstack.io\",\"publisher\":{\"@id\":\"https://docs.pathstack.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.pathstack.io/api-reference/2024-03-27/consumer/create-share-request#webpage\",\"url\":\"https://docs.pathstack.io/api-reference/2024-03-27/consumer/create-share-request\",\"name\":\"Create Share Request\",\"description\":\"This endpoint creates a Share Request. The created Share Request is returned in the response.\",\"dateModified\":\"2025-09-09T05:07:59.591Z\",\"isPartOf\":{\"@id\":\"https://docs.pathstack.io#website\"},\"breadcrumb\":{\"@id\":\"https://docs.pathstack.io/api-reference/2024-03-27/consumer/create-share-request#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.pathstack.io/api-reference/2024-03-27/consumer/create-share-request#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Endpoints\",\"item\":\"https://docs.pathstack.io/api-reference/2024-03-27/account/account-summary\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Consumer\",\"item\":\"https://docs.pathstack.io/api-reference/2024-03-27/consumer/get-share-requests\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Create Share Request\",\"item\":\"https://docs.pathstack.io/api-reference/2024-03-27/consumer/create-share-request\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.pathstack.io/api-reference/2024-03-27/consumer/create-share-request#apireference\",\"headline\":\"Create Share Request\",\"name\":\"Create Share Request\",\"description\":\"This endpoint creates a Share Request. The created Share Request is returned in the response.\",\"url\":\"https://docs.pathstack.io/api-reference/2024-03-27/consumer/create-share-request\",\"mainEntityOfPage\":{\"@id\":\"https://docs.pathstack.io/api-reference/2024-03-27/consumer/create-share-request#webpage\"},\"dateModified\":\"2025-09-09T05:07:59.591Z\",\"publisher\":{\"@id\":\"https://docs.pathstack.io/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.pathstack.io#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"PathStack\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"PathStack","nav":{"global":null,"versions":[{"version":"2024-03-27","tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/introduction"}]},{"tab":"API Reference","groups":[{"group":"API Documentation","pages":[{"title":"Introduction","href":"/api-reference/introduction"}]},{"group":"Endpoints","pages":[{"group":"Account","pages":[{"openapi":"openapi_2024-03-27 get /account/summary","title":"Account Summary","href":"/api-reference/2024-03-27/account/account-summary"},{"openapi":"openapi_2024-03-27 get /account/activity-summary","title":"Account Activity Summary","href":"/api-reference/2024-03-27/account/account-activity-summary"}]},{"group":"Auth","pages":[{"openapi":"openapi_2024-03-27 post /token","title":"Login","href":"/api-reference/2024-03-27/auth/login"},{"openapi":"openapi_2024-03-27 post /refresh","title":"Refresh","href":"/api-reference/2024-03-27/auth/refresh"}]},{"group":"Connections","pages":[{"openapi":"openapi_2024-03-27 get /connection","title":"Connections","href":"/api-reference/2024-03-27/connections/connections"},{"openapi":"openapi_2024-03-27 post /connection","title":"Create Connection","href":"/api-reference/2024-03-27/connections/create-connection"},{"openapi":"openapi_2024-03-27 get /connection/{connection_id}","title":"Connection By Id","href":"/api-reference/2024-03-27/connections/connection-by-id"},{"openapi":"openapi_2024-03-27 patch /connection/{connection_id}","title":"Update Connection","href":"/api-reference/2024-03-27/connections/update-connection"},{"openapi":"openapi_2024-03-27 get /connection/{connection_id}/credentials","title":"Connection Credentials By Id","href":"/api-reference/2024-03-27/connections/connection-credentials-by-id"},{"openapi":"openapi_2024-03-27 patch /connection/{connection_id}/credentials","title":"Update Connection Credentials","href":"/api-reference/2024-03-27/connections/update-connection-credentials"},{"openapi":"openapi_2024-03-27 get /connection-tag","title":"List Connection Tags","href":"/api-reference/2024-03-27/connections/list-connection-tags"}]},{"group":"Devices","pages":[{"openapi":"openapi_2024-03-27 get /device","title":"Devices","href":"/api-reference/2024-03-27/devices/devices"},{"openapi":"openapi_2024-03-27 post /device","title":"Create Device","href":"/api-reference/2024-03-27/devices/create-device"},{"openapi":"openapi_2024-03-27 get /device/{device_id}","title":"Device By Id","href":"/api-reference/2024-03-27/devices/device-by-id"},{"openapi":"openapi_2024-03-27 delete /device/{device_id}","title":"Delete Device By Id","href":"/api-reference/2024-03-27/devices/delete-device-by-id"},{"openapi":"openapi_2024-03-27 patch /device/{device_id}","title":"Update Device By Id","href":"/api-reference/2024-03-27/devices/update-device-by-id"}]},{"group":"Trips","pages":[{"openapi":"openapi_2024-03-27 get /device/{device_id}/trip","title":"Trips","href":"/api-reference/2024-03-27/trips/trips"},{"openapi":"openapi_2024-03-27 get /trip/{trip_id}","title":"Trip By Id","href":"/api-reference/2024-03-27/trips/trip-by-id"}]},{"group":"Positions","pages":[{"openapi":"openapi_2024-03-27 get /device/{device_id}/position","title":"Positions","href":"/api-reference/2024-03-27/positions/positions"},{"openapi":"openapi_2024-03-27 get /trip/{trip_id}/position","title":"Positions By Trip Id","href":"/api-reference/2024-03-27/positions/positions-by-trip-id"}]},{"group":"Real-time","pages":[{"openapi":"openapi_2024-03-27 post /realtime/device","title":"Get Realtime Positions","href":"/api-reference/2024-03-27/real-time/get-realtime-positions"},{"openapi":"openapi_2024-03-27 get /realtime/connect","title":"Get Connect","href":"/api-reference/2024-03-27/real-time/get-connect"}]},{"group":"Webhooks","pages":[{"openapi":"openapi_2024-03-27 get /webhook","title":"Get Webhooks","href":"/api-reference/2024-03-27/webhooks/get-webhooks"},{"openapi":"openapi_2024-03-27 post /webhook","title":"Create Webhook","href":"/api-reference/2024-03-27/webhooks/create-webhook"},{"openapi":"openapi_2024-03-27 get /webhook/{webhook_id}","title":"Get Webhook","href":"/api-reference/2024-03-27/webhooks/get-webhook"},{"openapi":"openapi_2024-03-27 delete /webhook/{webhook_id}","title":"Delete Webhook","href":"/api-reference/2024-03-27/webhooks/delete-webhook"},{"openapi":"openapi_2024-03-27 patch /webhook/{webhook_id}","title":"Patch Webhook","href":"/api-reference/2024-03-27/webhooks/patch-webhook"}]},{"group":"Tags","pages":[{"openapi":"openapi_2024-03-27 get /tag","title":"Get Tags","href":"/api-reference/2024-03-27/tags/get-tags"}]},{"group":"Events","pages":[{"openapi":"openapi_2024-03-27 get /device/{device_id}/event","title":"Events","href":"/api-reference/2024-03-27/events/events"},{"openapi":"openapi_2024-03-27 get /event/{event_id}","title":"Event By Id","href":"/api-reference/2024-03-27/events/event-by-id"}]},{"group":"Tenants","pages":[{"openapi":"openapi_2024-03-27 get /tenant","title":"Tenant By Id","href":"/api-reference/2024-03-27/tenants/tenant-by-id"},{"openapi":"openapi_2024-03-27 patch /tenant","title":"Update Tenant By Id","href":"/api-reference/2024-03-27/tenants/update-tenant-by-id"},{"openapi":"openapi_2024-03-27 get /tenant/configuration","title":"Tenant Configuration","href":"/api-reference/2024-03-27/tenants/tenant-configuration"}]},{"group":"Milestones","pages":[{"openapi":"openapi_2024-03-27 get /milestone","title":null,"href":"/api-reference/2024-03-27/milestones/get-milestones"},{"openapi":"openapi_2024-03-27 post /milestone","title":null,"href":"/api-reference/2024-03-27/milestones/create-milestone"},{"openapi":"openapi_2024-03-27 get /milestone/{milestone_id}","title":"Get Milestone","href":"/api-reference/2024-03-27/milestones/get-milestone"},{"openapi":"openapi_2024-03-27 delete /milestone/{milestone_id}","title":"Delete Milestone","href":"/api-reference/2024-03-27/milestones/delete-milestone"},{"openapi":"openapi_2024-03-27 patch /milestone/{milestone_id}","title":"Patch Milestone","href":"/api-reference/2024-03-27/milestones/patch-milestone"},{"openapi":"openapi_2024-03-27 get /milestone/{milestone_id}/update","title":"Get Milestone Update","href":"/api-reference/2024-03-27/milestones/get-milestone-update"}]},{"group":"Consumer","pages":[{"openapi":"openapi_2024-03-27 get /consumer/connection/share_request","title":"Get Share Requests","description":"This endpoint returns all Share Requests that have been created.","href":"/api-reference/2024-03-27/consumer/get-share-requests"},{"openapi":"openapi_2024-03-27 post /consumer/connection/share_request","title":"Create Share Request","href":"/api-reference/2024-03-27/consumer/create-share-request"}]}]}]},{"tab":"Provider access guides","pages":[{"title":"Provider access guides","href":"/integration-guides/verizon"}]},{"tab":"Legal","pages":[{"title":"Legal","href":"/legal/data-provider-terms"}]}]},{"version":"2024-03-26","pages":[{"title":"2024-03-26","href":"/api-reference/2024-03-26/consumer/create-share-request"}]}]},"title":"Create Share Request - PathStack","buildId":"dpl_DFJrtvUi8HS5F9nkooKuDJsuD5BM","deploymentId":"dpl_DFJrtvUi8HS5F9nkooKuDJsuD5BM","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-rfhihCWU.js","utils-BmH1XFxk.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-BcNsxPKB.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-BAES3tkd.js","snippetPresets-DCMQBKLP.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-D6l_bzE9.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BOktbnNh.js","shallow-BCs8SgM7.js","getApiPlaygroundDisplay-DEmW5bJB.js","CodeSnippet-CpZOpB9C.js","CodeSnippets-BOBDqibl.js","Page-D5fEM6aW.js","getPastedJson-DH2JBvmr.js","icon-BBJH-kKh.js","MethodPill-D2Sd5NLC.js","DuplicateIcon-CGgfL2qN.js","createIcon-BKudBBzi.js","DynamicMarkdown-85clUA0i.js","SectionHeading-D0JiMgDx.js","axios-vUo_bRtp.js","Markdown-Cfiy0xZO.js","clsx-rL8ZCCw4.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-aeztFa9U.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BywkCr5C.js"]}