Transfer Domains

Initiate and manage inbound and outbound domain transfers and transfer lifecycle actions.

Initiate inbound transfer

Authorization

bearerAuth

AuthorizationBearer <token>

Personal Access Token (PAT). Generate one from the developer dashboard. Pass as: Authorization: Bearer .

In: header

Path Parameters

customerId*string

The Customer identifier. Note: For API Resellers, performing actions on behalf of your customers, you need to specify the Subaccount customer identifier you're operating on behalf of.

domain*string

Domain to transfer in

Header Parameters

X-Request-Id?string

A client provided identifier for tracking this request.

Request Body

application/json

Details for domain transfer purchase

authCode*string

Authorization code from registrar for transferring a domain

period?integer

Can be more than 1 but no more than 10 years total including current registration length

Match^[0-9]+$

Formatinteger-positive

Range1 <= value <= 10

Default1

renewAuto?boolean

Whether or not the domain should be configured to automatically renew

Defaulttrue

privacy?boolean

Whether or not privacy has been requested

Defaultfalse

identityDocumentId?string

Unique identifier of the identify document that the user wants to associate with the domain being transferred in. This is required only if the gaining registry has a requirement for an approved identity document

consent*

contacts?

metadata?

The domain eligibility data fields as specified by GET /v2/customers/{customerId}/domains/register/schema/{tld}

Response Body

`application/json`

curl -X POST "https://example.com/v2/customers/string/domains/string/transfer" \  -H "Content-Type: application/json" \  -d '{    "authCode": "string",    "consent": {      "agreementKeys": [        "string"      ],      "price": 0,      "currency": "USD",      "agreedBy": "string",      "agreedAt": "string"    }  }'

Empty

Accept the inbound transfer

Authorization

bearerAuth

AuthorizationBearer <token>

Personal Access Token (PAT). Generate one from the developer dashboard. Pass as: Authorization: Bearer .

In: header

Path Parameters

customerId*string

The Customer identifier. Note: For API Resellers, performing actions on behalf of your customers, you need to specify the Subaccount customer identifier you're operating on behalf of.

domain*string

Domain to accept the transfer in for

Header Parameters

X-Request-Id?string

A client provided identifier for tracking this request.

Request Body

application/json

An Authorization code for transferring the Domain

authCode*string

Authorization code for transferring the Domain

Response Body

`application/json`

curl -X POST "https://example.com/v2/customers/string/domains/string/transferInAccept" \  -H "Content-Type: application/json" \  -d '{    "authCode": "string"  }'

Empty

Cancel the inbound transfer

Authorization

bearerAuth

AuthorizationBearer <token>

Personal Access Token (PAT). Generate one from the developer dashboard. Pass as: Authorization: Bearer .

In: header

Path Parameters

customerId*string

The Customer identifier. Note: For API Resellers, performing actions on behalf of your customers, you need to specify the Subaccount customer identifier you're operating on behalf of.

domain*string

Domain to cancel the transfer in for

Header Parameters

X-Request-Id?string

A client provided identifier for tracking this request.

Response Body

`application/json`

curl -X POST "https://example.com/v2/customers/string/domains/string/transferInCancel"

Empty

Restart the inbound transfer from the beginning

Authorization

bearerAuth

AuthorizationBearer <token>

Personal Access Token (PAT). Generate one from the developer dashboard. Pass as: Authorization: Bearer .

In: header

Path Parameters

customerId*string

The Customer identifier. Note: For API Resellers, performing actions on behalf of your customers, you need to specify the Subaccount customer identifier you're operating on behalf of.

domain*string

Domain to restart the transfer in

Header Parameters

X-Request-Id?string

A client provided identifier for tracking this request.

Response Body

`application/json`

curl -X POST "https://example.com/v2/customers/string/domains/string/transferInRestart"

Empty

Retry the inbound transfer with a new authorization code

Authorization

bearerAuth

AuthorizationBearer <token>

Personal Access Token (PAT). Generate one from the developer dashboard. Pass as: Authorization: Bearer .

In: header

Path Parameters

customerId*string

The Customer identifier. Note: For API Resellers, performing actions on behalf of your customers, you need to specify the Subaccount customer identifier you're operating on behalf of.

domain*string

Domain to retry the transfer in

Header Parameters

X-Request-Id?string

A client provided identifier for tracking this request.

Request Body

application/json

An Authorization code for transferring the Domain

authCode*string

Authorization code for transferring the Domain

Response Body

`application/json`

curl -X POST "https://example.com/v2/customers/string/domains/string/transferInRetry" \  -H "Content-Type: application/json" \  -d '{    "authCode": "string"  }'

Empty

Initiate an outbound transfer

Authorization

bearerAuth

AuthorizationBearer <token>

Personal Access Token (PAT). Generate one from the developer dashboard. Pass as: Authorization: Bearer .

In: header

Path Parameters

customerId*string

The Customer identifier. Note: For API Resellers, performing actions on behalf of your customers, you need to specify the Subaccount customer identifier you're operating on behalf of.

domain*string

Domain to initiate the transfer out for

Query Parameters

registrar*string

Registrar tag to push transfer to

Header Parameters

X-Request-Id?string

A client provided identifier for tracking this request.

Response Body

`application/json`

curl -X POST "https://example.com/v2/customers/string/domains/string/transferOut?registrar=string"

Empty

Accept the outbound transfer

Authorization

bearerAuth

AuthorizationBearer <token>

Personal Access Token (PAT). Generate one from the developer dashboard. Pass as: Authorization: Bearer .

In: header

Path Parameters

customerId*string

The Customer identifier. Note: For API Resellers, performing actions on behalf of your customers, you need to specify the Subaccount customer identifier you're operating on behalf of.

domain*string

Domain to accept the transfer out for

Header Parameters

X-Request-Id?string

A client provided identifier for tracking this request.

Response Body

`application/json`

curl -X POST "https://example.com/v2/customers/string/domains/string/transferOutAccept"

Empty

Reject the outbound transfer

Authorization

bearerAuth

AuthorizationBearer <token>

Personal Access Token (PAT). Generate one from the developer dashboard. Pass as: Authorization: Bearer .

In: header

Path Parameters

customerId*string

The Customer identifier. Note: For API Resellers, performing actions on behalf of your customers, you need to specify the Subaccount customer identifier you're operating on behalf of.

domain*string

Domain to reject the transfer out for

Query Parameters

reason?string

Transfer out reject reason

Value in

"EVIDENCE_OF_FRAUD"
"URDP_ACTION"
"COURT_ORDER"
"DISPUTE_OVER_IDENTITY"
"NO_PAYMENT_FOR_PREVIOUS_REGISTRATION_PERIOD"
"WRITTEN_OBJECTION"
"TRANSFERRED_WITHIN_SIXTY_DAYS"

Header Parameters

X-Request-Id?string

A client provided identifier for tracking this request.

Response Body

`application/json`

curl -X POST "https://example.com/v2/customers/string/domains/string/transferOutReject"

Empty

Agent & Automation Notes

Scopes

domains.domain:read, domains.domain:create, domains.domain:update, domains.contact:update, domains.nameserver:update, domains.transfer:execute, domains.transfer:update, domains.forward:update

Rate limit60 req/min per credential

On failureAsync operations return 202 with an Action object. Poll until terminal state. Do not resubmit transfers.

Guides

Concepts

Last updated on

Transfer Domains

202

400application/json

401application/json

403application/json

404application/json

409application/json

422application/json

429application/json

500application/json

202

400application/json

401application/json

403application/json

404application/json

409application/json

422application/json

429application/json

500application/json

202

401application/json

403application/json

404application/json

409application/json

429application/json

500application/json

202

401application/json

403application/json

404application/json

409application/json

429application/json

500application/json

202

400application/json

401application/json

403application/json

404application/json

409application/json

422application/json

429application/json

500application/json

202

401application/json

403application/json

404application/json

409application/json

422application/json

429application/json

500application/json

202

401application/json

403application/json

404application/json

409application/json

429application/json

500application/json

202

401application/json

403application/json

404application/json

409application/json

429application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`