# at.marque.partner.getRequirements

> Published by [marque.at](https://lexicon.garden/identity/did:plc:nckosudltxrtrjkt4zz4jy5y)

✓ This is the authoritative definition for this NSID.

## Description

Load registry-specific registration requirements for partner checkouts.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:nckosudltxrtrjkt4zz4jy5y/at.marque.partner.getRequirements)
- [Documentation](https://lexicon.garden/lexicon/did:plc:nckosudltxrtrjkt4zz4jy5y/at.marque.partner.getRequirements/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:nckosudltxrtrjkt4zz4jy5y/at.marque.partner.getRequirements/examples)

## Definitions

### `at.marque.partner.getRequirements`

**Type**: `query`

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

#### Parameters

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `domains` | `array` | Yes |  |

#### Output

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `results` | `array` | Yes |  |

#### Errors

- **InvalidRequest**
- **RequirementsUnavailable**

### `at.marque.partner.getRequirements#spec`

**Type**: `object`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `name` | `string` | Yes |  |
| `type` | `string` | Yes |  |
| `syntax` | `string` | No |  |
| `options` | `array` | No |  |
| `pattern` | `string` | No |  |
| `required` | `boolean` | Yes |  |
| `description` | `string` | Yes |  |

### `at.marque.partner.getRequirements#option`

**Type**: `object`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `value` | `string` | Yes |  |
| `requires` | `array` | No |  |
| `description` | `string` | Yes |  |

### `at.marque.partner.getRequirements#requirement`

**Type**: `object`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `domain` | `string` | Yes |  |
| `additionalData` | `array` | Yes |  |
| `taxNumberRequired` | `boolean` | Yes |  |
| `customerAdditionalData` | `array` | Yes |  |
| `passportNumberRequired` | `boolean` | Yes |  |
| `companyRegistrationNumberRequired` | `boolean` | Yes |  |

## Raw Schema

```json
{
  "id": "at.marque.partner.getRequirements",
  "defs": {
    "main": {
      "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."
    },
    "spec": {
      "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"
        }
      }
    },
    "option": {
      "type": "object",
      "required": [
        "description",
        "value"
      ],
      "properties": {
        "value": {
          "type": "string"
        },
        "requires": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "description": {
          "type": "string"
        }
      }
    },
    "requirement": {
      "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"
        }
      }
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1,
  "description": "Load registry-specific registration requirements for partner checkouts."
}
```