Returns the identity of the credential used to authenticate the request: an API key or a user session token (JWT). Use it to verify a credential during integration setup (a 200 response means the credential is valid; 401/403 means it is missing, unknown, or revoked) and to display which API key and organization are connected. A key an agent bought also says how it was paid for and how to add credits. Requests to this endpoint are free: they never consume API credits.
Calling this endpoint is free. It never consumes API credits, so you
can use it to verify a credential during integration setup or on a health
check. API key responses include the key’s current credit usage, matching
the x-api-key-quota and x-api-key-approximate-usage headers returned by
billable endpoints.
API credit consumption for the current billing period, mirroring the x-api-key-quota and x-api-key-approximate-usage response headers of billable endpoints. Because this endpoint is free, used is the exact count, not approximated one ahead like the header.
Present only on a key an agent bought through POST /v2/agents/access: how it was paid for, and how to add credits.
Show child attributes
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Brandfetch","colors":{"primary":"#0084FF","light":"#FFFFFF","dark":"#0084FF"},"logo":{"light":"https://mintcdn.com/brandfetch-d7fb5329/-v6e41qD3Fxu16r-/logo/light.svg?fit=max\u0026auto=format\u0026n=-v6e41qD3Fxu16r-\u0026q=85\u0026s=4f8ea49e20e0d743c9a7754b14f01924","dark":"https://mintcdn.com/brandfetch-d7fb5329/-v6e41qD3Fxu16r-/logo/dark.svg?fit=max\u0026auto=format\u0026n=-v6e41qD3Fxu16r-\u0026q=85\u0026s=a447e4997a5b774c621a6b318290592f"},"favicon":"https://mintcdn.com/brandfetch-d7fb5329/XKUNPCS3k4Mv8APc/favicon.svg?fit=max\u0026auto=format\u0026n=XKUNPCS3k4Mv8APc\u0026q=85\u0026s=265eef38a8f076aea2e159f8e89605f9","api":{"openapi":"openapi.json"},"appearance":{"default":"dark"},"background":{"color":{"light":"#FAFAFA","dark":"#08090A"}},"navbar":{"links":[{"href":"https://brandfetch.com/developers/pricing","label":"Pricing"},{"href":"https://brandfetch.com/developers/contact/sales","label":"Contact sales"}],"primary":{"type":"button","label":"Dashboard","href":"https://developers.brandfetch.com"}},"footer":{"socials":{"x":"https://x.com/brandfetch","linkedin":"https://linkedin.com/company/brandfetch","instagram":"https://instagram.com/brandfetch"}},"seo":{"metatags":{"og:image":"https://developers.brandfetch.com/og_docs.webp"},"indexing":"navigable"},"fonts":{"heading":{"family":"Poppins"},"body":{"family":"Inter"}},"styling":{"eyebrows":"breadcrumbs","latex":true},"integrations":{"gtm":{"tagId":"GTM-MMMXMV7"}},"contextual":{"options":["copy","view","chatgpt","claude","cursor"],"display":"header"},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"brandfetch-d7fb5329","hasAudioNarration":false,"actualSubdomain":"brandfetch-d7fb5329","customDomains":["docs.brandfetch.com"],"gitSource":{"type":"github","owner":"brandfetch","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6aec85e68c2847cc731f9590","collectionId":"1abb6975-5594-4c3f-811c-48b2f1940c83","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6aec85e68c2847cc731f9590"},"feedback":{"thumbs":true,"edits":false},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6aec85e68c2847cc731f9590","clientVersion":"0.0.4076","searchFilterCounts":[{"language":"default","tag":"Documentation","count":27},{"language":"default","tag":"API References","count":14},{"language":"default","tag":"Resources","count":13},{"language":"default","tag":"Use cases","count":10},{"language":"default","tag":"Delivery methods","count":8},{"language":"default","tag":"Brand API","count":8},{"language":"default","tag":"Products","count":7},{"language":"default","tag":"Integrations","count":6},{"language":"default","tag":"Support","count":6},{"language":"default","tag":"Comparisons","count":5}]},"assistantConfig":{"deflection":{"enabled":true}},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[],"privacy":{"consentBanner":{"enabled":false}},"googleFontsInlined":true},"customCss":[{"filePath":"style.css","content":"body::before{content:\"\";position:absolute;top:-192px;left:50%;z-index:-1;width:calc(100% + 128px);height:528px;background:linear-gradient(\n 92deg,\n #369eff 0%,\n #75bcff 14%,\n #9747ff 26%,\n #ef4c77 34%,\n #ff7510 48%,\n #ffda00 56%,\n #ffda00 72%,\n #76cc4b 88%,\n #375d96 96%,\n #1c4686 100%\n );filter:blur(100px);opacity:0.075;transform:translateX(-50%);pointer-events:none}.dark body::before{background:linear-gradient(\n -90deg,\n #000 -9.95%,\n #1ed2ed -1.71%,\n #92caff 16.58%,\n #503957 43.26%,\n #ed4aff 73.47%,\n #ff5836 111.54%,\n #1c4686 130.11%\n );opacity:0.25}body{overflow-x:clip}#sidebar .sticky.top-0.pointer-events-none{background:none!important;backdrop-filter:blur(4px);-webkit-backdrop-filter:blur(4px);mask-image:linear-gradient(to bottom, #000, transparent);-webkit-mask-image:linear-gradient(to bottom, #000, transparent)}html.dark{--gray-100: 248 248 248;--gray-200: 236 236 236;--gray-300: 222 222 222;--gray-400: 184 184 184;--gray-500: 140 140 140;--gray-600: 104 104 104}.dark .nav-tabs-item:not([data-active=\"true\"]),.dark #navbar a.dark\\:text-gray-400{color:rgba(255, 255, 255, 0.72)!important}.dark .nav-tabs-item:not([data-active=\"true\"]):hover,.dark #navbar a.dark\\:text-gray-400:hover{color:#fff!important}.dark .nav-tabs-item[data-active=\"true\"]{color:#fff!important}.dark .nav-tabs-item:not([data-active=\"true\"]):hover>.absolute.bottom-0{background-color:rgba(255, 255, 255, 0.45)!important}.card{background-color:#f7f7f8!important}.dark .card{background-color:#1a1a1a60!important}.prompt{background-color:#f4f4f5!important;border-color:#e4e4e7!important}.dark .prompt{background-color:#1d1e20!important;border-color:rgba(255, 255, 255, 0.08)!important}@media (min-width: 1024px){#sidebar{width:19rem;min-width:19rem}#content-side-layout{max-width:25rem}#content-side-layout>div{width:25rem}#table-of-contents-layout{max-width:20rem}#table-of-contents-layout>div{width:20rem}}"}],"page":{"pagePath":"reference/viewer-api","slug":"/reference/viewer-api","pageMetadata":{"title":"Viewer API","sidebarTitle":"/v2/viewer","openapi":"GET /v2/viewer","description":"Returns the identity of the credential used to authenticate the request: an API key or a user session token (JWT). Use it to verify a credential during integration setup (a `200` response means the credential is valid; `401`/`403` means it is missing, unknown, or revoked) and to display which API key and organization are connected. A key an [agent bought](/agents/overview) also says how it was paid for and how to add credits. Requests to this endpoint are free: they never consume API credits.","href":"/reference/viewer-api"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n a: \"a\",\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Returns the identity of the credential used to authenticate the request: an API key or a user session token (JWT). Use it to verify a credential during integration setup (a \", _jsx(_components.code, {\n children: \"200\"\n }), \" response means the credential is valid; \", _jsx(_components.code, {\n children: \"401\"\n }), \"/\", _jsx(_components.code, {\n children: \"403\"\n }), \" means it is missing, unknown, or revoked) and to display which API key and organization are connected. A key an \", _jsx(_components.a, {\n href: \"/agents/overview\",\n children: \"agent bought\"\n }), \" also says how it was paid for and how to add credits. Requests to this endpoint are free: they never consume API credits.\"]\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{jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={code:`code`,p:`p`,strong:`strong`,..._provideComponents(),...props.components},{Note}=_components;if(!Note)_missingMdxReference(`Note`,true);return _jsx(Note,{children:_jsxs(_components.p,{children:[`Calling this endpoint is `,_jsx(_components.strong,{children:`free`}),`. It never consumes API credits, so you\ncan use it to verify a credential during integration setup or on a health\ncheck. API key responses include the key’s current credit `,_jsx(_components.code,{children:`usage`}),`, matching\nthe `,_jsx(_components.code,{children:`x-api-key-quota`}),` and `,_jsx(_components.code,{children:`x-api-key-approximate-usage`}),` headers returned by\nbillable endpoints.`]})})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Viewer API","sidebarTitle":"/v2/viewer","openapi":"GET /v2/viewer","description":"Returns the identity of the credential used to authenticate the request: an API key or a user session token (JWT). Use it to verify a credential during integration setup (a `200` response means the credential is valid; `401`/`403` means it is missing, unknown, or revoked) and to display which API key and organization are connected. A key an [agent bought](/agents/overview) also says how it was paid for and how to add credits. Requests to this endpoint are free: they never consume API credits.","href":"/reference/viewer-api"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"Get the authenticated viewer","description":"Returns the identity of the credential used to authenticate the request: an API key or a user session token (JWT). Use it to verify a credential during integration setup (a `200` response means the credential is valid; `401`/`403` means it is missing, unknown, or revoked) and to display which API key and organization are connected. A key an [agent bought](/agents/overview) also says how it was paid for and how to add credits. Requests to this endpoint are free: they never consume API credits.","operationId":"getViewer","tags":["viewer"],"security":["fa8294ce-b578-429b-ba7b-f07c2aebf0a4"],"responses":{"200":"b9c5eaf1-4060-4dcd-b31c-bf68dbcb9218","401":"65f4cafc-03c5-41e0-a4c1-307caac4699c","403":"36f29c53-efd4-4c24-9bf5-046e0d469859"},"method":"get","type":"path","servers":["7b0d6084-1738-4fb2-bc03-db3e71596d0a"],"path":"/v2/viewer","baseUrlOptions":["https://api.brandfetch.io"],"title":"Get the authenticated viewer","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"responses":{"b9c5eaf1-4060-4dcd-b31c-bf68dbcb9218":{"description":"The presented credential is valid. The `type` property indicates which kind of credential authenticated the request and determines the response shape.","content":{"application/json":{"schema":{"oneOf":[{"type":"object","title":"API key","description":"The authenticated API key.","required":["type","id","urn","name","createdAt","usage","organization"],"properties":{"type":{"type":"string","enum":["api-key"],"description":"The kind of credential that authenticated the request.","isRequired":true,"uniqueKey":"oneOf.0.type","typeLabel":"enum\u003cstring>"},"id":{"type":"string","description":"Id of the API key.","isRequired":true,"uniqueKey":"oneOf.0.id","typeLabel":"string"},"urn":{"type":"string","description":"URN of the API key, e.g. `urn:brandfetch:organization:{organization.id}:api-key:{id}`.","isRequired":true,"uniqueKey":"oneOf.0.urn","typeLabel":"string"},"name":{"oneOf":[{"type":"string","description":"Display name of the API key, as set in the dashboard.","isRequired":true,"uniqueKey":"oneOf.0.name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Display name of the API key, as set in the dashboard.","isRequired":true,"uniqueKey":"oneOf.0.name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.name","typeLabel":"string | null"},"createdAt":{"oneOf":[{"type":"string","format":"date-time","description":"When the API key was created.","isRequired":true,"uniqueKey":"oneOf.0.createdAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"When the API key was created.","isRequired":true,"uniqueKey":"oneOf.0.createdAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.createdAt","typeLabel":"string\u003cdate-time> | null"},"usage":{"type":"object","description":"API credit consumption for the current billing period, mirroring the `x-api-key-quota` and `x-api-key-approximate-usage` response headers of billable endpoints. Because this endpoint is free, `used` is the exact count, not approximated one ahead like the header.","required":["used","quota"],"properties":{"used":{"type":"integer","description":"API credits consumed so far in the current billing period.","isRequired":true,"uniqueKey":"oneOf.0.usage.used","typeLabel":"integer"},"quota":{"type":"integer","description":"API credit allowance for the current billing period.","isRequired":true,"uniqueKey":"oneOf.0.usage.quota","typeLabel":"integer"}},"isRequired":true,"uniqueKey":"oneOf.0.usage","typeLabel":"object"},"organization":{"type":"object","description":"The organization the API key belongs to.","required":["id","urn","name"],"properties":{"id":{"type":"string","description":"Id of the organization.","isRequired":true,"uniqueKey":"oneOf.0.organization.id","typeLabel":"string"},"urn":{"type":"string","description":"URN of the organization, e.g. `urn:brandfetch:organization:{id}`.","isRequired":true,"uniqueKey":"oneOf.0.organization.urn","typeLabel":"string"},"name":{"oneOf":[{"type":"string","description":"Display name of the organization.","isRequired":true,"uniqueKey":"oneOf.0.organization.name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Display name of the organization.","isRequired":true,"uniqueKey":"oneOf.0.organization.name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.organization.name","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"oneOf.0.organization","typeLabel":"object"},"agent":{"type":"object","description":"Present only on a key an agent bought through `POST /v2/agents/access`: how it was paid for, and how to add credits.","required":["payer","topUp"],"properties":{"payer":{"oneOf":[{"type":"object","title":"Wallet","description":"What paid for the key: an x402 or Tempo wallet, which can pay again to add credits to this key, or a card, which buys a new key with every payment.","required":["type","network","address"],"properties":{"type":{"type":"string","enum":["wallet"],"isRequired":true,"uniqueKey":"oneOf.0.agent.payer.oneOf.0.type","typeLabel":"enum\u003cstring>"},"network":{"type":"string","description":"CAIP-2 network the wallet paid on, e.g. `eip155:8453` for x402 on Base.","isRequired":true,"uniqueKey":"oneOf.0.agent.payer.oneOf.0.network","typeLabel":"string"},"address":{"type":"string","description":"The wallet's address, in lowercase.","isRequired":true,"uniqueKey":"oneOf.0.agent.payer.oneOf.0.address","typeLabel":"string"}},"isRequired":true,"uniqueKey":"oneOf.0.agent.payer.oneOf.0","typeLabel":"Wallet · object"},{"type":"object","title":"Card","description":"What paid for the key: an x402 or Tempo wallet, which can pay again to add credits to this key, or a card, which buys a new key with every payment.","required":["type"],"properties":{"type":{"type":"string","enum":["card"],"isRequired":true,"uniqueKey":"oneOf.0.agent.payer.oneOf.1.type","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"oneOf.0.agent.payer.oneOf.1","typeLabel":"Card · object"}],"isRequired":true,"uniqueKey":"oneOf.0.agent.payer","typeLabel":"Wallet · object | Card · object"},"topUp":{"type":"object","description":"How to add credits.","required":["method","url","note"],"properties":{"method":{"type":"string","enum":["POST"],"isRequired":true,"uniqueKey":"oneOf.0.agent.topUp.method","typeLabel":"enum\u003cstring>"},"url":{"type":"string","format":"uri","description":"The agent access endpoint.","isRequired":true,"uniqueKey":"oneOf.0.agent.topUp.url","typeLabel":"string\u003curi>"},"note":{"type":"string","description":"What paying again does for this key.","isRequired":true,"uniqueKey":"oneOf.0.agent.topUp.note","typeLabel":"string"}},"isRequired":true,"uniqueKey":"oneOf.0.agent.topUp","typeLabel":"object"}},"uniqueKey":"oneOf.0.agent","typeLabel":"object"}},"uniqueKey":"oneOf.0","typeLabel":"API key · object"},{"type":"object","title":"User","description":"The authenticated user (dashboard session token).","required":["type","id","urn","name","email","createdAt"],"properties":{"type":{"type":"string","enum":["user"],"description":"The kind of credential that authenticated the request.","isRequired":true,"uniqueKey":"oneOf.1.type","typeLabel":"enum\u003cstring>"},"id":{"type":"string","description":"Id of the user.","isRequired":true,"uniqueKey":"oneOf.1.id","typeLabel":"string"},"urn":{"type":"string","description":"URN of the user, e.g. `urn:brandfetch:user:{id}`.","isRequired":true,"uniqueKey":"oneOf.1.urn","typeLabel":"string"},"name":{"oneOf":[{"type":"string","description":"Full name of the user.","isRequired":true,"uniqueKey":"oneOf.1.name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Full name of the user.","isRequired":true,"uniqueKey":"oneOf.1.name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.1.name","typeLabel":"string | null"},"email":{"oneOf":[{"type":"string","description":"Email address of the user.","isRequired":true,"uniqueKey":"oneOf.1.email.oneOf.0","typeLabel":"string"},{"type":"null","description":"Email address of the user.","isRequired":true,"uniqueKey":"oneOf.1.email.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.1.email","typeLabel":"string | null"},"createdAt":{"oneOf":[{"type":"string","format":"date-time","description":"When the user account was created.","isRequired":true,"uniqueKey":"oneOf.1.createdAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"When the user account was created.","isRequired":true,"uniqueKey":"oneOf.1.createdAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.1.createdAt","typeLabel":"string\u003cdate-time> | null"}},"uniqueKey":"oneOf.1","typeLabel":"User · object"}],"uniqueKey":"","typeLabel":"API key · object | User · object"},"examples":{"apiKey":{"title":"apiKey","value":{"type":"api-key","id":"id5ZQvmz9A","urn":"urn:brandfetch:organization:cl5s9fps1275071ol9h7gs072m:api-key:id5ZQvmz9A","name":"Production key","createdAt":"2026-05-12T09:14:07.000Z","usage":{"used":1234,"quota":250000},"organization":{"id":"cl5s9fps1275071ol9h7gs072m","urn":"urn:brandfetch:organization:cl5s9fps1275071ol9h7gs072m","name":"Acme Inc."}}},"agentKey":{"title":"agentKey","value":{"type":"api-key","id":"idA9kR2mXw","urn":"urn:brandfetch:organization:cm1q8x0b2000308l4f9ae2k7d:api-key:idA9kR2mXw","name":"Agent Key","createdAt":"2026-09-24T18:02:51.000Z","usage":{"used":37,"quota":2000},"organization":{"id":"cm1q8x0b2000308l4f9ae2k7d","urn":"urn:brandfetch:organization:cm1q8x0b2000308l4f9ae2k7d","name":"Agent 0x0000…0a11"},"agent":{"payer":{"type":"wallet","network":"eip155:8453","address":"0x0000000000000000000000000000000000000a11"},"topUp":{"method":"POST","url":"https://api.brandfetch.io/v2/agents/access","note":"Pay again from the same wallet to add credits to this key. Add rotateKey=true to replace the key while doing so, which is also how to recover a lost key."}}}},"user":{"title":"user","value":{"type":"user","id":"cl2xkl6h90007w135197r5abc","urn":"urn:brandfetch:user:cl2xkl6h90007w135197r5abc","name":"Jane Doe","email":"jane@acme.com","createdAt":"2025-11-02T16:41:12.000Z"}}},"exampleType":"examples"}},"exampleType":"examples"},"65f4cafc-03c5-41e0-a4c1-307caac4699c":{"description":"Unauthorized. The request carries no Authorization header. The body points an agent without a key at how to get access.","content":{"application/json":{"schema":{"type":"object","required":["message","agentAccess"],"properties":{"message":{"type":"string","enum":["Unauthorized"],"isRequired":true,"uniqueKey":"message","typeLabel":"enum\u003cstring>"},"agentAccess":{"type":"object","description":"Where an agent without an API key can get access: buy a key with an x402 or MPP payment, or pay for each request individually.","required":["description","documentation","offer"],"properties":{"description":{"type":"string","description":"The two ways in, in prose.","isRequired":true,"uniqueKey":"agentAccess.description","typeLabel":"string"},"documentation":{"type":"string","format":"uri","description":"The agent access guide.","isRequired":true,"uniqueKey":"agentAccess.documentation","typeLabel":"string\u003curi>"},"offer":{"type":"string","format":"uri","description":"The agent access endpoint. `GET` it to read the offer: the price, how to pay with each protocol, and the per-request alternative.","isRequired":true,"uniqueKey":"agentAccess.offer","typeLabel":"string\u003curi>"}},"isRequired":true,"uniqueKey":"agentAccess","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"message":"Unauthorized","agentAccess":{"description":"An agent without an API key can buy one with an x402 or MPP payment, or pay for each Brand API, Brand Context API and Transaction API request individually. The offer describes both.","documentation":"https://docs.brandfetch.com/agents/overview","offer":"https://api.brandfetch.io/v2/agents/access"}},"examples":{"Example":{"title":"Example","value":{"message":"Unauthorized","agentAccess":{"description":"An agent without an API key can buy one with an x402 or MPP payment, or pay for each Brand API, Brand Context API and Transaction API request individually. The offer describes both.","documentation":"https://docs.brandfetch.com/agents/overview","offer":"https://api.brandfetch.io/v2/agents/access"}}}},"exampleType":"examples"}},"exampleType":"examples"},"36f29c53-efd4-4c24-9bf5-046e0d469859":{"description":"Forbidden. The credential was rejected, e.g. an empty or unknown credential, a revoked API key or an expired session token.","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}}},"security":{"fa8294ce-b578-429b-ba7b-f07c2aebf0a4":{"bearerAuth":{"type":"http","scheme":"bearer","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"7b0d6084-1738-4fb2-bc03-db3e71596d0a":{"url":"https://api.brandfetch.io"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","scopes":[],"schemeName":"bearerAuth"},"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":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"openapi.json"},"subdomain":"brandfetch-d7fb5329","siteName":"Brandfetch","title":"Viewer API - Brandfetch","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-01T13:49:27.057Z","originalFileLocation":"reference/viewer-api.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=\"dark\"}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=\"Returns the identity of the credential used to authenticate the request: an API key or a user session token (JWT). Use it to verify a credential during integration setup (a 200 response means the credential is valid; 401/403 means it is missing, unknown, or revoked) and to display which API key and organization are connected. A key an agent bought also says how it was paid for and how to add credits. Requests to this endpoint are free: they never consume API credits.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Brandfetch\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/brandfetch-d7fb5329/D3XFukFFOrKC-_RS/_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/brandfetch-d7fb5329/D3XFukFFOrKC-_RS/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/brandfetch-d7fb5329/D3XFukFFOrKC-_RS/_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/brandfetch-d7fb5329/D3XFukFFOrKC-_RS/_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/brandfetch-d7fb5329/D3XFukFFOrKC-_RS/_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/brandfetch-d7fb5329/D3XFukFFOrKC-_RS/_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/brandfetch-d7fb5329/D3XFukFFOrKC-_RS/_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/brandfetch-d7fb5329/D3XFukFFOrKC-_RS/_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/brandfetch-d7fb5329/D3XFukFFOrKC-_RS/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Viewer API - Brandfetch\">\u003cmeta data-mint-head property=\"og:description\" content=\"Returns the identity of the credential used to authenticate the request: an API key or a user session token (JWT). Use it to verify a credential during integration setup (a 200 response means the credential is valid; 401/403 means it is missing, unknown, or revoked) and to display which API key and organization are connected. A key an agent bought also says how it was paid for and how to add credits. Requests to this endpoint are free: they never consume API credits.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Brandfetch\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.brandfetch.com/reference/viewer-api\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://developers.brandfetch.com/og_docs.webp\">\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=\"Viewer API - Brandfetch\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Returns the identity of the credential used to authenticate the request: an API key or a user session token (JWT). Use it to verify a credential during integration setup (a 200 response means the credential is valid; 401/403 means it is missing, unknown, or revoked) and to display which API key and organization are connected. A key an agent bought also says how it was paid for and how to add credits. Requests to this endpoint are free: they never consume API credits.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://developers.brandfetch.com/og_docs.webp\">\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/brandfetch-d7fb5329/D3XFukFFOrKC-_RS/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Brandfetch\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0084FF\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.brandfetch.com/reference/viewer-api\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/reference/viewer-api.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.brandfetch.com/#organization\",\"name\":\"Brandfetch\",\"url\":\"https://docs.brandfetch.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/brandfetch-d7fb5329/-v6e41qD3Fxu16r-/logo/light.svg?fit=max\u0026auto=format\u0026n=-v6e41qD3Fxu16r-\u0026q=85\u0026s=4f8ea49e20e0d743c9a7754b14f01924\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.brandfetch.com#website\",\"name\":\"Brandfetch\",\"url\":\"https://docs.brandfetch.com\",\"publisher\":{\"@id\":\"https://docs.brandfetch.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.brandfetch.com/reference/viewer-api#webpage\",\"url\":\"https://docs.brandfetch.com/reference/viewer-api\",\"name\":\"Viewer API\",\"description\":\"Returns the identity of the credential used to authenticate the request: an API key or a user session token (JWT). Use it to verify a credential during integration setup (a 200 response means the credential is valid; 401/403 means it is missing, unknown, or revoked) and to display which API key and organization are connected. A key an agent bought also says how it was paid for and how to add credits. Requests to this endpoint are free: they never consume API credits.\",\"dateModified\":\"2026-10-01T13:49:27.057Z\",\"isPartOf\":{\"@id\":\"https://docs.brandfetch.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.brandfetch.com/reference/viewer-api#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.brandfetch.com/reference/viewer-api#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Brandfetch\",\"item\":\"https://docs.brandfetch.com\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Viewer API\",\"item\":\"https://docs.brandfetch.com/reference/viewer-api\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.brandfetch.com/reference/viewer-api#apireference\",\"headline\":\"Viewer API\",\"name\":\"Viewer API\",\"description\":\"Returns the identity of the credential used to authenticate the request: an API key or a user session token (JWT). Use it to verify a credential during integration setup (a 200 response means the credential is valid; 401/403 means it is missing, unknown, or revoked) and to display which API key and organization are connected. A key an agent bought also says how it was paid for and how to add credits. Requests to this endpoint are free: they never consume API credits.\",\"url\":\"https://docs.brandfetch.com/reference/viewer-api\",\"mainEntityOfPage\":{\"@id\":\"https://docs.brandfetch.com/reference/viewer-api#webpage\"},\"image\":\"https://developers.brandfetch.com/og_docs.webp\",\"dateModified\":\"2026-10-01T13:49:27.057Z\",\"publisher\":{\"@id\":\"https://docs.brandfetch.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.brandfetch.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Brandfetch\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Brandfetch","nav":{"global":null,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/get-started"}]},{"tab":"API References","groups":[{"group":"Brand API","pages":[{"title":"Brand API by domain","sidebarTitle":"/v2/brands/domain/{domain}","openapi":"GET /v2/brands/domain/{domain}","href":"/reference/brand-api-domain"},{"title":"Brand API by ticker","sidebarTitle":"/v2/brands/ticker/{ticker}","openapi":"GET /v2/brands/ticker/{ticker}","href":"/reference/brand-api-ticker"},{"title":"Brand API by ISIN","sidebarTitle":"/v2/brands/isin/{isin}","openapi":"GET /v2/brands/isin/{isin}","href":"/reference/brand-api-isin"},{"title":"Brand API by crypto","sidebarTitle":"/v2/brands/crypto/{symbol}","openapi":"GET /v2/brands/crypto/{symbol}","href":"/reference/brand-api-crypto"},{"title":"Brand API (auto-detect)","sidebarTitle":"/v2/brands/{identifier}","openapi":"GET /v2/brands/{identifier}","href":"/reference/brand-api"},{"title":"Brand API batch","sidebarTitle":"/v2/brands/batch","openapi":"POST /v2/brands/batch","href":"/reference/brand-api-batch"},{"title":"Brand API prefetch (HEAD)","sidebarTitle":"/v2/brands/{identifier}","openapi":"HEAD /v2/brands/{identifier}","href":"/reference/brand-api-prefetch"},{"title":"Brand API prefetch by domain (HEAD)","sidebarTitle":"/v2/brands/domain/{domain}","openapi":"HEAD /v2/brands/domain/{domain}","href":"/reference/brand-api-prefetch-domain"}]},{"group":"Brand Context API","pages":[{"title":"Brand Context API","sidebarTitle":"/v2/context/{domain}","openapi":"GET /v2/context/{domain}","href":"/reference/brand-context-api"}]},{"group":"Brand Search API","pages":[{"title":"Brand Search API","sidebarTitle":"/v2/search/{name}","openapi":"GET /v2/search/{name}?c={clientId}","href":"/reference/brand-search-api"}]},{"group":"Transaction API","pages":[{"title":"Transaction API","sidebarTitle":"/v2/brands/transaction","openapi":"POST /v2/brands/transaction","description":"Turn payment transactions into merchant data. Authenticate with an API key sent as `Authorization: Bearer \u003ckey>`, or pay for the single request with x402 or MPP: https://docs.brandfetch.com/agents/pay-per-request.","href":"/reference/transaction-api"}]},{"group":"Viewer API","pages":[{"title":"Viewer API","sidebarTitle":"/v2/viewer","openapi":"GET /v2/viewer","href":"/reference/viewer-api"}]},{"group":"Agent access","pages":[{"title":"Agent access offer","sidebarTitle":"GET /v2/agents/access","openapi":"GET /v2/agents/access","description":"What an agent can buy and how to pay for it: standing API access — an organization, an API key preloaded with prepaid credits and an MCP token — sold for one x402 or MPP payment. Needs no credential. Written for an agent that will act on it. See https://docs.brandfetch.com/agents/overview.","href":"/reference/agents-access-offer"},{"title":"Buy agent access","sidebarTitle":"POST /v2/agents/access","openapi":"POST /v2/agents/access","href":"/reference/agents-access-purchase"}]}]},{"tab":"Resources","pages":[{"title":"Resources","href":"/integrations/overview"}]},{"tab":"Use cases","pages":[{"title":"Use cases","href":"/use-cases/overview"}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/changelog/overview"}]}]},"basePath":"","title":"Viewer API - Brandfetch","buildId":"dpl_8LJbrAiZvr1K98WQNZXCyY5AvT34","deploymentId":"dpl_8LJbrAiZvr1K98WQNZXCyY5AvT34","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-i2a3QZ8E.js","utils-ChLwp8m0.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DRktVTDc.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-CA2pEs4T.js","snippetPresets-ClQ6XrKD.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-Ct_Lv36y.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-Cn2PYw9e.js","shallow-rkyymjXQ.js","getApiPlaygroundDisplay-BB9vkXtE.js","CodeSnippet-Bm5RU7m1.js","CodeSnippets-BgU9Deuz.js","Page-BUDYNlhG.js","getPastedJson-BD-6NNum.js","icon-8Z6tud2e.js","MethodPill-Tuzr4g3V.js","DuplicateIcon-0ceWFYhN.js","createIcon-FBXow_ST.js","DynamicMarkdown-CD8713Yy.js","SectionHeading-7zgzQbH-.js","axios-vUo_bRtp.js","Markdown-D7Ofw1oz.js","clsx-eKJ4rcii.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CwjSCXIK.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-9EK5IAXV.js"]}