Get domain registrant — Brigg developers

Access & visibility

Allow domains.GetDomainRegistrant on your API key.

Acting member required. Send Brigg-Act-As with an approved member account ID. The key supplies permissions; the member selects whose data is used.

The selected member must be active and approved by the credential. This selects whose private data is used; the credential supplies permissions. Private ownership and project boundaries still apply.

Set up authentication · Choose permissions

Request

No parameters. Send an empty JSON object ({}).

Response

Returns 200 OK with a JSON body.

registrantDomainRegistrantRequired

Company and contact details used for domain registration.

DomainRegistrant

organizationstringRequired

Legal organization registering the domain.

org_numberstringRequired

Organisation number from the company register, stored as text to preserve leading zeros.

namestringRequired

Display name.

address_linestringRequired

Street address of the domain registrant.

postal_codestringRequired

Postal code as text, preserving leading zeros.

citystringRequired

Postal town or city.

countrystringRequired

Country associated with the address or record.

emailstringRequired

Email address.

phonestringRequired

Phone number including its country calling code.

savedbooleanRequired

Whether the registrant details were saved.

completebooleanOptional

Whether the saved registrant details are complete enough for confirmation.

Errors & retries

This operation reads data. It needs no idempotency key and can be retried after a transient failure.

For rate limits, follow the server’s retry guidance and back off. See HTTP errors and safe retries and limits.

HTTP status	Code	What to do
400	`invalid_json`	Send a JSON object with Content-Type: application/json.
400	`invalid_input`	Check the request fields and types.
401	`invalid_key`	The workspace API key is missing, invalid or revoked.
403	`forbidden`	Check the key’s operation and resource grants. Supply Brigg-Act-As with a member authorized by the key’s delegation grant. The selected member must be active and approved by the credential. This selects whose private data is used; the credential supplies permissions. Private ownership and project boundaries still apply.
404	`not_found`	The requested operation or resource is not available to this credential.
429	`rate_limited`	Wait for Retry-After before retrying.

Next steps

Download OpenAPI · Versioning & retirement

JSON schemas

Use the complete schemas for validation or client generation.

Full request JSON schema

{
  "type": "object",
  "properties": {},
  "additionalProperties": false,
  "examples": [
    {}
  ]
}

Full response JSON schema

{
  "type": "object",
  "properties": {
    "registrant": {
      "description": "Company and contact details used for domain registration.",
      "title": "DomainRegistrant",
      "type": "object",
      "properties": {
        "organization": {
          "type": "string",
          "description": "Legal organization registering the domain."
        },
        "org_number": {
          "type": "string",
          "description": "Organisation number from the company register, stored as text to preserve leading zeros."
        },
        "name": {
          "type": "string",
          "description": "Display name."
        },
        "address_line": {
          "type": "string",
          "description": "Street address of the domain registrant."
        },
        "postal_code": {
          "type": "string",
          "description": "Postal code as text, preserving leading zeros."
        },
        "city": {
          "type": "string",
          "description": "Postal town or city."
        },
        "country": {
          "type": "string",
          "description": "Country associated with the address or record."
        },
        "email": {
          "type": "string",
          "description": "Email address."
        },
        "phone": {
          "type": "string",
          "description": "Phone number including its country calling code."
        }
      },
      "required": [
        "organization",
        "org_number",
        "name",
        "address_line",
        "postal_code",
        "city",
        "country",
        "email",
        "phone"
      ],
      "additionalProperties": false
    },
    "saved": {
      "type": "boolean",
      "description": "Whether the registrant details were saved."
    },
    "complete": {
      "type": "boolean",
      "description": "Whether the saved registrant details are complete enough for confirmation."
    }
  },
  "required": [
    "registrant",
    "saved"
  ],
  "additionalProperties": false,
  "examples": [
    {
      "registrant": {
        "organization": "Northstar Consulting AS",
        "org_number": "999999999",
        "name": "Alex Morgan",
        "address_line": "Example street 10",
        "postal_code": "0150",
        "city": "Oslo",
        "country": "NO",
        "email": "alex@example.com",
        "phone": "+4799999999"
      },
      "saved": true
    }
  ]
}

Try the request

Use your API key in a server environment.

Requires BRIGG_ACT_AS: an approved member account ID.

Fictional values. Replace IDs and business details with values from your workspace.

Request

cURL

curl 'https://api.brigg.app/v1/operations/domains.GetDomainRegistrant' \
  -H "Authorization: Bearer $BRIGG_API_KEY" \
  -H 'Content-Type: application/json' \
  -H "Brigg-Act-As: $BRIGG_ACT_AS" \
  --data-raw '{}'

TypeScript

const actAs = process.env.BRIGG_ACT_AS;
if (!actAs) throw new Error("Set BRIGG_ACT_AS to an approved member account ID.");

const response = await fetch("https://api.brigg.app/v1/operations/domains.GetDomainRegistrant", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.BRIGG_API_KEY}`,
    "Content-Type": "application/json",
    "Brigg-Act-As": actAs,
  },
  body: JSON.stringify({}),
});
const result = await response.json();
if (!response.ok) throw new Error(`${response.status}: ${result.error} — ${result.message}`);
console.log(result);

Python

import json
import os
from urllib.request import Request, urlopen
from urllib.error import HTTPError

payload = {}
request = Request(
    "https://api.brigg.app/v1/operations/domains.GetDomainRegistrant",
    data=json.dumps(payload).encode("utf-8"),
    headers={
        "Authorization": f"Bearer {os.environ['BRIGG_API_KEY']}",
        "Content-Type": "application/json",
        "Brigg-Act-As": os.environ["BRIGG_ACT_AS"],
    },
    method="POST",
)
try:
    with urlopen(request) as response:
        print(json.load(response))
except HTTPError as error:
    print(error.code, json.load(error))
    raise

200 OK Response example

{
  "registrant": {
    "organization": "Northstar Consulting AS",
    "org_number": "999999999",
    "name": "Alex Morgan",
    "address_line": "Example street 10",
    "postal_code": "0150",
    "city": "Oslo",
    "country": "NO",
    "email": "alex@example.com",
    "phone": "+4799999999"
  },
  "saved": true
}

Illustrative values, not a live response.