# town.delve.ageassurance.begin

> Published by [delve.town](https://lexicon.garden/identity/did:plc:qzqct2rrq4u2gmy5g3mjxske)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:qzqct2rrq4u2gmy5g3mjxske/town.delve.ageassurance.begin)
- [Documentation](https://lexicon.garden/lexicon/did:plc:qzqct2rrq4u2gmy5g3mjxske/town.delve.ageassurance.begin/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:qzqct2rrq4u2gmy5g3mjxske/town.delve.ageassurance.begin/examples)

## Definitions

### `town.delve.ageassurance.begin`

**Type**: `procedure`

Initiate Age Assurance for an account.

#### Input

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `countryCode` | `string` | Yes | An ISO 3166-1 alpha-2 code of the user's location. |
| `email` | `string` | Yes | The user's email address to receive Age Assurance instructions. |
| `language` | `string` | Yes | The user's preferred language for communication during the Age Assurance process. |
| `regionCode` | `string` | No | An optional ISO 3166-2 code of the user's region or state within the country. |

#### Output

**Encoding**: `application/json`

#### Errors

- **InvalidEmail**
- **DidTooLong**
- **InvalidInitiation**
- **RegionNotSupported**

## Raw Schema

```json
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "description": "Initiate Age Assurance for an account.",
      "errors": [
        {
          "name": "InvalidEmail"
        },
        {
          "name": "DidTooLong"
        },
        {
          "name": "InvalidInitiation"
        },
        {
          "name": "RegionNotSupported"
        }
      ],
      "input": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "countryCode": {
              "description": "An ISO 3166-1 alpha-2 code of the user's location.",
              "type": "string"
            },
            "email": {
              "description": "The user's email address to receive Age Assurance instructions.",
              "type": "string"
            },
            "language": {
              "description": "The user's preferred language for communication during the Age Assurance process.",
              "type": "string"
            },
            "regionCode": {
              "description": "An optional ISO 3166-2 code of the user's region or state within the country.",
              "type": "string"
            }
          },
          "required": [
            "email",
            "language",
            "countryCode"
          ],
          "type": "object"
        }
      },
      "output": {
        "encoding": "application/json",
        "schema": {
          "ref": "town.delve.ageassurance.defs#state",
          "type": "ref"
        }
      },
      "type": "procedure"
    }
  },
  "id": "town.delve.ageassurance.begin",
  "lexicon": 1
}
```