Skip to content

Request removal of a registry lock

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

Ask Hostup to remove the registry lock from an active .se or .nu domain. Call it when registryLock.unlockAction.href is set on GET /api/v2/domains/{id}. For other domain endings, turn the lock off with registrarLock: false on PATCH /api/v2/domains/{id}. Hostup checks that you may act for the domain holder and then removes the lock by hand. The check needs a client-area login verified with BankID. An API key alone cannot send a new request. status says what happened. When it is verification_failed, verificationReason says why. To send the request for manual review anyway, resend with forceRequest: true.

Authentication: An API key with the scope write:domains. About keys and scopes

Request

Path parameters

idstringrequired
The domain ID (dom_…).

Body (optional)

forceRequestboolean
Send the request for manual review although the identity check failed. Only after a verification_failed response. Default false.

Example

POST /api/v2/domains/{id}/actions/request-unlock
curl -X POST "https://cloud.hostup.se/api/v2/domains/dom_01hxa3b4c5d6e7f8g9h0j1k2m3/actions/request-unlock" \
-H "Authorization: Bearer $HOSTUP_API_KEY" \
-H "Content-Type: application/json"

Responses

200 The outcome of the request.

Response 200
{
"domainId": "dom_01hxa3b4c5d6e7f8g9h0j1k2m3",
"status": "submitted",
"domainName": "example.se",
"domainExtension": null,
"ticVerified": true,
"verifiedAs": "Styrelseledamot",
"companyName": "Example AB",
"daysSinceRequest": null,
"verificationReason": null,
"domainOrgno": null,
"yourOrgno": null,
"requiresConfirmation": false
}
Response fields
domainIdstring
The domain ID.
statusstring
What happened. Branch on this field. One of already_unlocked, already_requested, bankid_required, verification_failed, submitted.
domainNamestring or null
The domain name.
domainExtensionstring or null
The domain ending, set with bankid_required.
ticVerifiedboolean or null
True when your right to act for the domain holder was confirmed automatically.
verifiedAsstring or null
Your role in the holder’s company, as the company register lists it.
companyNamestring or null
The holder’s company name, when the holder is a company.
daysSinceRequestnumber or null
Days since the open request was sent, with already_requested.
verificationReasonstring or null
Why the identity check failed, with verification_failed.
verificationUnavailableboolean
True when the company register could not be reached. Present only then.
reasonCodestring
Why the company register could not be checked. Present with verificationUnavailable. One of company_lookup_unavailable, company_lookup_rate_limited.
retryAfterAtstring or null
When to try the company check again, if known. Present with verificationUnavailable.
domainOrgnostring or null
The holder’s identity or organisation number, with verification_failed.
yourOrgnostring or null
The identity number from your BankID login, with verification_failed.
requiresConfirmationboolean
True when you may resend with forceRequest: true.

Errors

Errors are Problem Details with a stable code. Branch on the code, not on the text.

400The body is not valid or the domain is not a .se or .nu domain.
401Unauthorized. Authentication is required.
403Forbidden. The caller lacks a required scope or does not own the resource.
404The domain does not exist in your account.
409The domain is not active (domain_not_active). serviceStatus gives its status.
429Rate limited. Retry after the limit resets. 429 responses include Retry-After seconds plus X-RateLimit-* headers.
500With an API key, a new request answers internal_error because the request needs a BankID login. Retrying gives the same answer. Send the request from the client area.