# fyi.opensocial.checkGroupHandle

> Whether a domain is ready to be the group's handle: what its _atproto DNS record, or its /.well-known/atproto-did, names now. Changes nothing. Requires group.configure.

- Kind: query
- Authority: opensocial.fyi
- Lexicon: 1
- Published by [lexicons.opensocial.fyi](https://lexicon.garden/identity/did:plc:2gqnilpksz2e7faj3bwvo6qc), the NSID's authority

## Links

- [Documentation](https://lexicon.garden/lexicon/did:plc:2gqnilpksz2e7faj3bwvo6qc/fyi.opensocial.checkGroupHandle)
- [Schema JSON](https://lexicon.garden/lexicon/did:plc:2gqnilpksz2e7faj3bwvo6qc/fyi.opensocial.checkGroupHandle/schema.json)
- [Analytics](https://lexicon.garden/lexicon/did:plc:2gqnilpksz2e7faj3bwvo6qc/fyi.opensocial.checkGroupHandle/analytics)

## Query (`fyi.opensocial.checkGroupHandle`)

Type: query · GET

### Parameters (query string)

- `group` (string · did, required): The group DID. Every method is served by the group's host and authorized against that group's roles.
- `handle` (string, required): The domain to check, such as riders.org.

### Output (application/json)

- `did` (string · did): The DID the domain names now, if any: another one means its record is wrong.
- `handle` (string · handle, required): The domain, as the host reads it: lower case, with no @.
- `ready` (boolean, required): Whether updateGroupHandle would take it now: the domain names this group, or it is the group's own address.

### Errors

- `InvalidHandle`: No description in schema.
- `UnsupportedDomain`: No description in schema.
- `HandleNotAvailable`: No description in schema.

## Schema

```json
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "description": "Whether a domain is ready to be the group's handle: what its _atproto DNS record, or its /.well-known/atproto-did, names now. Changes nothing. Requires group.configure.",
      "errors": [
        {
          "name": "InvalidHandle"
        },
        {
          "name": "UnsupportedDomain"
        },
        {
          "name": "HandleNotAvailable"
        }
      ],
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "did": {
              "description": "The DID the domain names now, if any: another one means its record is wrong.",
              "format": "did",
              "type": "string"
            },
            "handle": {
              "description": "The domain, as the host reads it: lower case, with no @.",
              "format": "handle",
              "type": "string"
            },
            "ready": {
              "description": "Whether updateGroupHandle would take it now: the domain names this group, or it is the group's own address.",
              "type": "boolean"
            }
          },
          "required": [
            "handle",
            "ready"
          ],
          "type": "object"
        }
      },
      "parameters": {
        "properties": {
          "group": {
            "description": "The group DID. Every method is served by the group's host and authorized against that group's roles.",
            "format": "did",
            "type": "string"
          },
          "handle": {
            "description": "The domain to check, such as riders.org.",
            "type": "string"
          }
        },
        "required": [
          "group",
          "handle"
        ],
        "type": "params"
      },
      "type": "query"
    }
  },
  "id": "fyi.opensocial.checkGroupHandle",
  "lexicon": 1
}
```