Skip to content

Create a BankID verification link

POST /api/v2/domains/{id}/verification

Creates a link where the domain holder verifies their identity with BankID. Share it with the holder or with a signatory of the holder company. The link is valid for 7 days. A new link replaces any earlier unused link for the domain. Once it is used, GET /api/v2/domains/{id}/verification returns verified: true and the holder’s personal or organisation number can be changed. Only active .se, .nu and .test domains with a personal or organisation number on file are supported. The body is empty or names contactType: "registrant".

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

Request

Path parameters

idstringrequired
The domain ID. From GET /api/v2/domains.

Body (optional)

contactTypestring
The contact to verify. Only registrant (the domain holder), which is also the default. One of registrant.

Example

POST /api/v2/domains/{id}/verification
curl -X POST "https://cloud.hostup.se/api/v2/domains/dom_01hxa3b4c5d6e7f8g9h0j1k2m3/verification" \
-H "Authorization: Bearer $HOSTUP_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"contactType": "registrant"
}'

Responses

201 The verification link was created.

Response 201
{
"link": "https://cloud.hostup.se/domain-verify/AbCdEf0123456789AbCdEf0123456789AbCdEf0123456789AbCdEf012345",
"path": "/domain-verify/AbCdEf0123456789AbCdEf0123456789AbCdEf0123456789AbCdEf012345",
"expiresAt": "2026-05-04T12:00:00.000Z",
"domainName": "example.se"
}
Response fields
linkstring | null
The full verification URL.
pathstring | null
The same link without the host.
expiresAtstring | null
When the link stops working, 7 days after it was created.
domainNamestring | null
The domain name.

Errors

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

400The body has an unknown field. Also returned for a domain outside .se, .nu and .test and for a domain without a personal or organisation number on file.
401Unauthorized. Authentication is required.
403Forbidden. The caller lacks a required scope or does not own the resource.
404Not found. The resource does not exist or is not owned by the caller; code is domain_not_found.
409Conflict. code is account_suspended, or a route-specific blocker with its own recovery fields.
429Rate limited. Retry after the limit resets. 429 responses include Retry-After seconds plus X-RateLimit-* headers.
500Internal error. Retry later or contact support if the issue persists.