Verify a domain

curl --request POST \
  --url https://biq.li/api/v1/domain/{domain}/verify \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'

import requests

url = "https://biq.li/api/v1/domain/{domain}/verify"

payload = {}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({})
};

fetch('https://biq.li/api/v1/domain/{domain}/verify', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://biq.li/api/v1/domain/{domain}/verify",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://biq.li/api/v1/domain/{domain}/verify"

	payload := strings.NewReader("{}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://biq.li/api/v1/domain/{domain}/verify")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://biq.li/api/v1/domain/{domain}/verify")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{}"

response = http.request(request)
puts response.read_body

{
  "verified": true,
  "records": {
    "dns": true,
    "txt": true
  },
  "domain": {
    "id": "<string>",
    "host": "go.example.com",
    "url": "<string>",
    "status": "pending_dns",
    "dns_status": "pending",
    "ssl_status": "pending",
    "dns_verified": true,
    "active": true,
    "is_subdomain": true,
    "links_count": 1,
    "claim_expires_at": "2023-11-07T05:31:56Z",
    "dns_last_checked_at": "2023-11-07T05:31:56Z",
    "dns_verified_at": "2023-11-07T05:31:56Z",
    "ssl_last_checked_at": "2023-11-07T05:31:56Z",
    "use_default_redirect": true,
    "default_redirect_url": "<string>",
    "use_not_found_redirect": true,
    "not_found_redirect_url": "<string>",
    "use_expired_redirect": true,
    "expired_redirect_url": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  },
  "status": "success"
}

{
  "error": {
    "code": "invalid_token",
    "message": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "code": "invalid_token",
    "message": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "code": "invalid_token",
    "message": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "code": "invalid_token",
    "message": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "code": "invalid_token",
    "message": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "code": "invalid_token",
    "message": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

POST

domain

{domain}

verify

Verify a domain

curl --request POST \
  --url https://biq.li/api/v1/domain/{domain}/verify \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'

import requests

url = "https://biq.li/api/v1/domain/{domain}/verify"

payload = {}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({})
};

fetch('https://biq.li/api/v1/domain/{domain}/verify', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://biq.li/api/v1/domain/{domain}/verify",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://biq.li/api/v1/domain/{domain}/verify"

	payload := strings.NewReader("{}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://biq.li/api/v1/domain/{domain}/verify")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://biq.li/api/v1/domain/{domain}/verify")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{}"

response = http.request(request)
puts response.read_body

{
  "verified": true,
  "records": {
    "dns": true,
    "txt": true
  },
  "domain": {
    "id": "<string>",
    "host": "go.example.com",
    "url": "<string>",
    "status": "pending_dns",
    "dns_status": "pending",
    "ssl_status": "pending",
    "dns_verified": true,
    "active": true,
    "is_subdomain": true,
    "links_count": 1,
    "claim_expires_at": "2023-11-07T05:31:56Z",
    "dns_last_checked_at": "2023-11-07T05:31:56Z",
    "dns_verified_at": "2023-11-07T05:31:56Z",
    "ssl_last_checked_at": "2023-11-07T05:31:56Z",
    "use_default_redirect": true,
    "default_redirect_url": "<string>",
    "use_not_found_redirect": true,
    "not_found_redirect_url": "<string>",
    "use_expired_redirect": true,
    "expired_redirect_url": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  },
  "status": "success"
}

{
  "error": {
    "code": "invalid_token",
    "message": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "code": "invalid_token",
    "message": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "code": "invalid_token",
    "message": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "code": "invalid_token",
    "message": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "code": "invalid_token",
    "message": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "code": "invalid_token",
    "message": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

Check the routing and TXT ownership records for one domain. Requires Custom domains: Write (custom_domains.update). Send an empty JSON object or no body; no fields are accepted.

curl --request POST \
  --url https://biq.li/api/v1/domain/biq_dom_01M18D4A8QRJY5G6K3N2W7X9TZ/verify \
  --header 'Authorization: Bearer biqli_your_workspace_api_key' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{}'

Successful verification

When both records match, Biqli marks DNS verified and queues SSL provisioning:

{
  "verified": true,
  "records": {"dns": true, "txt": true},
  "domain": {
    "id": "biq_dom_01M18D4A8QRJY5G6K3N2W7X9TZ",
    "host": "go.example.com",
    "status": "provisioning_ssl",
    "dns_status": "verified",
    "ssl_status": "processing",
    "dns_verified": true,
    "active": false
  },
  "status": "success"
}

The actual domain object is complete; it is abbreviated above. DNS verification does not mean HTTPS is ready. Retrieve the domain until status and ssl_status are both active before publishing links that depend on it.

DNS not ready

If either record is missing or has not propagated, the endpoint returns 422 dns_verification_failed:

{
  "error": {
    "code": "dns_verification_failed",
    "message": "The required DNS records were not found or have not propagated yet.",
    "details": {
      "verified": false,
      "records": {"dns": true, "txt": false},
      "dns_config": {
        "host": "go.example.com",
        "is_subdomain": true,
        "records": [
          {"type":"CNAME","name":"go","value":"biq.li","ttl":"auto"},
          {"type":"TXT","name":"_verify.example.com","value":"domain-verify=...","ttl":"auto"}
        ]
      }
    }
  },
  "request_id": "ae437f49-30a3-4d55-bca6-dc523f2efcb3"
}

The two booleans identify which requirement is missing without exposing other DNS records found during lookup. DNS propagation can take time; correct the records, wait, and retry. Verification is idempotent, and repeated successful checks do not queue duplicate active SSL operations.

Shared API behavior

Authentication is workspace-scoped; see Authentication. Errors use the standard envelope and request IDs described in Errors, and requests are subject to Rate limits.

Authorizations

Authorization

string

header

required

A workspace API key beginning with biqli_.

Path Parameters

domain

string

required

Public custom-domain ID. Numeric IDs and hosts are not accepted.

Pattern: ^biq_dom_[0-9A-HJKMNP-TV-Z]{26}$

Body

application/json

The body is of type object.

Response

DNS was verified and SSL is active or provisioning.

verified

boolean

required

records

object

required

Show child attributes

domain

object

required

Show child attributes

status

string

required

Allowed value: "success"

GETTING STARTED

BIQLI LINKS API

Verify a domain

Successful verification

DNS not ready

Shared API behavior

Authorizations

Path Parameters

Body

Response

​Successful verification

​DNS not ready

​Shared API behavior

Authorizations

Path Parameters

Body

Response

Successful verification

DNS not ready

Shared API behavior