Request domain unlock

POST /api/v2/domains/{id}/actions/request-unlock

Request registry-lock unlock for an active .se or .nu domain.

Use id from GET /api/v2/domains data[].id; do not pass the raw hostname.

Call this endpoint only when a domain or nameserver response exposes unlockAction.href.

For other TLDs, manage the normal registrar-lock boolean with PATCH /api/v2/domains/{id} registrarLock instead.

The optional forceRequest flag is only for retrying after the API returned status: "verification_failed" with requiresConfirmation: true and the user has confirmed they still want staff review.

Domains & DNS Domains

Authentication

Required API scope: write:domains

Authenticate with an API key in the Authorization: Bearer <token> header.

Context

Related endpoints

POST /api/v2/domains/{id}/actions/renew Renew a domain POST /api/v2/domains/{id}/actions/update-epp Save EPP code for transfer POST /api/v2/domains/{id}/actions/request-epp Request an EPP code

Path Parameters

id string required Example: dom_01hxa3b4c5d6e7f8g9h0j1k2m3

Public domain ID. Get it from GET /api/v2/domains data[].id. Do not invent this value; use the exact ID returned by the referenced API response.

Headers

Authorization Bearer <token>

Accept application/json

Content-Type application/json

Body

optional

application/json

forceRequest boolean · Example: false

For .se/.nu only. Set true after a previous response required explicit confirmation to bypass automated company authorization and queue staff review.

Responses

200 Registry-lock unlock request result. 12 fields

domainId string required · Example: dom_01hxa3b4c5d6e7f8g9h0j1k2m3

Public domain ID from GET /api/v2/domains data[].id.

status string · enum required · Example: submitted

Machine-readable outcome. Branch on this field instead of parsing explanatory text.

already_unlocked

already_requested

bankid_required

verification_failed

submitted

domainName string · nullable required · Example: example.se

domainExtension string · nullable required · Example: se

ticVerified boolean · nullable required · Example: true

Whether the automated company authorization check succeeded when applicable.

verifiedAs string · nullable required · Example: account_owner

companyName string · nullable required · Example: Example AB

daysSinceRequest number · nullable required · Example: null

Days since an existing pending unlock request was submitted, when the API detected one.

verificationReason string · nullable required · Example: null

Human-readable reason when the unlock cannot be submitted automatically.

domainOrgno string · nullable required · Example: 5566778899

Organisation number on the domain record when relevant to verification.

yourOrgno string · nullable required · Example: 5566778899

Organisation number on the authenticated account when relevant to verification.

requiresConfirmation boolean required · Example: false

True when the caller may retry with forceRequest: true after user confirmation.

400 Invalid request body. 10 fields

type string · Example: https://developer.hostup.se/errors/invalid_request

title string · Example: Validation failed

status integer · Example: 400

detail string · Example: The request body failed validation.

code string · Example: invalid_request

Stable machine-readable code. Branch on this field, not on detail.

instance string · Example: /api/v2/orders

requestId string · Example: req_01hxa3b4c5d6e7f8g9h0j1k2m3

timestamp string · Example: 2026-04-27T12:34:56.000Z

errors array<object>

Field-level validation errors when code is invalid_request.

errors[].pointer string required · Example: /items/0/eppCode

errors[].detail string required · Example: `eppCode` is required for this transfer.

errors[].code string required · Example: missing_required

extensions object

401 Unauthorized. Authentication is required. 10 fields

type string · Example: https://developer.hostup.se/errors/invalid_request

title string · Example: Validation failed

status integer · Example: 400

detail string · Example: The request body failed validation.

code string · Example: invalid_request

Stable machine-readable code. Branch on this field, not on detail.

instance string · Example: /api/v2/orders

requestId string · Example: req_01hxa3b4c5d6e7f8g9h0j1k2m3

timestamp string · Example: 2026-04-27T12:34:56.000Z

errors array<object>

Field-level validation errors when code is invalid_request.

errors[].pointer string required · Example: /items/0/eppCode

errors[].detail string required · Example: `eppCode` is required for this transfer.

errors[].code string required · Example: missing_required

extensions object

403 Forbidden. The caller lacks a required scope or does not own the resource. 10 fields

type string · Example: https://developer.hostup.se/errors/invalid_request

title string · Example: Validation failed

status integer · Example: 400

detail string · Example: The request body failed validation.

code string · Example: invalid_request

Stable machine-readable code. Branch on this field, not on detail.

instance string · Example: /api/v2/orders

requestId string · Example: req_01hxa3b4c5d6e7f8g9h0j1k2m3

timestamp string · Example: 2026-04-27T12:34:56.000Z

errors array<object>

Field-level validation errors when code is invalid_request.

errors[].pointer string required · Example: /items/0/eppCode

errors[].detail string required · Example: `eppCode` is required for this transfer.

errors[].code string required · Example: missing_required

extensions object

404 Domain was not found for the caller. 10 fields

type string · Example: https://developer.hostup.se/errors/invalid_request

title string · Example: Validation failed

status integer · Example: 400

detail string · Example: The request body failed validation.

code string · Example: invalid_request

Stable machine-readable code. Branch on this field, not on detail.

instance string · Example: /api/v2/orders

requestId string · Example: req_01hxa3b4c5d6e7f8g9h0j1k2m3

timestamp string · Example: 2026-04-27T12:34:56.000Z

errors array<object>

Field-level validation errors when code is invalid_request.

errors[].pointer string required · Example: /items/0/eppCode

errors[].detail string required · Example: `eppCode` is required for this transfer.

errors[].code string required · Example: missing_required

extensions object

409 Unlock request could not be accepted in the current state. 10 fields

type string · Example: https://developer.hostup.se/errors/invalid_request

title string · Example: Validation failed

status integer · Example: 400

detail string · Example: The request body failed validation.

code string · Example: invalid_request

Stable machine-readable code. Branch on this field, not on detail.

instance string · Example: /api/v2/orders

requestId string · Example: req_01hxa3b4c5d6e7f8g9h0j1k2m3

timestamp string · Example: 2026-04-27T12:34:56.000Z

errors array<object>

Field-level validation errors when code is invalid_request.

errors[].pointer string required · Example: /items/0/eppCode

errors[].detail string required · Example: `eppCode` is required for this transfer.

errors[].code string required · Example: missing_required

extensions object

429 Rate limited. Retry after the limit resets. 429 responses include Retry-After seconds plus X-RateLimit-* headers. 10 fields

type string · Example: https://developer.hostup.se/errors/invalid_request

title string · Example: Validation failed

status integer · Example: 400

detail string · Example: The request body failed validation.

code string · Example: invalid_request

Stable machine-readable code. Branch on this field, not on detail.

instance string · Example: /api/v2/orders

requestId string · Example: req_01hxa3b4c5d6e7f8g9h0j1k2m3

timestamp string · Example: 2026-04-27T12:34:56.000Z

errors array<object>

Field-level validation errors when code is invalid_request.

errors[].pointer string required · Example: /items/0/eppCode

errors[].detail string required · Example: `eppCode` is required for this transfer.

errors[].code string required · Example: missing_required

extensions object

500 Internal error. Retry later or contact support if the issue persists. 10 fields

type string · Example: https://developer.hostup.se/errors/invalid_request

title string · Example: Validation failed

status integer · Example: 400

detail string · Example: The request body failed validation.

code string · Example: invalid_request

Stable machine-readable code. Branch on this field, not on detail.

instance string · Example: /api/v2/orders

requestId string · Example: req_01hxa3b4c5d6e7f8g9h0j1k2m3

timestamp string · Example: 2026-04-27T12:34:56.000Z

errors array<object>

Field-level validation errors when code is invalid_request.

errors[].pointer string required · Example: /items/0/eppCode

errors[].detail string required · Example: `eppCode` is required for this transfer.

errors[].code string required · Example: missing_required

extensions object

POST https://cloud.hostup.se/api/v2/domains/{id}/actions/request-unlock

For AI assistants

View as Markdown

cURL

curl -X POST "https://cloud.hostup.se/api/v2/domains/dom_01hxa3b4c5d6e7f8g9h0j1k2m3/actions/request-unlock" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Response

{
  "domainId": "dom_01hxa3b4c5d6e7f8g9h0j1k2m3",
  "status": "submitted",
  "domainName": "example.se",
  "domainExtension": "se",
  "ticVerified": true,
  "verifiedAs": "account_owner",
  "companyName": "Example AB",
  "daysSinceRequest": null,
  "verificationReason": null,
  "domainOrgno": "5566778899",
  "yourOrgno": "5566778899",
  "requiresConfirmation": false
}

{
  "type": "object",
  "properties": {
    "domainId": {
      "type": "string",
      "description": "Public domain ID from `GET /api/v2/domains` `data[].id`."
    },
    "status": {
      "type": "string",
      "description": "Machine-readable outcome. Branch on this field instead of parsing explanatory text.",
      "enum": [
        "already_unlocked",
        "already_requested",
        "bankid_required",
        "verification_failed",
        "submitted"
      ]
    },
    "domainName": {
      "type": "string",
      "nullable": true
    },
    "domainExtension": {
      "type": "string",
      "nullable": true
    },
    "ticVerified": {
      "type": "boolean",
      "description": "Whether the automated company authorization check succeeded when applicable.",
      "nullable": true
    },
    "verifiedAs": {
      "type": "string",
      "nullable": true
    },
    "companyName": {
      "type": "string",
      "nullable": true
    },
    "daysSinceRequest": {
      "type": "number",
      "description": "Days since an existing pending unlock request was submitted, when the API detected one.",
      "nullable": true
    },
    "verificationReason": {
      "type": "string",
      "description": "Human-readable reason when the unlock cannot be submitted automatically.",
      "nullable": true
    },
    "domainOrgno": {
      "type": "string",
      "description": "Organisation number on the domain record when relevant to verification.",
      "nullable": true
    },
    "yourOrgno": {
      "type": "string",
      "description": "Organisation number on the authenticated account when relevant to verification.",
      "nullable": true
    },
    "requiresConfirmation": {
      "type": "boolean",
      "description": "True when the caller may retry with `forceRequest: true` after user confirmation."
    }
  }
}

Request Body Normal unlock request