{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-web3/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["admonition"]},"type":"markdown"},"seo":{"title":"Set up Resolution Service API Access Guide","description":"The developer documentation portal and API reference for Unstoppable Domains.","siteUrl":"https://docs.unstoppabledomains.com","keywords":"unstoppable domains developer portal, api reference docs","lang":"en-US","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"set-up-resolution-service-api-access-guide","__idx":0},"children":["Set up Resolution Service API Access Guide"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This page explains the process for creating an account and applying to become an authorized partner for Unstoppable Domains."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"step-1-sign-up-to-partner-dashboard","__idx":1},"children":["Step 1: Sign Up to Partner Dashboard"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You must create an Unstoppable Domains Partner account in ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://dashboard.auth.unstoppabledomains.com"},"children":["Partner Dashboard"]},". You may ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Login"]}," using your existing Unstoppable Domains account information or ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Sign Up"]}," if you don’t already have an account."]},{"$$mdtype":"Tag","name":"figure","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"img","attributes":{"src":"/images/partner-signup.png","alt":"Login or sign-up options for new partners","title":"#width=60%;"},"children":[]}]},{"$$mdtype":"Tag","name":"figcaption","attributes":{},"children":["Login or sign-up options for new partners"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"step-2-setup-your-first-application","__idx":2},"children":["Step 2: Setup Your First Application"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Let us know who you are by submitting your ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Company name"]}," and ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Company type"]}]},{"$$mdtype":"Tag","name":"figure","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"img","attributes":{"src":"/images/submit-company-name.png","alt":"Submit company details","title":"#width=60%;"},"children":[]}]},{"$$mdtype":"Tag","name":"figcaption","attributes":{},"children":["Submit company details"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Navigate to ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://dashboard.auth.unstoppabledomains.com/clients"},"children":["Clients Page"]}," by clicking ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Clients"]}," at the top of the app. Read the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Partner API Terms"]}," and submit your agreement."]},{"$$mdtype":"Tag","name":"figure","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"img","attributes":{"src":"/images/dashboard-client-page.png","alt":"Partner API Terms","title":"#width=90%;"},"children":[]}]},{"$$mdtype":"Tag","name":"figcaption","attributes":{},"children":["Partner API Terms"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Create your first client by clicking the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Create Client"]}," button."]},{"$$mdtype":"Tag","name":"figure","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"img","attributes":{"src":"/images/dashboard-empty-client-page.png","alt":"Create First Client","title":"#width=80%;"},"children":[]}]},{"$$mdtype":"Tag","name":"figcaption","attributes":{},"children":["Create First Client"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Update your client information and click ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Confirm Changes"]}]},{"$$mdtype":"Tag","name":"figure","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"img","attributes":{"src":"/images/dashboard-update-client-info.png","alt":"Update Client Information","title":"#width=80%;"},"children":[]}]},{"$$mdtype":"Tag","name":"figcaption","attributes":{},"children":["Update Client Information"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"step-3-obtain-an-api-key","__idx":3},"children":["Step 3: Obtain an API Key"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Navigate to the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["API & SDK Panel"]}," by clicking the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["API & SDK"]}," button."]},{"$$mdtype":"Tag","name":"figure","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"img","attributes":{"src":"/images/dashboard-api-pannel.png","alt":"API Panel","title":"#width=80%;"},"children":[]}]},{"$$mdtype":"Tag","name":"figcaption","attributes":{},"children":["API Panel"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Request one of the following keys depending on your current usage. You ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["might"]}," be required to provide an email address for our partner engineering team to contact you if you originally signed up using a Wallet address such as MetaMask."]},{"$$mdtype":"Tag","name":"figure","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"img","attributes":{"src":"/images/dashboard-email-requirement.png","alt":"Email Requirement","title":"#width=80%;"},"children":[]}]},{"$$mdtype":"Tag","name":"figcaption","attributes":{},"children":["Email Requirement"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"api-key","__idx":4},"children":["API Key"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Refer to ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/web3/apis/resolution/openapi"},"children":["Domain Resolution API"]}," for supported use cases."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["By default, you will have access to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Domain Resolution API"]},". You do not need to click on ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Request access to Partner API v3"]},"."]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"warning"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Your API key is only intended for use on your backend servers. Any other usage could result in security risks and or your key being deactivated."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"sdk-key","__idx":5},"children":["SDK Key"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Refer to the ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://github.com/unstoppabledomains/resolution"},"children":["Javascript Resolution SDKs"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The key is only allowed to be used in Resolution SDKs to interact with EVM RPC providers to query on-chain data."]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"warning"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The SDKs are no longer maintained."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"step-4-authenticate-your-requests","__idx":6},"children":["Step 4: Authenticate Your Requests"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The Resolution Service API uses ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Bearer Tokens"]}," to authorize requests with the API key gotten from Unstoppable Domains."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Field Name"},"children":["Field Name"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Value"},"children":["Value"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Security Scheme Type"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["HTTP"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["HTTP Authorization Scheme"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["bearer"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Bearer Format"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["a token provided by Unstoppable Domains"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"fork-our-postman-collection","__idx":7},"children":["Fork Our Postman Collection"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Unstoppable Domains offers a Postman collection that you can easily import into your workspace to quickly interact with the Resolution Service API."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://god.gw.postman.com/run-collection/19507736-52bf9f35-1608-4dc4-a96d-e62682b59199?action=collection%2Ffork&collection-url=entityId%3D19507736-52bf9f35-1608-4dc4-a96d-e62682b59199%26entityType%3Dcollection%26workspaceId%3D6762865c-b510-4216-ba7f-45cd07f164c7#?env%5BResolution%20Service%20-%20Open%20API%5D=W3sia2V5IjoiYmFzZV91cmwiLCJ2YWx1ZSI6Imh0dHBzOi8vcmVzb2x2ZS51bnN0b3BwYWJsZWRvbWFpbnMuY29tIiwiZW5hYmxlZCI6dHJ1ZSwidHlwZSI6ImRlZmF1bHQiLCJzZXNzaW9uVmFsdWUiOiJodHRwczovL3Jlc29sdmUudW5zdG9wcGFibGVkb21haW5zLmNvbSIsInNlc3Npb25JbmRleCI6MH0seyJrZXkiOiJhcGlfa2V5IiwidmFsdWUiOiIiLCJlbmFibGVkIjp0cnVlLCJ0eXBlIjoic2VjcmV0Iiwic2Vzc2lvblZhbHVlIjoiIiwic2Vzc2lvbkluZGV4IjoxfV0="},"children":[{"$$mdtype":"Tag","name":"img","attributes":{"src":"https://run.pstmn.io/button.svg","alt":"Run in Postman"},"children":[]}]}]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"success","name":"Congratulations!"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You just registered to become an official Unstoppable Domains Partner."]}]}]},"headings":[{"value":"Set up Resolution Service API Access Guide","id":"set-up-resolution-service-api-access-guide","depth":1},{"value":"Step 1: Sign Up to Partner Dashboard","id":"step-1-sign-up-to-partner-dashboard","depth":2},{"value":"Step 2: Setup Your First Application","id":"step-2-setup-your-first-application","depth":2},{"value":"Step 3: Obtain an API Key","id":"step-3-obtain-an-api-key","depth":2},{"value":"API Key","id":"api-key","depth":3},{"value":"SDK Key","id":"sdk-key","depth":3},{"value":"Step 4: Authenticate Your Requests","id":"step-4-authenticate-your-requests","depth":2},{"value":"Fork Our Postman Collection","id":"fork-our-postman-collection","depth":3}],"frontmatter":{"title":"Resolution Service API | Unstoppable Domains Developer Portal","description":"This page provides a high-level overview of the Resolution Service API hosted by Unstoppable Domains.","seo":{"title":"Set up Resolution Service API Access Guide"}},"editPage":{"to":"https://github.com/unstoppabledomains/dev-docs/blob/main/web3/resolution/quickstart/retrieve-an-api-key.md"},"lastModified":"2026-04-10T16:45:57.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/web3/resolution/quickstart/retrieve-an-api-key","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}