Domain Transfers

Download schema

Endpoints for managing incoming and outgoing domain transfers.

Cancel failed incoming transfer

DELETE

https://domain.chief.app/api/v1

/domains/{domainNameOrId}/transfer

OpenID Connect

Bearer (ctp_*)

Bearer (ctt_*)

Cancel a failed incoming transfer. The placeholder domain is deleted and no refund is issued.

Cancel failed incoming transfer › path Parameters

domainNameOrId

string · required

full domain name or ID

Cancel failed incoming transfer › Responses

No content

No data returned

Show the auth-code

GET

https://domain.chief.app/api/v1

/domains/{domainNameOrId}/auth-code

OpenID Connect

Bearer (ctp_*)

Bearer (ctt_*)

Retrieve the auth-code for a single domain for the authenticated team.

Some TLDs do not provide the auth-code to us but instead send it to the domain's registrant email address. You can use the POST version of this endpoint to request the auth-code to be sent. Set refresh to request the code from the registrar even when a valid code is cached. Depending on the registry, this may synchronize the current code or generate a new one.

Show the auth-code › path Parameters

domainNameOrId

string · required

full domain name or ID

Show the auth-code › query Parameters

refresh

boolean

Request the authorization code from the registrar even when a valid code is cached.

Default: false

Show the auth-code › Responses

object · required

Send the auth-code

POST

https://domain.chief.app/api/v1

/domains/{domainNameOrId}/auth-code

OpenID Connect

Bearer (ctp_*)

Bearer (ctt_*)

Queue an auth-code delivery request for a single domain for the authenticated team.

Some TLDs do not provide the auth-code to us but instead send it to the domain's registrant email address. To retrieve the auth-code directly, use the GET version of this endpoint.

Send the auth-code › path Parameters

domainNameOrId

string · required

full domain name or ID

Send the auth-code › Responses

No data returned

Initiate a push transfer

POST

https://domain.chief.app/api/v1

/domains/{domainNameOrId}/transfer/push

OpenID Connect

Bearer (ctp_*)

Bearer (ctt_*)

Initiate a push transfer for a single domain for the authenticated team.

A push transfer changes the registrar tag of the domain to transfer it to another registrar. This is only available for certain TLDs (like .uk) that support tag-based transfers.

The transfer is processed asynchronously. Once a transfer is requested you are unable to update the request unless the transfer fails or the new regisrar rejects the request. If more than 5 days passes without any action the transfer expires and can be retried.

Initiate a push transfer › path Parameters

domainNameOrId

string · required

full domain name or ID

Initiate a push transfer › Request Body

recipient

string · pattern: ^[a-zA-Z0-9-]{2,16}$ · required

The registrar tag of the receiving registrar. Must be 2-16 characters, alphanumeric and hyphens only.

Example: DOMAINCHIEF

Initiate a push transfer › Responses

DomainWithNotices

DomainWithNotices · required

POST/domains/{domainNameOrId}/transfer/push

curl https://domain.chief.app/api/v1/domains/:domainNameOrId/transfer/push \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "recipient": "DOMAINCHIEF"
}'

Example Request Body

{
  "recipient": "DOMAINCHIEF"
}

json

Example Responses

{
  "data": {
    "id": "id",
    "name": "example",
    "tld": "com",
    "domain": "example.nl",
    "unicode_domain": "example.nl",
    "type": "type",
    "status": "status",
    "is_premium": true,
    "is_locked": true,
    "is_autorenew_enabled": true,
    "is_whois_privacy_enabled": true,
    "is_using_hosted_dns": true,
    "is_dnssec_enabled": true,
    "contacts": {
      "owner": "CHIEF-CT0000-NL",
      "admin": "CHIEF-CT0000-NL",
      "tech": "CHIEF-CT0000-NL"
    },
    "dnssec_keys": [
      {
        "public_key": "public_key",
        "algorithm": 0,
        "flags": 0,
        "protocol": 3
      }
    ],
    "nameservers": [
      {
        "hostname": "hostname",
        "ipv4": "ipv4",
        "ipv6": "ipv6"
      }
    ],
    "nameserver_provider": "nameserver_provider",
    "intended_use": "intended_use",
    "renews_at": "2024-08-25T15:00:00Z",
    "expires_at": "2024-08-25T15:00:00Z",
    "renewal_price": 826,
    "mail_forward_status": "mail_forward_status",
    "mail_forward_renews_at": "2024-08-25T15:00:00Z",
    "scheduled_transfer_at": "2024-08-25T15:00:00Z",
    "scheduled_transfer_locks_at": "2024-08-25T15:00:00Z",
    "notices": [
      {
        "code": "code",
        "type": "type",
        "severity": "severity",
        "message": "message",
        "actions": [
          "string"
        ],
        "data": {
          "attribute": "string",
          "attributes": [
            "string"
          ],
          "cause": "string",
          "contact_verification_context": "string",
          "operation": "string",
          "renewal_years": 0,
          "renewal_price": 0,
          "resulting_expires_at": "resulting_expires_at",
          "contact_verification_url": "https://www.example.com/path/to/resource",
          "registrar_tag": "registrar_tag",
          "restorable_until": "2024-08-25T15:00:00Z",
          "scheduled_transfer_at": "2024-08-25T15:00:00Z",
          "scheduled_transfer_locks_at": "2024-08-25T15:00:00Z",
          "auto_completes_at": "2024-08-25T15:00:00Z",
          "requires_intended_use": true,
          "registry_restriction_reason": "string",
          "registry_restriction_detail": "registry_restriction_detail",
          "restricted_since": "2024-08-25T15:00:00Z",
          "suspension_scheduled_at": "2024-08-25T15:00:00Z",
          "operation_id": "operation_id"
        }
      }
    ],
    "registry_restrictions": [
      {
        "type": "type",
        "reason": "reason",
        "detail": "detail",
        "effective_at": "2024-08-25T15:00:00Z",
        "since": "2024-08-25T15:00:00Z"
      }
    ],
    "metadata": {
      "key": "string"
    }
  }
}

json

application/json

Retry a failed transfer

POST

https://domain.chief.app/api/v1

/domains/{domainNameOrId}/transfer/retry

OpenID Connect

Bearer (ctp_*)

Bearer (ctt_*)

Retry a failed incoming transfer for a single domain for the authenticated team. No additional charge is created for a transfer retry. This endpoint is only available for failed transfers that require an auth-code.

Retry a failed transfer › path Parameters

domainNameOrId

string · required

full domain name or ID

Retry a failed transfer › Request Body

auth_code

string · minLength: 1 · required

The authorization code required to retry the transfer.

intended_use

string | null · maxLength: 500

Required when this historical transfer does not yet have its intended-use declaration.

Retry a failed transfer › Responses

The transfer retry was accepted. The returned domain and notices reflect the state after the retry was requested; the transfer itself may still be processing.

DomainWithNotices · required

POST/domains/{domainNameOrId}/transfer/retry

curl https://domain.chief.app/api/v1/domains/:domainNameOrId/transfer/retry \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "auth_code": "auth_code",
  "intended_use": "intended_use"
}'

Example Request Body

{
  "auth_code": "auth_code",
  "intended_use": "intended_use"
}

json

Example Responses

{
  "data": {
    "id": "id",
    "name": "example",
    "tld": "com",
    "domain": "example.nl",
    "unicode_domain": "example.nl",
    "type": "type",
    "status": "status",
    "is_premium": true,
    "is_locked": true,
    "is_autorenew_enabled": true,
    "is_whois_privacy_enabled": true,
    "is_using_hosted_dns": true,
    "is_dnssec_enabled": true,
    "contacts": {
      "owner": "CHIEF-CT0000-NL",
      "admin": "CHIEF-CT0000-NL",
      "tech": "CHIEF-CT0000-NL"
    },
    "dnssec_keys": [
      {
        "public_key": "public_key",
        "algorithm": 0,
        "flags": 0,
        "protocol": 3
      }
    ],
    "nameservers": [
      {
        "hostname": "hostname",
        "ipv4": "ipv4",
        "ipv6": "ipv6"
      }
    ],
    "nameserver_provider": "nameserver_provider",
    "intended_use": "intended_use",
    "renews_at": "2024-08-25T15:00:00Z",
    "expires_at": "2024-08-25T15:00:00Z",
    "renewal_price": 826,
    "mail_forward_status": "mail_forward_status",
    "mail_forward_renews_at": "2024-08-25T15:00:00Z",
    "scheduled_transfer_at": "2024-08-25T15:00:00Z",
    "scheduled_transfer_locks_at": "2024-08-25T15:00:00Z",
    "notices": [
      {
        "code": "code",
        "type": "type",
        "severity": "severity",
        "message": "message",
        "actions": [
          "string"
        ],
        "data": {
          "attribute": "string",
          "attributes": [
            "string"
          ],
          "cause": "string",
          "contact_verification_context": "string",
          "operation": "string",
          "renewal_years": 0,
          "renewal_price": 0,
          "resulting_expires_at": "resulting_expires_at",
          "contact_verification_url": "https://www.example.com/path/to/resource",
          "registrar_tag": "registrar_tag",
          "restorable_until": "2024-08-25T15:00:00Z",
          "scheduled_transfer_at": "2024-08-25T15:00:00Z",
          "scheduled_transfer_locks_at": "2024-08-25T15:00:00Z",
          "auto_completes_at": "2024-08-25T15:00:00Z",
          "requires_intended_use": true,
          "registry_restriction_reason": "string",
          "registry_restriction_detail": "registry_restriction_detail",
          "restricted_since": "2024-08-25T15:00:00Z",
          "suspension_scheduled_at": "2024-08-25T15:00:00Z",
          "operation_id": "operation_id"
        }
      }
    ],
    "registry_restrictions": [
      {
        "type": "type",
        "reason": "reason",
        "detail": "detail",
        "effective_at": "2024-08-25T15:00:00Z",
        "since": "2024-08-25T15:00:00Z"
      }
    ],
    "metadata": {
      "key": "string"
    }
  }
}

json

application/json

Decide whether to accept or reject an outgoing transfer

POST

https://domain.chief.app/api/v1

/domains/{domainNameOrId}/transfer/decision

OpenID Connect

Bearer (ctp_*)

Bearer (ctt_*)

Submit an explicit decision for a pending outgoing transfer.

Decide whether to accept or reject an outgoing transfer › path Parameters

domainNameOrId

string · required

full domain name or ID

Decide whether to accept or reject an outgoing transfer › Request Body

decision

DomainTransferDecision · enum · required

Accept or reject the outgoing transfer.


`accept` Allow the domain to leave the current registrar account.
`reject` Refuse the outgoing transfer request.

Enum values:

reject

Decide whether to accept or reject an outgoing transfer › Responses

DomainWithNotices

DomainWithNotices · required

POST/domains/{domainNameOrId}/transfer/decision

curl https://domain.chief.app/api/v1/domains/:domainNameOrId/transfer/decision \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "decision": "accept"
}'

Example Request Body

{
  "decision": "accept"
}

json

Example Responses

{
  "data": {
    "id": "id",
    "name": "example",
    "tld": "com",
    "domain": "example.nl",
    "unicode_domain": "example.nl",
    "type": "type",
    "status": "status",
    "is_premium": true,
    "is_locked": true,
    "is_autorenew_enabled": true,
    "is_whois_privacy_enabled": true,
    "is_using_hosted_dns": true,
    "is_dnssec_enabled": true,
    "contacts": {
      "owner": "CHIEF-CT0000-NL",
      "admin": "CHIEF-CT0000-NL",
      "tech": "CHIEF-CT0000-NL"
    },
    "dnssec_keys": [
      {
        "public_key": "public_key",
        "algorithm": 0,
        "flags": 0,
        "protocol": 3
      }
    ],
    "nameservers": [
      {
        "hostname": "hostname",
        "ipv4": "ipv4",
        "ipv6": "ipv6"
      }
    ],
    "nameserver_provider": "nameserver_provider",
    "intended_use": "intended_use",
    "renews_at": "2024-08-25T15:00:00Z",
    "expires_at": "2024-08-25T15:00:00Z",
    "renewal_price": 826,
    "mail_forward_status": "mail_forward_status",
    "mail_forward_renews_at": "2024-08-25T15:00:00Z",
    "scheduled_transfer_at": "2024-08-25T15:00:00Z",
    "scheduled_transfer_locks_at": "2024-08-25T15:00:00Z",
    "notices": [
      {
        "code": "code",
        "type": "type",
        "severity": "severity",
        "message": "message",
        "actions": [
          "string"
        ],
        "data": {
          "attribute": "string",
          "attributes": [
            "string"
          ],
          "cause": "string",
          "contact_verification_context": "string",
          "operation": "string",
          "renewal_years": 0,
          "renewal_price": 0,
          "resulting_expires_at": "resulting_expires_at",
          "contact_verification_url": "https://www.example.com/path/to/resource",
          "registrar_tag": "registrar_tag",
          "restorable_until": "2024-08-25T15:00:00Z",
          "scheduled_transfer_at": "2024-08-25T15:00:00Z",
          "scheduled_transfer_locks_at": "2024-08-25T15:00:00Z",
          "auto_completes_at": "2024-08-25T15:00:00Z",
          "requires_intended_use": true,
          "registry_restriction_reason": "string",
          "registry_restriction_detail": "registry_restriction_detail",
          "restricted_since": "2024-08-25T15:00:00Z",
          "suspension_scheduled_at": "2024-08-25T15:00:00Z",
          "operation_id": "operation_id"
        }
      }
    ],
    "registry_restrictions": [
      {
        "type": "type",
        "reason": "reason",
        "detail": "detail",
        "effective_at": "2024-08-25T15:00:00Z",
        "since": "2024-08-25T15:00:00Z"
      }
    ],
    "metadata": {
      "key": "string"
    }
  }
}

json

application/json

Move scheduled incoming transfer

PATCH

https://domain.chief.app/api/v1

/domains/{domainNameOrId}/transfer/schedule

OpenID Connect

Bearer (ctp_*)

Bearer (ctt_*)

Move a scheduled incoming transfer to a new future minute. The schedule can be moved until five minutes before execution.

Move scheduled incoming transfer › path Parameters

domainNameOrId

string · required

full domain name or ID

Move scheduled incoming transfer › Request Body

scheduled_transfer_at

string · date-time · required

Use an RFC 3339 timestamp; if no timezone is provided, UTC is assumed. Seconds are discarded, and the resulting UTC minute must be at least 15 minutes and at most one year in the future.

auth_code

string

Optional replacement authorization code for the incoming transfer. Supply it only when the transfer uses an authorization code and that code has changed. When provided, it replaces the code that will be submitted when the scheduled transfer starts; when omitted, the current code is retained.

Move scheduled incoming transfer › Responses

DomainWithNotices

DomainWithNotices · required

PATCH/domains/{domainNameOrId}/transfer/schedule

curl https://domain.chief.app/api/v1/domains/:domainNameOrId/transfer/schedule \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "scheduled_transfer_at": "2024-08-25T15:00:00Z",
  "auth_code": "auth_code"
}'

Example Request Body

{
  "scheduled_transfer_at": "2024-08-25T15:00:00Z",
  "auth_code": "auth_code"
}

json

Example Responses

{
  "data": {
    "id": "id",
    "name": "example",
    "tld": "com",
    "domain": "example.nl",
    "unicode_domain": "example.nl",
    "type": "type",
    "status": "status",
    "is_premium": true,
    "is_locked": true,
    "is_autorenew_enabled": true,
    "is_whois_privacy_enabled": true,
    "is_using_hosted_dns": true,
    "is_dnssec_enabled": true,
    "contacts": {
      "owner": "CHIEF-CT0000-NL",
      "admin": "CHIEF-CT0000-NL",
      "tech": "CHIEF-CT0000-NL"
    },
    "dnssec_keys": [
      {
        "public_key": "public_key",
        "algorithm": 0,
        "flags": 0,
        "protocol": 3
      }
    ],
    "nameservers": [
      {
        "hostname": "hostname",
        "ipv4": "ipv4",
        "ipv6": "ipv6"
      }
    ],
    "nameserver_provider": "nameserver_provider",
    "intended_use": "intended_use",
    "renews_at": "2024-08-25T15:00:00Z",
    "expires_at": "2024-08-25T15:00:00Z",
    "renewal_price": 826,
    "mail_forward_status": "mail_forward_status",
    "mail_forward_renews_at": "2024-08-25T15:00:00Z",
    "scheduled_transfer_at": "2024-08-25T15:00:00Z",
    "scheduled_transfer_locks_at": "2024-08-25T15:00:00Z",
    "notices": [
      {
        "code": "code",
        "type": "type",
        "severity": "severity",
        "message": "message",
        "actions": [
          "string"
        ],
        "data": {
          "attribute": "string",
          "attributes": [
            "string"
          ],
          "cause": "string",
          "contact_verification_context": "string",
          "operation": "string",
          "renewal_years": 0,
          "renewal_price": 0,
          "resulting_expires_at": "resulting_expires_at",
          "contact_verification_url": "https://www.example.com/path/to/resource",
          "registrar_tag": "registrar_tag",
          "restorable_until": "2024-08-25T15:00:00Z",
          "scheduled_transfer_at": "2024-08-25T15:00:00Z",
          "scheduled_transfer_locks_at": "2024-08-25T15:00:00Z",
          "auto_completes_at": "2024-08-25T15:00:00Z",
          "requires_intended_use": true,
          "registry_restriction_reason": "string",
          "registry_restriction_detail": "registry_restriction_detail",
          "restricted_since": "2024-08-25T15:00:00Z",
          "suspension_scheduled_at": "2024-08-25T15:00:00Z",
          "operation_id": "operation_id"
        }
      }
    ],
    "registry_restrictions": [
      {
        "type": "type",
        "reason": "reason",
        "detail": "detail",
        "effective_at": "2024-08-25T15:00:00Z",
        "since": "2024-08-25T15:00:00Z"
      }
    ],
    "metadata": {
      "key": "string"
    }
  }
}

json

application/json

Cancel scheduled incoming transfer

DELETE

https://domain.chief.app/api/v1

/domains/{domainNameOrId}/transfer/schedule

OpenID Connect

Bearer (ctp_*)

Bearer (ctt_*)

Cancel a scheduled incoming transfer until five minutes before execution. The placeholder domain is deleted.

Cancel scheduled incoming transfer › path Parameters

domainNameOrId

string · required

full domain name or ID

Cancel scheduled incoming transfer › Responses

No content

No data returned

Domain Registration Domain Activity & Notices