API docs by Redocly

Business Registry API (1.0.0)

Download OpenAPI specification:Download

API for managing domain name registration and reservation in the business registry.

Key features:

  • Free short-term domain reservation (7 days)
  • Paid long-term domain reservation (1 year)
  • Batch domain reservation (up to 20 domains per request)
  • Payment status tracking with access to domain passwords
  • Registration code retrieval

Process Overview:

1. Domain Name Suggestions:

Use the /business_registry/domain_names endpoint to receive suggestions for available domain names.

2. Domain Reservation Options:

  • Short-term Reservation: Use /business_registry/reserve_domains for free 7-day reservation
  • Long-term Reservation: Use /business_registry/long_reserve_domains for paid 1-year reservation (Price depends on the number of domains reserved)

3. Payment and Status Tracking:

  • For long-term reservations, use /business_registry/long_reserve_domains_status to:
    • Check payment status
    • Access domain passwords after successful payment

Important Notes:

  • Maximum limit: 20 domains per request
  • Authentication: All endpoints require both IP authentication and token authentication via the Authorization header
  • Payment processing: Handled through Linkpay Everypay without automatic redirects
  • Payment verification: After payment, use the status endpoint (/business_registry/long_reserve_domains_status) to verify payment completion as payment notifications are processed on our backend
  • Important: It's crucial to store the user_unique_id for both paid and free reservations:
    • For paid reservations: Ensures domain ownership for the first paying user
    • For free reservations: Required to retrieve domain passwords and reservation details later using the /business_registry/reserve_domains/{user_unique_id} endpoint

Long-term reservation process:

  • Each user requesting long-term domain reservation receives a unique payment link and invoice in Everypay
  • If domains in a new reservation request overlap with existing unpaid reservations, a new invoice with the same number but different user_unique_id is created
  • When one user completes payment, all other invoices with the same number are automatically cancelled (Everypay Linkpay behavior)
  • Users with cancelled invoices need to submit a new reservation request for their desired domains

Business Registry

Get available domain name variants for an organization

Generates and checks availability of domain name variants for a given organization name

Authorizations:
(ipRestrictionApiTokenAuth)
path Parameters
organization_name
required
string
Example: Example Company

Name of the organization to generate domain variants for

Responses

Response samples

Content type
application/json
{
  • "variants": [
    ]
}

Reserve multiple domains for long-term registration

Creates long-term domain reservations and returns payment information

Authorizations:
(ipRestrictionApiTokenAuth)
Request Body schema: application/json
domain_names
required
Array of strings

Array of domain names to reserve

Responses

Request samples

Content type
application/json
{
  • "domain_names": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "Domains are in pending status. Need to pay for domains.",
  • "linkpay_url": "https://payment.example.com/invoice/123",
  • "invoice_number": "1234567",
  • "user_unique_id": "user-123-xyz",
  • "available_domains": [
    ]
}

Check status of reserved domains (long-term reservations only)

Returns the current status of reserved domains and payment information.

Note: This endpoint is only for long-term (paid) domain reservations.

For short-term (free) domain reservations, use the /api/v1/business_registry/reserve_domains/{user_unique_id} endpoint instead.

Example URL:

/api/v1/business_registry/long_reserve_domains_status?invoice_number=1234567&user_unique_id=user-123-xyz
Authorizations:
(ipRestrictionApiTokenAuth)
query Parameters
invoice_number
required
string
Example: invoice_number=1234567

Invoice number for the reserved domains

user_unique_id
required
string
Example: user_unique_id=user-123-xyz

Unique identifier of the user

Responses

Response samples

Content type
application/json
{
  • "status": "pending",
  • "message": "Payment pending",
  • "names": [
    ]
}

Reserve domains without payment

Creates domain reservations without requiring immediate payment

Authorizations:
(ipRestrictionApiTokenAuth)
Request Body schema: application/json
domain_names
required
Array of strings [ 1 .. 20 ] items

Array of domain names to reserve

Responses

Request samples

Content type
application/json
{
  • "domain_names": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "Domains reserved successfully",
  • "reserved_domains": [
    ],
  • "user_unique_id": "f8d51313-b"
}

Get reserved domains information (short-term reservations only)

Retrieve information about previously reserved domains using user_unique_id.

Note: This endpoint is only for short-term (free) domain reservations.

For long-term (paid) domain reservations, use the /api/v1/business_registry/long_reserve_domains_status endpoint instead.

Authorizations:
(ipRestrictionApiTokenAuth)
path Parameters
user_unique_id
required
string
Example: f8d51313-b

Unique identifier received after reserving domains

Responses

Response samples

Content type
application/json
[
  • {
    }
]