crossmintAPI.init( "your-api-key", config: \{ environment: "staging", ipfsGateways: ["https://ipfs.io"], // Optional, a list of defualt ones is provided ipfsTimeout: 5000, // ms, Optional, default is 10 seconds blockchainRpcs: \{...\} // Optional, default rpcs for polygon are provided \})## Defined in[crossmintAPI.ts:124](https://github.com/Crossmint/crossmint-sdk/blob/main/packages/client/verifiable-credentials/src/crossmintAPI.ts#L124)
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Crossmint Docs","colors":{"primary":"#36b37e","light":"#87ff8f","dark":"#001d01"},"logo":{"light":"https://mintcdn.com/crossmint/a8gPOTKEuVFcSfC3/logo/crossmint-light.png?fit=max\u0026auto=format\u0026n=a8gPOTKEuVFcSfC3\u0026q=85\u0026s=8c2671e4c8f7da6956e1508bd68c2928","dark":"https://mintcdn.com/crossmint/a8gPOTKEuVFcSfC3/logo/crossmint-dark.png?fit=max\u0026auto=format\u0026n=a8gPOTKEuVFcSfC3\u0026q=85\u0026s=272ecc17664d17b9ff24471758ff80b2"},"favicon":"https://mintcdn.com/crossmint/xq66q9GV6z6jjj95/favicon.png?fit=max\u0026auto=format\u0026n=xq66q9GV6z6jjj95\u0026q=85\u0026s=00fb89ddf6ba5b1022b9307039c08006","api":{"openapi":["api-reference/_open-api/MintingAPIs.json","api-reference/_open-api/AdminAPIs.json","api-reference/_open-api/VerifiableCredentialsAPIs.json","api-reference/_open-api/Wallets.json"],"examples":{"prefill":true}},"background":{"color":{"dark":"#090b0c"}},"navbar":{"links":[{"href":"https://www.crossmint.com/contact","label":"Support"},{"href":"https://staging.crossmint.com/console","label":"Staging Console"}],"primary":{"type":"button","label":"Console","href":"https://www.crossmint.com/console"}},"footer":{"socials":{"website":"https://www.crossmint.com","twitter":"https://twitter.com/crossmint","github":"https://github.com/crossmint"}},"integrations":{"ga4":{"measurementId":"G-CP5EDD6GVT"},"posthog":{"apiKey":"phc_tfgodwfjuO9v3Nw0tIWJNzACoi2opL7X2Ly0Mg2UCTz","apiHost":"https://eu.i.posthog.com","sessionRecording":false}},"contextual":{"options":["copy","view","chatgpt","claude"],"display":"header"},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"crossmint","hasAudioNarration":false,"actualSubdomain":"crossmint","customDomains":["docs.crossmint.com"],"gitSource":{"type":"github","owner":"paella-labs","repo":"crossbit-main","deployBranch":"main","contentDirectory":"apps/crossmint-mintlify-docs/src","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true,"edits":true,"issues":true,"contextualFeedback":{"allowEmail":true},"agentFeedback":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"REMOVE_BRANDING":{"status":"ENABLED"},"CONTEXTUAL_FEEDBACK":{"status":"ENABLED"},"CODE_SNIPPET_FEEDBACK":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6af465d8911eab1428db13c3","clientVersion":"0.0.4111","searchFilterCounts":[{"language":"default","tag":"API Reference","count":1094},{"language":"default","tag":"Wallets","count":870},{"language":"default","tag":"Kotlin SDK","count":427},{"language":"default","tag":"Swift SDK","count":237},{"language":"default","tag":"Checkout","count":196},{"language":"default","tag":"Classes","count":182},{"language":"default","tag":"Data Classes","count":182},{"language":"default","tag":"Typescript SDK","count":156},{"language":"default","tag":"Guides","count":134},{"language":"default","tag":"Structs","count":127}]},"assistantConfig":{"enableAskAiButton":true,"enableStarterQuestions":false,"enableAskAiSearchBar":false,"deflection":{"enabled":true,"type":"link","url":"https://www.crossmint.com/contact/sales"}},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":".tab-container [data-component-part=\"tabs-list\"]{flex-wrap:wrap;overflow:visible;row-gap:0.25rem}.tab-container [data-component-part=\"tabs-list\"]>li{white-space:nowrap}.nav-dropdown-item,.nav-dropdown-item *{font-weight:500!important;color:rgb(75, 85, 99)!important}.nav-dropdown-item:hover,.nav-dropdown-item:hover *{color:rgb(31, 41, 55)!important}.dark .nav-dropdown-item,.dark .nav-dropdown-item *{color:rgb(156, 163, 175)!important}.dark .nav-dropdown-item:hover,.dark .nav-dropdown-item:hover *{color:rgb(209, 213, 219)!important}"}],"page":{"pagePath":"sdk-reference/credentials/variables/crossmintAPI","slug":"/sdk-reference/credentials/variables/crossmintAPI","pageMetadata":{"title":"crossmintAPI","description":null,"href":"/sdk-reference/credentials/variables/crossmintAPI"},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={blockquote:`blockquote`,code:`code`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,..._provideComponents(),...props.components},{CodeBlock,Heading}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.blockquote,{children:[`\n`,_jsxs(_components.p,{children:[_jsx(_components.code,{children:`const`}),` `,_jsx(_components.strong,{children:`crossmintAPI`}),`: `,_jsx(_components.code,{children:`CrossmintAPI`})]}),`\n`]}),`\n`,_jsxs(_components.p,{children:[`Crossmint API singleton, used to init the SDK\nTo use the SDK you must call `,_jsx(_components.code,{children:`init`}),` before any other method`]}),`\n`,_jsx(Heading,{level:`2`,id:`example`,children:`Example`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`13`,language:`typescript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`typescript`,children:_jsxs(_components.code,{language:`typescript`,numberOfLines:`13`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`crossmintAPI`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`.`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:`init`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"your-api-key\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` config`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: \\\\{`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` environment:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"staging\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` ipfsGateways:`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` [`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"https://ipfs.io\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`], `}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`// Optional, a list of defualt ones is provided`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` ipfsTimeout:`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:` 5000`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`// ms, Optional, default is 10 seconds`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` blockchainRpcs:`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` \\\\{`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`...`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`\\\\} `}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`// Optional, default rpcs for polygon are provided`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` \\\\}`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`)`})}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`## `}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`Defined`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:` in`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`[`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`crossmintAPI`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`.`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`ts`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`:`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`124`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`](`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`https`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`:`}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`//github.com/Crossmint/crossmint-sdk/blob/main/packages/client/verifiable-credentials/src/crossmintAPI.ts#L124)`})]}),`\n`]})})})]})}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":"crossmintAPI","description":null,"href":"/sdk-reference/credentials/variables/crossmintAPI"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Example","slug":"example","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":["/_mintlify/custom/crossmint/d1c432d03c0c4224/scripts/dd.js","/_mintlify/custom/crossmint/7fc8d54052d3edb0/scripts/hubspot.js"],"subdomain":"crossmint","siteName":"Crossmint Docs","title":"crossmintAPI - Crossmint Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-11T02:10:31.932Z","originalFileLocation":"sdk-reference/credentials/variables/crossmintAPI.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=\"application-name\" content=\"Crossmint Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/crossmint/-1hhMU0vchFPUD3H/_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/crossmint/-1hhMU0vchFPUD3H/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/crossmint/-1hhMU0vchFPUD3H/_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/crossmint/-1hhMU0vchFPUD3H/_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/crossmint/-1hhMU0vchFPUD3H/_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/crossmint/-1hhMU0vchFPUD3H/_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/crossmint/-1hhMU0vchFPUD3H/_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/crossmint/-1hhMU0vchFPUD3H/_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/crossmint/-1hhMU0vchFPUD3H/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"crossmintAPI - Crossmint Docs\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Crossmint Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.crossmint.com/sdk-reference/credentials/variables/crossmintAPI\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://crossmint.mintlify.site/_mintlify/api/og/v2?division=Variables\u0026amp;title=crossmintAPI\u0026amp;theme=b8bba0b38c114479513683ad\u0026amp;signature=47e15e5ee5fb79ca4b6335c1ed7531792ab1fb1c27178f1fff1d85eb7e4404db\">\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=\"crossmintAPI - Crossmint Docs\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://crossmint.mintlify.site/_mintlify/api/og/v2?division=Variables\u0026amp;title=crossmintAPI\u0026amp;theme=b8bba0b38c114479513683ad\u0026amp;signature=47e15e5ee5fb79ca4b6335c1ed7531792ab1fb1c27178f1fff1d85eb7e4404db\">\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/crossmint/-1hhMU0vchFPUD3H/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Crossmint Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#36b37e\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.crossmint.com/sdk-reference/credentials/variables/crossmintAPI\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/sdk-reference/credentials/variables/crossmintAPI.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.crossmint.com/#organization\",\"name\":\"Crossmint Docs\",\"url\":\"https://docs.crossmint.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/crossmint/a8gPOTKEuVFcSfC3/logo/crossmint-light.png?fit=max\u0026auto=format\u0026n=a8gPOTKEuVFcSfC3\u0026q=85\u0026s=8c2671e4c8f7da6956e1508bd68c2928\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.crossmint.com#website\",\"name\":\"Crossmint Docs\",\"url\":\"https://docs.crossmint.com\",\"publisher\":{\"@id\":\"https://docs.crossmint.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.crossmint.com/sdk-reference/credentials/variables/crossmintAPI#webpage\",\"url\":\"https://docs.crossmint.com/sdk-reference/credentials/variables/crossmintAPI\",\"name\":\"crossmintAPI\",\"dateModified\":\"2026-11-11T02:10:31.932Z\",\"isPartOf\":{\"@id\":\"https://docs.crossmint.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.crossmint.com/sdk-reference/credentials/variables/crossmintAPI#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.crossmint.com/sdk-reference/credentials/variables/crossmintAPI#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API Reference\",\"item\":\"https://docs.crossmint.com/api-reference/minting/nfts/mint-nft\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Typescript SDK\",\"item\":\"https://docs.crossmint.com/sdk-reference/credentials/introduction\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Verifiable Credentials (VCs)\",\"item\":\"https://docs.crossmint.com/sdk-reference/credentials/introduction\"},{\"@type\":\"ListItem\",\"position\":4,\"name\":\"Variables\",\"item\":\"https://docs.crossmint.com/sdk-reference/credentials/variables/VCChain\"},{\"@type\":\"ListItem\",\"position\":5,\"name\":\"crossmintAPI\",\"item\":\"https://docs.crossmint.com/sdk-reference/credentials/variables/crossmintAPI\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.crossmint.com/sdk-reference/credentials/variables/crossmintAPI#article\",\"headline\":\"crossmintAPI\",\"name\":\"crossmintAPI\",\"url\":\"https://docs.crossmint.com/sdk-reference/credentials/variables/crossmintAPI\",\"mainEntityOfPage\":{\"@id\":\"https://docs.crossmint.com/sdk-reference/credentials/variables/crossmintAPI#webpage\"},\"dateModified\":\"2026-11-11T02:10:31.932Z\",\"publisher\":{\"@id\":\"https://docs.crossmint.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.crossmint.com#website\"}}]}\u003c/script>","agentPointerHref":"/sdk-reference/credentials/variables/crossmintAPI.md","siteName":"Crossmint Docs","nav":{"global":null,"tabs":[{"tab":"Get Started","pages":[{"title":"Get Started","href":"/introduction/platform-overview"}]},{"tab":"Wallets","pages":[{"title":"Wallets","href":"/wallets/overview"}]},{"tab":"Identity","pages":[{"title":"Identity","href":"/identity/overview"}]},{"tab":"Stablecoin Orchestration","pages":[{"title":"Stablecoin Orchestration","href":"/stablecoin-orchestration/overview"}]},{"tab":"Checkout","pages":[{"title":"Checkout","href":"/payments/introduction"}]},{"tab":"Onramp","pages":[{"title":"Onramp","href":"/onramp/overview"}]},{"tab":"Offramp","pages":[{"title":"Offramp","href":"/offramp/overview"}]},{"tab":"Agents","pages":[{"title":"Agents","href":"/agents/overview"}]},{"tab":"Others","menu":[{"item":"Tokenization","groups":[{"group":"Introduction","pages":[{"title":"Overview","href":"/tokenization/introduction"}]},{"group":"Tokens (NFTs, SFTs)","pages":[{"group":"Quickstarts ⚡","pages":[{"title":"Non-Fungible Tokens (NFTs)","href":"/tokenization/quickstarts/nfts"},{"title":"Semi-Fungible Tokens (SFTs)","href":"/tokenization/quickstarts/sfts"}]},{"group":"Integrate","pages":[{"title":"Create Collections","href":"/tokenization/nfts/integrate/create-collections"},{"title":"Define Metadata","href":"/tokenization/nfts/integrate/define-metadata"},{"title":"Mint Tokens","href":"/tokenization/nfts/integrate/mint-tokens"},{"title":"Configure Admin Functions","href":"/tokenization/nfts/integrate/configure-admin-functions"},{"title":"Mint In Bulk","href":"/tokenization/nfts/integrate/mint-in-bulk"},{"title":"Update NFTs","href":"/tokenization/nfts/integrate/update-nfts"},{"title":"Manage Delivery","href":"/tokenization/nfts/integrate/manage-delivery"},{"title":"List for Sale","href":"/tokenization/nfts/integrate/list-for-sale"},{"title":"Bring Your Own Contract","href":"/tokenization/nfts/integrate/bring-your-own-contract"},{"title":"Webhooks and Status APIs","sidebarTitle":"Webhooks \u0026 Status APIs","href":"/tokenization/nfts/integrate/webhooks-and-status-apis"},{"title":"Pricing","href":"/tokenization/nfts/integrate/pricing"}]}]},{"group":"Verifiable Credentials (VCs)","pages":[{"title":"Quickstart ⚡","href":"/tokenization/quickstarts/credentials"},{"group":"Guides","pages":[{"title":"Create Credential Types","href":"/tokenization/verifiable-credentials/integrate/create-credential-types"},{"title":"Create Credential Templates","href":"/tokenization/verifiable-credentials/integrate/create-credential-templates"},{"title":"Issue Credentials","href":"/tokenization/verifiable-credentials/integrate/issue-credentials"},{"title":"Retrieve Credentials","href":"/tokenization/verifiable-credentials/integrate/retrieve-credentials"},{"title":"Decrypt Credentials","href":"/tokenization/verifiable-credentials/integrate/decrypt-credentials"},{"title":"Verify Credentials","href":"/tokenization/verifiable-credentials/integrate/verify-credentials"},{"title":"Revoke Credentials","href":"/tokenization/verifiable-credentials/integrate/revoke-credentials"},{"title":"Credential Storage","href":"/tokenization/verifiable-credentials/integrate/store-credentials"},{"title":"Credential Encryption","href":"/tokenization/verifiable-credentials/integrate/encrypt-credentials"},{"title":"Delegated Signature","href":"/tokenization/verifiable-credentials/integrate/delegated-signatures"},{"title":"Webhook","href":"/tokenization/verifiable-credentials/integrate/webhooks"}]}]},{"group":"API Reference","pages":[{"group":"REST","icon":"brackets-curly","pages":[{"group":"Tokens (NFTs, SFTs)","pages":[{"group":"NFTs","pages":[{"openapi":"api-reference/_open-api/MintingAPIs.json POST /2022-06-09/collections/{collectionId}/nfts","title":"Mint NFT","href":"/api-reference/minting/nfts/mint-nft"},{"openapi":"api-reference/_open-api/MintingAPIs.json PUT /2022-06-09/collections/{collectionId}/nfts/{id}","title":"Mint NFT with ID","href":"/api-reference/minting/nfts/mint-nft-idempotent"},{"openapi":"api-reference/_open-api/MintingAPIs.json POST /2022-06-09/collections/{collectionId}/sfts","title":"Mint SFT","href":"/api-reference/minting/nfts/mint-sft"},{"openapi":"api-reference/_open-api/MintingAPIs.json GET /2022-06-09/collections/{collectionId}/nfts","title":"Get All NFTs","href":"/api-reference/minting/nfts/get-nfts"},{"openapi":"api-reference/_open-api/MintingAPIs.json GET /2022-06-09/collections/{collectionId}/nfts/{id}","title":"Mint Status","href":"/api-reference/minting/nfts/mint-status"},{"openapi":"api-reference/_open-api/MintingAPIs.json PATCH /2022-06-09/collections/{collectionId}/nfts/{id}","title":"Edit NFT","href":"/api-reference/minting/nfts/edit-nft"},{"openapi":"api-reference/_open-api/MintingAPIs.json DELETE /2022-06-09/collections/{collectionId}/nfts/{id}","title":"Burn NFT","href":"/api-reference/minting/nfts/burn-nft"},{"openapi":"api-reference/_open-api/Tokens.json DELETE /2022-06-09/nfts/{locator}","title":"Burn Token by locator","href":"/api-reference/minting/nfts/burn-nft-locator"}]},{"group":"NFT Collections","pages":[{"title":"Create Collection","openapi":"api-reference/_open-api/MintingAPIs.json POST /2022-06-09/collections/","href":"/api-reference/minting/collection/create-collection"},{"title":"Create Collection (Idempotent)","openapi":"api-reference/_open-api/MintingAPIs.json PUT /2022-06-09/collections/{collectionId}","href":"/api-reference/minting/collection/create-collection-idempotent"},{"title":"Get All Collections","openapi":"api-reference/_open-api/MintingAPIs.json GET /2022-06-09/collections/","href":"/api-reference/minting/collection/get-all-collections"},{"title":"Get Collection Info","openapi":"api-reference/_open-api/MintingAPIs.json GET /2022-06-09/collections/{collectionId}","href":"/api-reference/minting/collection/get-collection"},{"title":"Update Collection","openapi":"api-reference/_open-api/MintingAPIs.json PATCH /2022-06-09/collections/{collectionId}","href":"/api-reference/minting/collection/update-collection"},{"title":"Set Royalties","openapi":"api-reference/_open-api/MintingAPIs.json PUT /v1-alpha1/minting/collections/{collectionId}/royalties","href":"/api-reference/minting/collection/set-royalties"},{"title":"Get Royalties Configuration","openapi":"api-reference/_open-api/MintingAPIs.json GET /v1-alpha1/minting/collections/{collectionId}/royalties","href":"/api-reference/minting/collection/get-royalties-configuration"},{"title":"Remove Royalties","openapi":"api-reference/_open-api/MintingAPIs.json DELETE /v1-alpha1/minting/collections/{collectionId}/royalties","href":"/api-reference/minting/collection/remove-royalties"},{"title":"Set Base URI","openapi":"api-reference/_open-api/MintingAPIs.json PUT /v1-alpha1/minting/collections/{collectionId}/base-uri","href":"/api-reference/minting/collection/set-base-uri"},{"title":"Get Base URI","openapi":"api-reference/_open-api/MintingAPIs.json GET /v1-alpha1/minting/collections/{collectionId}/base-uri","href":"/api-reference/minting/collection/get-base-uri"},{"title":"Set Transferability","openapi":"api-reference/_open-api/MintingAPIs.json PUT /v1-alpha1/minting/collections/{collectionId}/transferable","href":"/api-reference/minting/collection/set-transferability"},{"title":"Get Transferability","openapi":"api-reference/_open-api/MintingAPIs.json GET /v1-alpha1/minting/collections/{collectionId}/transferable","href":"/api-reference/minting/collection/get-transferability"}]},{"group":"NFT Templates","pages":[{"openapi":"api-reference/_open-api/MintingAPIs.json POST /2022-06-09/collections/{collectionId}/templates","title":"Create Template","href":"/api-reference/minting/template/create-template"},{"openapi":"api-reference/_open-api/MintingAPIs.json PUT /2022-06-09/collections/{collectionId}/templates/{templateId}","title":"Create Template with ID","href":"/api-reference/minting/template/create-template-idempotent"},{"openapi":"api-reference/_open-api/MintingAPIs.json GET /2022-06-09/collections/{collectionId}/templates/{templateId}","title":"Get Template","href":"/api-reference/minting/template/get-template"},{"openapi":"api-reference/_open-api/MintingAPIs.json GET /2022-06-09/collections/{collectionId}/templates","title":"Get All Templates","href":"/api-reference/minting/template/get-all-templates"},{"openapi":"api-reference/_open-api/MintingAPIs.json PATCH /2022-06-09/collections/{collectionId}/templates/{templateId}","title":"Edit Template","href":"/api-reference/minting/template/edit-template"},{"openapi":"api-reference/_open-api/MintingAPIs.json DELETE /2022-06-09/collections/{collectionId}/templates/{templateId}","title":"Delete Template","href":"/api-reference/minting/template/delete-template"}]},{"group":"Action Status","pages":[{"openapi":"api-reference/_open-api/MintingAPIs.json GET /2022-06-09/actions/{actionId}","title":"Get Action Status","href":"/api-reference/common/get-action-status"}]}]},{"group":"Verifiable Credentials (VCs)","pages":[{"group":"Verifiable Credentials","pages":[{"openapi":"api-reference/_open-api/VerifiableCredentialsAPIs.json POST /v1-alpha1/credentials/templates/","title":"Create Credential template","href":"/api-reference/verifiable-credentials/templates/create-template"},{"openapi":"api-reference/_open-api/VerifiableCredentialsAPIs.json POST /v1-alpha1/credentials/templates/{templateId}/vcs","title":"Issue Credential","href":"/api-reference/verifiable-credentials/credentials/issue-credential"},{"openapi":"api-reference/_open-api/VerifiableCredentialsAPIs.json GET /v1-alpha1/credentials/{id}","title":"Get Credential by Credential ID","href":"/api-reference/verifiable-credentials/credentials/retrieve-credential-by-id"},{"openapi":"api-reference/_open-api/VerifiableCredentialsAPIs.json GET /v1-alpha1/credentials/templates/{collectionId}/nfts/{id}/credentials","title":"Get Credential by NFT ID","href":"/api-reference/verifiable-credentials/credentials/retrieve-credential-by-nft"},{"openapi":"api-reference/_open-api/VerifiableCredentialsAPIs.json GET /v1-alpha1/nfts/{nftLocator}/credentials","title":"Get Credential by NFT Locator","href":"/api-reference/verifiable-credentials/credentials/retrieve-credential-by-nft-locator"},{"openapi":"api-reference/_open-api/VerifiableCredentialsAPIs.json GET /v1-alpha1/wallets/{walletLocator}/credential_nfts","title":"Get Credential NFTs","href":"/api-reference/verifiable-credentials/credentials/retrieve-credential-nfts"},{"openapi":"api-reference/_open-api/VerifiableCredentialsAPIs.json POST /v1-alpha1/credentials/verification/verify","title":"Verify Credential","href":"/api-reference/verifiable-credentials/credentials/verify-credential"},{"openapi":"api-reference/_open-api/VerifiableCredentialsAPIs.json DELETE /v1-alpha1/credentials/{id}","title":"Revoke Credential","href":"/api-reference/verifiable-credentials/credentials/revoke-credential"}]},{"group":"Verifiable Credential Types","pages":[{"openapi":"api-reference/_open-api/VerifiableCredentialsAPIs.json POST /v1-alpha1/credentials/types","title":"Create Credential Type","href":"/api-reference/verifiable-credentials/types/create-type"},{"openapi":"api-reference/_open-api/VerifiableCredentialsAPIs.json PUT /v1-alpha1/credentials/types/{typeName}","title":"Create Credential Type with Name","href":"/api-reference/verifiable-credentials/types/create-named-type"},{"openapi":"api-reference/_open-api/VerifiableCredentialsAPIs.json GET /v1-alpha1/credentials/types/{typeName}","title":"Get a Credential Type","href":"/api-reference/verifiable-credentials/types/get-type"}]}]}]},{"group":"Typescript SDK","icon":"/images/icons/ts-logo-128.png","pages":[{"group":"Verifiable Credentials (VCs)","pages":[{"title":"Introduction","href":"/sdk-reference/credentials/introduction"},{"group":"Classes","pages":[{"title":"ContractMetadataService","href":"/sdk-reference/credentials/classes/ContractMetadataService"},{"title":"CredentialService","href":"/sdk-reference/credentials/classes/CredentialService"},{"title":"CrossmintDecrypt","href":"/sdk-reference/credentials/classes/CrossmintDecrypt"},{"title":"CrossmintMetamaskDecrypt","href":"/sdk-reference/credentials/classes/CrossmintMetamaskDecrypt"},{"title":"Lit","href":"/sdk-reference/credentials/classes/Lit"},{"title":"WalletAuthService","href":"/sdk-reference/credentials/classes/WalletAuthService"}]},{"group":"Interfaces","pages":[{"title":"Collection","href":"/sdk-reference/credentials/interfaces/Collection"},{"title":"CredentialFilter","href":"/sdk-reference/credentials/interfaces/CredentialFilter"},{"title":"CredentialMetadata","href":"/sdk-reference/credentials/interfaces/CredentialMetadata"},{"title":"CredentialsCollection","href":"/sdk-reference/credentials/interfaces/CredentialsCollection"},{"title":"EncryptedVerifiableCredential","href":"/sdk-reference/credentials/interfaces/EncryptedVerifiableCredential"},{"title":"VCNFT","href":"/sdk-reference/credentials/interfaces/VCNFT"},{"title":"VerifiableCredential","href":"/sdk-reference/credentials/interfaces/VerifiableCredential"},{"title":"VerifiableCredentialEncryption","href":"/sdk-reference/credentials/interfaces/VerifiableCredentialEncryption"}]},{"group":"Type Aliases","pages":[{"title":"ChainRPCConfig","href":"/sdk-reference/credentials/type-aliases/ChainRPCConfig"},{"title":"VCChain","href":"/sdk-reference/credentials/type-aliases/VCChain"},{"title":"VerifiableCredentialType","href":"/sdk-reference/credentials/type-aliases/VerifiableCredentialType"}]},{"group":"Variables","pages":[{"title":"VCChain","description":null,"href":"/sdk-reference/credentials/variables/VCChain"},{"title":"crossmintAPI","href":"/sdk-reference/credentials/variables/crossmintAPI"},{"title":"crossmintRetrievalProcedure","description":null,"href":"/sdk-reference/credentials/variables/crossmintRetrievalProcedure"},{"title":"ipfsRetrievalProcedure","href":"/sdk-reference/credentials/variables/ipfsRetrievalProcedure"}]},{"group":"Functions","pages":[{"title":"getCredentialNFTFromLocator","href":"/sdk-reference/credentials/functions/getCredentialNFTFromLocator"},{"title":"getCredentialNfts","href":"/sdk-reference/credentials/functions/getCredentialNfts"},{"title":"isCredentialType","href":"/sdk-reference/credentials/functions/isCredentialType"},{"title":"isEncryptedVerifiableCredential","href":"/sdk-reference/credentials/functions/isEncryptedVerifiableCredential"},{"title":"isVcChain","href":"/sdk-reference/credentials/functions/isVcChain"},{"title":"isVerifiableCredential","href":"/sdk-reference/credentials/functions/isVerifiableCredential"},{"title":"verifyCredential","href":"/sdk-reference/credentials/functions/verifyCredential"}]},{"group":"Enumerations","pages":[{"title":"VerifiableCredentialEncryptionType","href":"/sdk-reference/credentials/enumerations/VerifiableCredentialEncryptionType"}]}]}]}]}]}]}]},"basePath":"","title":"crossmintAPI - Crossmint Docs","buildId":"dpl_DqYu5MPb49gWBBbUGgpHQUmCHY3P","deploymentId":"dpl_DqYu5MPb49gWBBbUGgpHQUmCHY3P","dynamics":[],"chunks":[]}