Skip to content

Get BankID verification status

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

Shows whether the holder of a .se, .nu or .test domain has verified their identity with BankID. Changing the holder’s personal or organisation number needs this verification. requiresBankId: true means it is not done yet. An API key cannot carry a BankID login. Create a link with POST /api/v2/domains/{id}/verification and let the holder or a signatory of the holder company open it. Other TLDs return 400.

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

Request

Path parameters

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

Example

GET /api/v2/domains/{id}/verification
curl "https://cloud.hostup.se/api/v2/domains/dom_01hxa3b4c5d6e7f8g9h0j1k2m3/verification" \
-H "Authorization: Bearer $HOSTUP_API_KEY"

Responses

200 The holder’s identity verification state.

Response 200
{
"requiresBankId": true,
"verified": false,
"method": null,
"role": null,
"companyName": null,
"reason": "BankID verification is required to edit this domain's registrant identity information."
}
Response fields
requiresBankIdboolean
True when the identity is not verified yet.
verifiedboolean
True when the identity is verified.
verificationUnavailableboolean
Present and true when the company check could not run right now.
reasonCodestring
Why the company check could not run. Present only with verificationUnavailable. One of company_lookup_unavailable, company_lookup_rate_limited.
retryAfterAtstring | null
When to try the check again. Present only with verificationUnavailable.
methodstring | null
How the identity was verified. direct: the holder’s own BankID. company: a signatory of the holder company. admin_manual: verified by support. account_delegation: through access delegated on the account. Null when not verified. One of direct, company, admin_manual, account_delegation.
rolestring | null
The signatory’s role in the company, for company. Null otherwise.
companyNamestring | null
The holder company’s name, for company. Null otherwise.
reasonstring | null
Plain-text explanation when the identity is not verified. Null when verified.

Errors

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

400Returned 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.
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.