# social.nstar.provider.declaration

> Published by [nstar.social](https://lexicon.garden/identity/did:web:nstar.social)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:web:nstar.social/social.nstar.provider.declaration)
- [Documentation](https://lexicon.garden/lexicon/did:web:nstar.social/social.nstar.provider.declaration/docs)
- [Examples](https://lexicon.garden/lexicon/did:web:nstar.social/social.nstar.provider.declaration/examples)

## Definitions

### `social.nstar.provider.declaration`

**Type**: `record`

A declaration of an Atmosphere service provider.

**Key**: `tid`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `did` | `string` (uri) | Yes | Provider's DID document containing 1 or more of following services: #atproto_pds, #appview_bsky, #appview_notif |
| `links` | `ref` → `#links` | Yes | URLs of the providers website and service policy documents. |
| `theme` | `ref` → `#theme` | Yes | URLs of the providers website and service policy documents. |
| `contact` | `ref` → `#contact` | Yes | Provider's contact information |
| `services` | `array` | Yes | The services offered by the provider as listed in the provider's DID document. |
| `legalName` | `string` | Yes | Provider's full legal name |
| `description` | `string` | Yes | Description of the services distinguish and are offered by provider. |
| `displayName` | `string` | Yes | Abbreviated name for displaying in limited UI space presentations (e.g. button label). |

### `social.nstar.provider.declaration#links`

**Type**: `object`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `website` | `string` (uri) | Yes | Provider's website reference. |
| `privacyPolicy` | `string` (uri) | Yes | Link reference to the provider's privacy policy. |
| `termsOfService` | `string` (uri) | Yes | Link reference to the provider's terms of service. |

### `social.nstar.provider.declaration#theme`

**Type**: `object`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `logoPNG` | `string` | No | Providers branded logo in PNG format (base64 encoded). Optional. |
| `logoSVG` | `string` | No | Providers branded template logo in SVG format. Optional. |
| `colorDark` | `string` | No | HEX color code to use in dark mode presentations. Optional. |
| `colorLight` | `string` | No | HEX color code to use in light mode presentations. Optional. |

### `social.nstar.provider.declaration#contact`

**Type**: `object`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `email` | `string` | Yes | Provider's support email address. |
| `phone` | `string` | No | Provider's support phone number. |

### `social.nstar.provider.declaration#service`

**Type**: `object`

## Raw Schema

```json
{
  "id": "social.nstar.provider.declaration",
  "defs": {
    "main": {
      "key": "tid",
      "type": "record",
      "record": {
        "type": "object",
        "required": [
          "did",
          "legalName",
          "displayName",
          "description",
          "services",
          "theme",
          "links",
          "contact"
        ],
        "properties": {
          "did": {
            "type": "string",
            "format": "uri",
            "description": "Provider's DID document containing 1 or more of following services: #atproto_pds, #appview_bsky, #appview_notif"
          },
          "links": {
            "ref": "#links",
            "type": "ref",
            "description": "URLs of the providers website and service policy documents."
          },
          "theme": {
            "ref": "#theme",
            "type": "ref",
            "description": "URLs of the providers website and service policy documents."
          },
          "contact": {
            "ref": "#contact",
            "type": "ref",
            "description": "Provider's contact information"
          },
          "services": {
            "type": "array",
            "items": {
              "type": "string",
              "knownValues": [
                "atproto_pds",
                "bsky_appview",
                "bsky_notif"
              ]
            },
            "description": "The services offered by the provider as listed in the provider's DID document."
          },
          "legalName": {
            "type": "string",
            "maxLength": 64,
            "description": "Provider's full legal name",
            "maxGraphemes": 640
          },
          "description": {
            "type": "string",
            "maxLength": 256,
            "description": "Description of the services distinguish and are offered by provider.",
            "maxGraphemes": 2560
          },
          "displayName": {
            "type": "string",
            "maxLength": 15,
            "description": "Abbreviated name for displaying in limited UI space presentations (e.g. button label).",
            "maxGraphemes": 150
          }
        }
      },
      "description": "A declaration of an Atmosphere service provider."
    },
    "links": {
      "type": "object",
      "required": [
        "website",
        "privacyPolicy",
        "termsOfService"
      ],
      "properties": {
        "website": {
          "type": "string",
          "format": "uri",
          "description": "Provider's website reference."
        },
        "privacyPolicy": {
          "type": "string",
          "format": "uri",
          "description": "Link reference to the provider's privacy policy."
        },
        "termsOfService": {
          "type": "string",
          "format": "uri",
          "description": "Link reference to the provider's terms of service."
        }
      }
    },
    "theme": {
      "type": "object",
      "properties": {
        "logoPNG": {
          "type": "string",
          "maxLength": 4096,
          "description": "Providers branded logo in PNG format (base64 encoded). Optional.",
          "maxGraphemes": 40960
        },
        "logoSVG": {
          "type": "string",
          "maxLength": 4096,
          "description": "Providers branded template logo in SVG format. Optional.",
          "maxGraphemes": 40960
        },
        "colorDark": {
          "type": "string",
          "maxLength": 7,
          "description": "HEX color code to use in dark mode presentations. Optional.",
          "maxGraphemes": 70
        },
        "colorLight": {
          "type": "string",
          "maxLength": 7,
          "description": "HEX color code to use in light mode presentations. Optional.",
          "maxGraphemes": 70
        }
      }
    },
    "contact": {
      "type": "object",
      "required": [
        "email"
      ],
      "properties": {
        "email": {
          "type": "string",
          "description": "Provider's support email address."
        },
        "phone": {
          "type": "string",
          "description": "Provider's support phone number."
        }
      }
    },
    "service": {
      "type": "object"
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1,
  "createdAt": "2026-04-19T22:58:04.496Z"
}
```