# place.wisp.v2.domain.verify

> Published by [wisp.place](https://lexicon.garden/identity/did:plc:7puq73yz2hkvbcpdhnsze2qw)

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:7puq73yz2hkvbcpdhnsze2qw/place.wisp.v2.domain.verify)
- [Documentation](https://lexicon.garden/lexicon/did:plc:7puq73yz2hkvbcpdhnsze2qw/place.wisp.v2.domain.verify/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:7puq73yz2hkvbcpdhnsze2qw/place.wisp.v2.domain.verify/examples)

## Definitions

### `place.wisp.v2.domain.verify`

**Type**: `procedure`

Run DNS verification for a custom domain owned by the authenticated DID and update its verified status.

#### Input

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `domain` | `string` | Yes | Custom domain FQDN to verify (for example, example.com). |

#### Output

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `kind` | `string` | Yes |  |
| `error` | `string` | No | Human-readable reason verification did not pass (when not verified). |
| `domain` | `string` | Yes |  |
| `status` | `string` | Yes |  |
| `warning` | `string` | No | Non-fatal advisory (for example, CNAME could not be confirmed due to flattening). |
| `txtFound` | `string` | No | The TXT value observed during verification, if any. |
| `verified` | `boolean` | Yes |  |
| `cnameFound` | `string` | No | The CNAME target observed during verification, if any. |

#### Errors

- **AuthenticationRequired**
- **InvalidDomain**
- **NotFound**

## Raw Schema

```json
{
  "id": "place.wisp.v2.domain.verify",
  "defs": {
    "main": {
      "type": "procedure",
      "input": {
        "schema": {
          "type": "object",
          "required": [
            "domain"
          ],
          "properties": {
            "domain": {
              "type": "string",
              "maxLength": 253,
              "minLength": 3,
              "description": "Custom domain FQDN to verify (for example, example.com)."
            }
          }
        },
        "encoding": "application/json"
      },
      "errors": [
        {
          "name": "AuthenticationRequired"
        },
        {
          "name": "InvalidDomain"
        },
        {
          "name": "NotFound"
        }
      ],
      "output": {
        "schema": {
          "type": "object",
          "required": [
            "domain",
            "kind",
            "status",
            "verified"
          ],
          "properties": {
            "kind": {
              "enum": [
                "custom"
              ],
              "type": "string"
            },
            "error": {
              "type": "string",
              "description": "Human-readable reason verification did not pass (when not verified)."
            },
            "domain": {
              "type": "string"
            },
            "status": {
              "enum": [
                "pendingVerification",
                "verified"
              ],
              "type": "string"
            },
            "warning": {
              "type": "string",
              "description": "Non-fatal advisory (for example, CNAME could not be confirmed due to flattening)."
            },
            "txtFound": {
              "type": "string",
              "description": "The TXT value observed during verification, if any."
            },
            "verified": {
              "type": "boolean"
            },
            "cnameFound": {
              "type": "string",
              "description": "The CNAME target observed during verification, if any."
            }
          }
        },
        "encoding": "application/json"
      },
      "description": "Run DNS verification for a custom domain owned by the authenticated DID and update its verified status."
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1
}
```
