[{"data":1,"prerenderedAt":646},["ShallowReactive",2],{"navigation":3,"/api/shares/retrieve":258,"/api/shares/retrieve-surround":641},[4,22,63,85,115,131,219,245],{"title":5,"path":6,"stem":7,"children":8,"page":21},"Getting Started","/getting-started","1.getting-started",[9,13,17],{"title":10,"path":11,"stem":12},"Introduction","/getting-started/introduction","1.getting-started/1.introduction",{"title":14,"path":15,"stem":16},"Quick Start","/getting-started/quick-start","1.getting-started/2.quick-start",{"title":18,"path":19,"stem":20},"Key Concepts","/getting-started/key-concepts","1.getting-started/3.key-concepts",false,{"title":23,"path":24,"stem":25,"children":26,"page":21},"Guides","/guides","2.guides",[27,31,35,39,43,47,51,55,59],{"title":28,"path":29,"stem":30},"Quick Share Guide","/guides/quick-share","2.guides/1.quick-share",{"title":32,"path":33,"stem":34},"Slack Integration","/guides/slack-integration","2.guides/2.slack-integration",{"title":36,"path":37,"stem":38},"Enterprise Setup","/guides/enterprise-setup","2.guides/3.enterprise-setup",{"title":40,"path":41,"stem":42},"Creating a Share","/guides/creating-a-share","2.guides/4.creating-a-share",{"title":44,"path":45,"stem":46},"Zero-Knowledge Custody","/guides/zero-knowledge-custody","2.guides/5.zero-knowledge-custody",{"title":48,"path":49,"stem":50},"Secure Requests","/guides/secure-requests","2.guides/6.secure-requests",{"title":52,"path":53,"stem":54},"Receiving a Secure Request","/guides/receiving-a-secure-request","2.guides/7.receiving-a-secure-request",{"title":56,"path":57,"stem":58},"SecurePaste","/guides/securepaste","2.guides/8.securepaste",{"title":60,"path":61,"stem":62},"Notifications","/guides/notifications","2.guides/9.notifications",{"title":64,"icon":65,"path":66,"stem":67,"children":68,"page":21},"Account","i-lucide-user-cog","/account","3.account",[69,73,77,81],{"title":70,"path":71,"stem":72},"Signing In","/account/signing-in","3.account/1.signing-in",{"title":74,"path":75,"stem":76},"Plans and Share Allowance","/account/plans-and-share-allowance","3.account/2.plans-and-share-allowance",{"title":78,"path":79,"stem":80},"Billing and Subscription","/account/billing-and-subscription","3.account/3.billing-and-subscription",{"title":82,"path":83,"stem":84},"Plans and Limits","/account/plans-and-limits","3.account/4.plans-and-limits",{"title":86,"icon":87,"path":88,"stem":89,"children":90,"page":21},"Teams","i-lucide-users","/teams","4.teams",[91,95,99,103,107,111],{"title":92,"path":93,"stem":94},"Teams and Contexts","/teams/teams-and-contexts","4.teams/1.teams-and-contexts",{"title":96,"path":97,"stem":98},"Members, Roles and Seats","/teams/members-roles-and-seats","4.teams/2.members-roles-and-seats",{"title":100,"path":101,"stem":102},"Joining a Team","/teams/joining-a-team","4.teams/3.joining-a-team",{"title":104,"path":105,"stem":106},"Custom Branding","/teams/custom-branding","4.teams/4.custom-branding",{"title":108,"path":109,"stem":110},"Policy and Audit","/teams/policy-and-audit","4.teams/5.policy-and-audit",{"title":112,"path":113,"stem":114},"Zero-Knowledge for Teams","/teams/zero-knowledge-for-teams","4.teams/6.zero-knowledge-for-teams",{"title":116,"path":117,"stem":118,"children":119,"icon":130},"Help","/help","5.help/0.index",[120,122,126],{"title":121,"path":117,"stem":118},"Help and Support",{"title":123,"path":124,"stem":125},"Link Not Working","/help/link-not-working","5.help/1.link-not-working",{"title":127,"path":128,"stem":129},"Error Messages","/help/error-messages","5.help/2.error-messages","i-lucide-life-buoy",{"title":132,"path":133,"stem":134,"children":135},"API Reference","/api","6.api/0.index",[136,137,141,167,189,193,211,215],{"title":132,"path":133,"stem":134},{"title":138,"path":139,"stem":140},"Authentication","/api/authentication","6.api/1.authentication",{"title":142,"path":143,"stem":144,"children":145},"Shares","/api/shares","6.api/2.shares/0.index",[146,147,151,155,159,163],{"title":142,"path":143,"stem":144},{"title":148,"path":149,"stem":150},"Create a share","/api/shares/create","6.api/2.shares/1.create",{"title":152,"path":153,"stem":154},"List shares","/api/shares/list","6.api/2.shares/2.list",{"title":156,"path":157,"stem":158},"Retrieve a share","/api/shares/retrieve","6.api/2.shares/3.retrieve",{"title":160,"path":161,"stem":162},"Expire a share","/api/shares/delete","6.api/2.shares/4.delete",{"title":164,"path":165,"stem":166},"Client-side encryption","/api/shares/client-side-encryption","6.api/2.shares/5.client-side-encryption",{"title":168,"path":169,"stem":170,"children":171},"Secure requests","/api/requests","6.api/3.requests/0.index",[172,173,177,181,185],{"title":168,"path":169,"stem":170},{"title":174,"path":175,"stem":176},"Create a request","/api/requests/create","6.api/3.requests/1.create",{"title":178,"path":179,"stem":180},"List and retrieve requests","/api/requests/list","6.api/3.requests/2.list",{"title":182,"path":183,"stem":184},"Read submissions","/api/requests/submissions","6.api/3.requests/3.submissions",{"title":186,"path":187,"stem":188},"Expire or delete a request","/api/requests/delete","6.api/3.requests/4.delete",{"title":190,"path":191,"stem":192},"Stats","/api/stats","6.api/4.stats",{"title":194,"path":195,"stem":196,"children":197},"Webhooks","/api/webhooks","6.api/5.webhooks/0.index",[198,199,203,207],{"title":194,"path":195,"stem":196},{"title":200,"path":201,"stem":202},"Event reference","/api/webhooks/events","6.api/5.webhooks/1.events",{"title":204,"path":205,"stem":206},"Verifying signatures","/api/webhooks/verifying-signatures","6.api/5.webhooks/2.verifying-signatures",{"title":208,"path":209,"stem":210},"Delivery and retries","/api/webhooks/delivery-and-retries","6.api/5.webhooks/3.delivery-and-retries",{"title":212,"path":213,"stem":214},"MCP server","/api/mcp","6.api/6.mcp",{"title":216,"path":217,"stem":218},"Errors and Rate Limits","/api/errors-and-limits","6.api/7.errors-and-limits",{"title":220,"path":221,"stem":222,"children":223},"SDKs","/sdks","7.sdks/0.index",[224,225,229,233,237,241],{"title":220,"path":221,"stem":222},{"title":226,"path":227,"stem":228},"Node SDK","/sdks/node","7.sdks/1.node",{"title":230,"path":231,"stem":232},"Python SDK","/sdks/python","7.sdks/2.python",{"title":234,"path":235,"stem":236},"Go SDK","/sdks/go","7.sdks/3.go",{"title":238,"path":239,"stem":240},"Rust SDK","/sdks/rust","7.sdks/4.rust",{"title":242,"path":243,"stem":244},"Conformance vectors","/sdks/conformance-vectors","7.sdks/5.conformance-vectors",{"title":246,"path":247,"stem":248,"children":249,"page":21},"Security","/security","8.security",[250,254],{"title":251,"path":252,"stem":253},"Encryption","/security/encryption","8.security/1.encryption",{"title":255,"path":256,"stem":257},"Compliance","/security/compliance","8.security/2.compliance",{"id":259,"title":156,"api":260,"body":261,"description":635,"extension":636,"links":260,"meta":637,"navigation":638,"path":157,"seo":639,"stem":158,"__hash__":640},"docs/6.api/2.shares/3.retrieve.md",null,{"type":262,"value":263,"toc":627},"minimark",[264,275,283,288,303,306,310,343,347,353,397,449,471,475,488,528,531,535,543,552,556,614,623],[265,266,272],"pre",{"className":267,"code":269,"language":270,"meta":271},[268],"language-text","GET /v1/shares/{shortCode}\n","text","",[273,274,269],"code",{"__ignoreMap":271},[276,277,278,279,282],"p",{},"Requires the ",[273,280,281],{},"shares:read"," scope.",[284,285,287],"h2",{"id":286},"the-path-parameter-is-a-short-code","The path parameter is a short code",[276,289,290,293,294,297,298,302],{},[273,291,292],{},"{shortCode}"," is the ",[273,295,296],{},"short_code"," value the ",[299,300,301],"a",{"href":149},"create"," response gave you, and the same value that appears in the recipient link. It is not a database id, and there is no other identifier for a share anywhere in this API.",[276,304,305],{},"This endpoint takes no query parameters.",[284,307,309],{"id":308},"request","Request",[265,311,315],{"className":312,"code":313,"language":314,"meta":271,"style":271},"language-bash shiki shiki-themes github-light github-dark github-dark","curl https://api.credenshare.io/v1/shares/a1b2c3d4 \\\n  -H \"Authorization: Bearer crs_sk_live_\u003CkeyId>.\u003CauthSecret>\"\n","bash",[273,316,317,334],{"__ignoreMap":271},[318,319,322,326,330],"span",{"class":320,"line":321},"line",1,[318,323,325],{"class":324},"shcOC","curl",[318,327,329],{"class":328},"sfrk1"," https://api.credenshare.io/v1/shares/a1b2c3d4",[318,331,333],{"class":332},"suiK_"," \\\n",[318,335,337,340],{"class":320,"line":336},2,[318,338,339],{"class":332},"  -H",[318,341,342],{"class":328}," \"Authorization: Bearer crs_sk_live_\u003CkeyId>.\u003CauthSecret>\"\n",[284,344,346],{"id":345},"success-response","Success response",[276,348,349,352],{},[273,350,351],{},"200 OK",", with exactly two keys:",[265,354,358],{"className":355,"code":356,"language":357,"meta":271,"style":271},"language-json shiki shiki-themes github-light github-dark github-dark","{\n  \"short_code\": \"a1b2c3d4\",\n  \"expired_at\": \"2026-09-01T00:00:00Z\"\n}\n","json",[273,359,360,366,380,391],{"__ignoreMap":271},[318,361,362],{"class":320,"line":321},[318,363,365],{"class":364},"slsVL","{\n",[318,367,368,371,374,377],{"class":320,"line":336},[318,369,370],{"class":332},"  \"short_code\"",[318,372,373],{"class":364},": ",[318,375,376],{"class":328},"\"a1b2c3d4\"",[318,378,379],{"class":364},",\n",[318,381,383,386,388],{"class":320,"line":382},3,[318,384,385],{"class":332},"  \"expired_at\"",[318,387,373],{"class":364},[318,389,390],{"class":328},"\"2026-09-01T00:00:00Z\"\n",[318,392,394],{"class":320,"line":393},4,[318,395,396],{"class":364},"}\n",[398,399,400,416],"table",{},[401,402,403],"thead",{},[404,405,406,410,413],"tr",{},[407,408,409],"th",{},"Field",[407,411,412],{},"Type",[407,414,415],{},"Notes",[417,418,419,432],"tbody",{},[404,420,421,426,429],{},[422,423,424],"td",{},[273,425,296],{},[422,427,428],{},"string",[422,430,431],{},"The short code you asked for.",[404,433,434,439,442],{},[422,435,436],{},[273,437,438],{},"expired_at",[422,440,441],{},"string or null",[422,443,444,445,448],{},"RFC 3339, or ",[273,446,447],{},"null"," when the share was created with no expiry.",[276,450,451,452,455,456,459,460,455,463,466,467,470],{},"That is the whole body. There is no ",[273,453,454],{},"title",", no ",[273,457,458],{},"status",", no view counter, no ",[273,461,462],{},"has_passcode",[273,464,465],{},"created_at"," and no ",[273,468,469],{},"url",".",[284,472,474],{"id":473},"what-this-endpoint-does-not-do","What this endpoint does not do",[476,477,480],"callout",{"color":478,"icon":479},"info","i-lucide-info",[276,481,482,483,487],{},"This is ",[484,485,486],"strong",{},"not"," the recipient read path. It is an owner's metadata read, and it is deliberately built on a different code path so that polling your own share cannot damage it.",[489,490,491,498,508,518],"ul",{},[492,493,494,497],"li",{},[484,495,496],{},"It does not return content."," No endpoint on this API does. The content is ciphertext CredenShare cannot read, and the key that opens it lives in the link fragment.",[492,499,500,503,504,507],{},[484,501,502],{},"It does not consume a view."," A share with ",[273,505,506],{},"access_counts_left: 1"," still has one view left after you call this, however many times you call it.",[492,509,510,513,514,517],{},[484,511,512],{},"It does not evaluate a passcode",", and it does not require one. There is nowhere to send a ",[273,515,516],{},"passcode_verifier"," here.",[492,519,520,523,524,527],{},[484,521,522],{},"It cannot expire the share."," Expiry is reported, never acted on. Use ",[299,525,526],{"href":161},"DELETE"," when you actually want the share gone.",[276,529,530],{},"The reason it is a separate path at all is the encryption model: every read by short code on the recipient side requires the access token derived from the link fragment, and the server never holds that token. Routing an owner's metadata read through the recipient path answers \"not found\" for shares the caller demonstrably owns.",[284,532,534],{"id":533},"knowing-whether-a-share-is-still-usable","Knowing whether a share is still usable",[276,536,537,538,540,541,470],{},"The response does not tell you whether a share has been used up. A share exhausted by its view limit or its passcode attempts still reports whatever ",[273,539,438],{}," it was created with, including ",[273,542,447],{},[276,544,545,546,551],{},"Use ",[299,547,548],{"href":153},[273,549,550],{},"GET /v1/shares"," for that question instead: the list excludes any share that is no longer usable, so a short code that is absent from the list is a short code nobody can open any more.",[284,553,555],{"id":554},"errors","Errors",[398,557,558,573],{},[401,559,560],{},[404,561,562,565,570],{},[407,563,564],{},"Status",[407,566,567],{},[273,568,569],{},"error_code",[407,571,572],{},"When",[417,574,575,588,599],{},[404,576,577,580,583],{},[422,578,579],{},"403",[422,581,582],{},"78",[422,584,585,586,282],{},"The key lacks the ",[273,587,281],{},[404,589,590,593,596],{},[422,591,592],{},"404",[422,594,595],{},"1",[422,597,598],{},"No such share on this account.",[404,600,601,604,607],{},[422,602,603],{},"429",[422,605,606],{},"107",[422,608,609,610,613],{},"Rate limit exceeded. ",[273,611,612],{},"Retry-After"," gives the seconds to wait.",[276,615,616,617,619,620,622],{},"A short code that belongs to a different account returns ",[273,618,592],{},", not ",[273,621,579],{},", and so does one that never existed. The two are indistinguishable on purpose: a key must not be usable to discover which short codes exist elsewhere.",[624,625,626],"style",{},"html pre.shiki code .shcOC, html code.shiki .shcOC{--shiki-light:#6F42C1;--shiki-default:#B392F0;--shiki-dark:#B392F0}html pre.shiki code .sfrk1, html code.shiki .sfrk1{--shiki-light:#032F62;--shiki-default:#9ECBFF;--shiki-dark:#9ECBFF}html pre.shiki code .suiK_, html code.shiki .suiK_{--shiki-light:#005CC5;--shiki-default:#79B8FF;--shiki-dark:#79B8FF}html .light .shiki span {color: var(--shiki-light);background: var(--shiki-light-bg);font-style: var(--shiki-light-font-style);font-weight: var(--shiki-light-font-weight);text-decoration: var(--shiki-light-text-decoration);}html.light .shiki span {color: var(--shiki-light);background: var(--shiki-light-bg);font-style: var(--shiki-light-font-style);font-weight: var(--shiki-light-font-weight);text-decoration: var(--shiki-light-text-decoration);}html .default .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html.dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html pre.shiki code .slsVL, html code.shiki .slsVL{--shiki-light:#24292E;--shiki-default:#E1E4E8;--shiki-dark:#E1E4E8}",{"title":271,"searchDepth":321,"depth":336,"links":628},[629,630,631,632,633,634],{"id":286,"depth":336,"text":287},{"id":308,"depth":336,"text":309},{"id":345,"depth":336,"text":346},{"id":473,"depth":336,"text":474},{"id":533,"depth":336,"text":534},{"id":554,"depth":336,"text":555},"GET /v1/shares/{shortCode} — one share's metadata, without touching the share.","md",{},true,{"title":156,"description":635},"iXr8HQ-PILz4e4JwQIzPrm1xFhrwI30XRCKBtOlH56g",[642,644],{"title":152,"path":153,"stem":154,"description":643,"children":-1},"GET /v1/shares — page through the shares your key created, metadata only.",{"title":160,"path":161,"stem":162,"description":645,"children":-1},"DELETE /v1/shares/{shortCode} — end a share early, before its expiry or view limit.",1788908852114]