Skip to main content
Atom Partnership APIs diagram Atom Partnership APIs Documentation This document describes the API sequence between a Partner system and Atom for managing domain lifecycle operations. It includes searching, retrieving, holding, unholding, confirming, and transferring domain names.
  1. Domain Search Request
    Endpoint: POST /api/domain/search
    Description: The Partner sends a request to Atom to search for available domains based on keywords or filters.
  2. Get Domain Details
    Endpoint: GET /api/domain/{domainName}
    Description: Fetches detailed information about a specific domain.
  3. Hold Domain
    Endpoint: POST /api/domain/hold
    Description: Temporarily holds a domain to prevent others from purchasing it.
  4. Unhold Domain
    Endpoint: POST /api/domain/unhold
    Description: Releases a previously held domain back to active status.
  5. Confirm Order (Purchase Domain)
    Endpoint: POST /api/domain/confirm-order
    Description: Finalizes the domain purchase after it is held.
  6. Get Transfer Auth Code
    Endpoint: GET /api/domain/{domainName}/authcode
    Description: Retrieves the transfer authorization code for a purchased domain.
Sequence Summary
StepActionRequest FromResponse FromDescription
1Domain SearchPartnerAtomReturns list of domains
2Get Domain DetailsPartnerAtomReturns domain info
3Hold DomainPartnerAtomLocks domain temporarily
4Unhold DomainPartnerAtomReleases domain hold
5Confirm OrderPartnerAtomMarks domain as purchased
6Get Transfer Auth CodePartnerAtomReturns transfer code or pending message