at.marque.partner.getRequirements

marque.at

Documentation

Return required registrant and registry fields for up to 50 domains before createCheckout.

main query

Return required registrant and registry fields for up to 50 domains before createCheckout.

Parameters

domains array of string Required

No description available.

Output

Encodingapplication/json
results array Required

No description available.

Errors

InvalidRequest
RequirementsUnavailable
Try It

Requests are sent directly from your browser. Some servers may block requests due to CORS.

Base URL for XRPC calls (e.g., https://api.bsky.social)
Parameters
View raw schema 
{
  "type": "query",
  "errors": [
    {
      "name": "InvalidRequest"
    },
    {
      "name": "RequirementsUnavailable"
    }
  ],
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "results"
      ],
      "properties": {
        "results": {
          "type": "array",
          "items": {
            "ref": "#requirement",
            "type": "ref"
          }
        }
      }
    },
    "encoding": "application/json"
  },
  "parameters": {
    "type": "params",
    "required": [
      "domains"
    ],
    "properties": {
      "domains": {
        "type": "array",
        "items": {
          "type": "string",
          "maxLength": 253
        },
        "maxLength": 50,
        "minLength": 1
      }
    }
  },
  "description": "Return required registrant and registry fields for up to 50 domains before createCheckout."
}
option object

No description available.

Properties

description string Required

No description available.

requires array of string Optional

No description available.

value string Required

No description available.

View raw schema 
{
  "type": "object",
  "required": [
    "description",
    "value"
  ],
  "properties": {
    "value": {
      "type": "string"
    },
    "requires": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "description": {
      "type": "string"
    }
  }
}
requirement object

No description available.

Properties

additionalData array of ref#spec Required

No description available.

companyRegistrationNumberRequired boolean Required

No description available.

customerAdditionalData array of ref#spec Required

No description available.

domain string Required

No description available.

maxLength: 253 bytes
passportNumberRequired boolean Required

No description available.

taxNumberRequired boolean Required

No description available.

View raw schema 
{
  "type": "object",
  "required": [
    "domain",
    "passportNumberRequired",
    "companyRegistrationNumberRequired",
    "taxNumberRequired",
    "additionalData",
    "customerAdditionalData"
  ],
  "properties": {
    "domain": {
      "type": "string",
      "maxLength": 253
    },
    "additionalData": {
      "type": "array",
      "items": {
        "ref": "#spec",
        "type": "ref"
      }
    },
    "taxNumberRequired": {
      "type": "boolean"
    },
    "customerAdditionalData": {
      "type": "array",
      "items": {
        "ref": "#spec",
        "type": "ref"
      }
    },
    "passportNumberRequired": {
      "type": "boolean"
    },
    "companyRegistrationNumberRequired": {
      "type": "boolean"
    }
  }
}
spec object

No description available.

Properties

description string Required

No description available.

name string Required

No description available.

options array of ref#option Optional

No description available.

pattern string Optional

No description available.

required boolean Required

No description available.

syntax string Optional

No description available.

type string Required

No description available.

View raw schema 
{
  "type": "object",
  "required": [
    "name",
    "description",
    "required",
    "type"
  ],
  "properties": {
    "name": {
      "type": "string"
    },
    "type": {
      "type": "string"
    },
    "syntax": {
      "type": "string"
    },
    "options": {
      "type": "array",
      "items": {
        "ref": "#option",
        "type": "ref"
      }
    },
    "pattern": {
      "type": "string"
    },
    "required": {
      "type": "boolean"
    },
    "description": {
      "type": "string"
    }
  }
}

Lexicon Garden

@