Set up Partner API Access Guide

This page explains the process for creating an account and applying to become an authorized partner for Unstoppable Domains.

warning

The Partner API only supports domains and wallets on the Polygon L2 network. See the Polygon Developer Integration Guide to get started.

Step 1: Sign Up to Partner Dashboard

You must create an Unstoppable Domains Partner account in Partner Dashboard. You may Login using your existing Unstoppable Domains account information or Sign Up if you don’t already have an account.

Step 2: Setup Your First Application

Let us know who you are by submitting your Company name and Company type

Navigate to Clients Page by clicking Clients at the top of the app. Read the Partner API Terms and submit your agreement.

Create your first client by clicking the Create Client button.

Update your client information and click Confirm Changes

Step 3: Obtain an API Key

Navigate to the API Panel by clicking the API button.

Request one of the following keys depending on your current usage. You 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.

API Key

Refer to Partner API v3 for supported use cases.

When you click on the Request key, an email will be sent to our Partner engineering team. The team will be contacting you in shortly via the email you login with or the one submitted when requesting to acquire the key.

Legacy API Key

Refer to Domain Resolution and Domain Distribution and Management Overview for supported use cases.

Click Reveal Key under Legacy API key to acquire your API Key

Step 3: Configure Payment Information

The Partner API must be configured with one or more payment options before users can begin purchasing domains. Please follow the instructions in the Partner Integration Guides to integrate one or more payment methods for your partner account.

Congratulations!

You just registered to become an official Unstoppable Domains Partner.

Set up UD Sandbox for Testing Guide

To test integrations, you can switch to Sandbox mode. This mode allows you play around with test net which does not incur cost during development. To access Sandbox, toggle the Sandbox button at the top of the application.

Sandbox Environment URLs

Sandbox Website

Copy

Copied

https://ud-sandbox.com/

Sandbox API Endpoint

Copy

Copied

https://api.ud-sandbox.com/

Congratulations!

You have successfully accessed and set up the Unstoppable Domains Sandbox Environment. Happy hacking!

Partner API Integration Paths

Unstoppable Domains Partner API is a versatile feature with several integration pathways available for developers. This page reviews the integration guides and overall features for each installation option. For more information about the endpoints, please consult the Partner API endpoint specification.

important

Partner API Integrations will only work on Polygon L2 network. See the Polygon Developer Integration Guide to get started.

Step 1: Locate Your Reseller ID

After setting up access to the Partner API, you must obtain your resellerID from the API Panel of the Partner Dashboard to integrate our services into your application for your customers.

Step 2: Add a Domain Search Functionality

Before you integrate free or paid domain minting (via Stripe or Redirect URLs) payment flows, you must implement a domain search functionality into your application. Unstoppable Domains provides a set of endpoints to provide domain suggestions, check the availability of domain names, and reserve free domain names.

Pathway	Description	Integration Guides
Get Domains Suggestions	provides free and paid domain suggestions based on the entered information	Get Domains Suggestions Guide
Domain Name Availability	checks the availability of a domain name before purchase	Domain Name Availability Guide
Reserve Free Domain Name	reserves a free and available domain name for seven days	Reserve Free Domain Name Guide

Step 3: Choose Your Integration Path

There are several ways to integrate with Unstoppable's Partner API, detailed in the table below. Partners are encouraged to integrate more than one pathway.

Pathway	Description	Integration Guides
Free domains	mint free domains for customers following pre-determined "allowed free TLDs" and "allowed free tiers"	Free Domain Minting Guide
Paid domains: Stripe	configure Stripe account to process paid domains via credit card, PayPal, and ApplePay	Stripe Payments Guide
Paid domains: Redirect URL	generate a URL to redirect payments to Unstoppable Domains to be processed, does not require native paid domain flow	Redirect URL Payments Guide
Paid domains: Redirect URL With Auto-Configured Crypto Records	generate a URL to redirect payments to Unstoppable Domains to be processed and automatically configure domain records, does not require native paid domain flow	Redirect URL Payments With Auto-Configured Crypto Records Guide

info

Unstoppable Domains provides a Sandbox Environment for partners to test their integrations.

Considerations

The following considerations apply to purchasing domains:

The domain must contain only letters ( a-z ), numbers ( 0-9 ), and hyphens ( - )
The domain name cannot start with a hyphen ( - )
The domain length must not exceed 253 characters

Fork Our Postman Collection

Unstoppable Domains offers a Postman collection that you can easily import into your workspace to quickly interact with the Partner and Domain Actions API.

Asking For Help

If you are experiencing difficulties using our services, please know that we are here to help. You can join our Discord Community for real-time support from UD and the community, where you can receive assistance with integrating your app

Help Us Improve

Please take a few moments to answer some questions about your experience with our Partner API. Your feedback will help us improve our services.