BrandList

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/sinch/main/json-schema/sinch-brand-list-schema.json",
  "title": "BrandList",
  "x-generated": "2026-10-03",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/sinch-brands-api-openapi.yml#/components/schemas/BrandList",
  "type": "object",
  "properties": {
    "brands": {
      "type": "array",
      "description": "List of brands",
      "items": {
        "$ref": "#/$defs/Brand"
      }
    },
    "nextPageToken": {
      "type": "string",
      "description": "Pagination token"
    },
    "totalSize": {
      "type": "integer",
      "description": "Total number of brands"
    }
  },
  "$defs": {
    "Brand": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "The unique brand identifier"
        },
        "projectId": {
          "type": "string",
          "description": "The project ID"
        },
        "displayName": {
          "type": "string",
          "description": "The brand display name"
        },
        "companyName": {
          "type": "string",
          "description": "The legal company name"
        },
        "entityType": {
          "type": "string",
          "description": "The business entity type"
        },
        "ein": {
          "type": "string",
          "description": "Employer Identification Number"
        },
        "country": {
          "type": "string",
          "description": "The country of incorporation"
        },
        "street": {
          "type": "string",
          "description": "Street address"
        },
        "city": {
          "type": "string",
          "description": "City"
        },
        "state": {
          "type": "string",
          "description": "State or province"
        },
        "postalCode": {
          "type": "string",
          "description": "Postal or ZIP code"
        },
        "website": {
          "type": "string",
          "format": "uri",
          "description": "Brand website URL"
        },
        "verticalType": {
          "type": "string",
          "description": "The business vertical or industry"
        },
        "contactEmail": {
          "type": "string",
          "format": "email",
          "description": "Contact email address"
        },
        "contactPhone": {
          "type": "string",
          "description": "Contact phone number"
        },
        "status": {
          "type": "string",
          "enum": [
            "DRAFT",
            "SUBMITTED",
            "VERIFIED",
            "UNVERIFIED",
            "REJECTED"
          ],
          "description": "The current brand verification status"
        },
        "identityStatus": {
          "type": "string",
          "description": "The identity verification status"
        },
        "createTime": {
          "type": "string",
          "format": "date-time",
          "description": "When the brand was created"
        },
        "updateTime": {
          "type": "string",
          "format": "date-time",
          "description": "When the brand was last updated"
        }
      }
    }
  }
}