Auth Codes

Server

Download schema

Modify domain authorization code

PUT

https://api.sandbox.resellerclub.com/v2

/domains/{orderId}/auth-code

Authorization (header)

+X-User-Id (header)

Resets a domain's authorization code, which is required before the domain can be transferred to another registrar.

Modify domain authorization code › path Parameters

orderId

integer · int32 · required

Modify domain authorization code › Request Body

UpdateAuthCodeRequest

authCode

string · minLength: 1 · required

Domain authorization code. For gTLDs, must contain at least one letter, one number, and one special character; this requirement may not apply to ccTLDs.

otp

string

OTP to authenticate the request when two-factor authentication is enabled.

twoFactorType

string · enum

Type of 2FA authentication.

Enum values:

Modify domain authorization code › Responses

UpdateAuthCodeResponse

actionStatus

string

Status code of the queued domain action.

actionStatusDesc

string

Human-readable description of the action status.

actionTypeDesc

string

Human-readable description of the action type.

entityId

string

Internal entity identifier for the domain order.

eaqId

string

Entity action queue identifier for tracking the operation.

actionType

string

Action type code for the queued operation.

currentAction

string

description

string

Free-text description of the action or domain row.

status

string

Overall operation status (for example, Success or Failed).

message

string

Additional status or error message from the operation.

PUT/domains/{orderId}/auth-code

curl https://api.sandbox.resellerclub.com/v2/domains/:orderId/auth-code \
  --request PUT \
  --header 'Content-Type: application/json' \
  --header 'Authorization: <api-key>' \
  --header 'X-User-Id: <api-key>' \
  --data '{
  "authCode": "authCode",
  "otp": "otp",
  "twoFactorType": null
}'

Example Request Body

{
  "authCode": "authCode",
  "otp": "otp",
  "twoFactorType": null
}

json

Example Responses

{
  "actionStatus": "actionStatus",
  "actionStatusDesc": "actionStatusDesc",
  "actionTypeDesc": "actionTypeDesc",
  "entityId": "entityId",
  "eaqId": "eaqId",
  "actionType": "actionType",
  "currentAction": "currentAction",
  "description": "description",
  "status": "status",
  "message": "message"
}

json

application/json

Domains Bulk Operations

Modify domain authorization code

PUT

https://api.sandbox.resellerclub.com/v2

/domains/{orderId}/auth-code

Authorization (header)

+X-User-Id (header)

Resets a domain's authorization code, which is required before the domain can be transferred to another registrar.

Modify domain authorization code › path Parameters

orderId

integer · int32 · required

Modify domain authorization code › Request Body

UpdateAuthCodeRequest

authCode

string · minLength: 1 · required

Domain authorization code. For gTLDs, must contain at least one letter, one number, and one special character; this requirement may not apply to ccTLDs.

otp

string

OTP to authenticate the request when two-factor authentication is enabled.

twoFactorType

string · enum

Type of 2FA authentication.

Enum values:

Responses

UpdateAuthCodeResponse

actionStatus

string

Status code of the queued domain action.

actionStatusDesc

string

Human-readable description of the action status.

actionTypeDesc

string

Human-readable description of the action type.

entityId

string

Internal entity identifier for the domain order.

eaqId

string

Entity action queue identifier for tracking the operation.

actionType

string

Action type code for the queued operation.

currentAction

string

description

string

Free-text description of the action or domain row.

status

string

Overall operation status (for example, Success or Failed).

message

string

Additional status or error message from the operation.