---
title: "Partner"
url: "https://devcenter.stone.com.br/apis/stone-catalog/versions/502db258-cb08-4b38-8af1-b96a688b9a9e/schemas/Partner"
---

> Full API specification: https://devcenter.stone.com.br/apis/stone-catalog/versions/502db258-cb08-4b38-8af1-b96a688b9a9e.md

# Partner

## OpenAPI definition

```yaml
openapi: 3.0.3
info:
  title: Stone Catalog API
  version: 1.0.0
servers:
  - url: https://sdx.api.stone.com.br/v1/catalog
    description: Ambiente de Desenvolvimento (SDX)
  - url: https://api.stone.com.br/v1/catalog
    description: Ambiente de Produção (PRD)
components:
  schemas:
    Partner:
      type: object
      required:
        - id
        - companyName
        - document
        - email
        - isActive
        - createdAt
        - updatedAt
      properties:
        id:
          type: string
          format: uuid
          description: Identificador único do parceiro
          example: 550e8400-e29b-41d4-a716-446655440000
        companyName:
          type: string
          description: Nome da empresa parceira
          example: Acme Corp
        document:
          type: string
          pattern: ^(\d{11}|\d{14}|[A-Za-z0-9]{12}\d{2})$
          description: "Documento do parceiro: CPF numérico, CNPJ numérico legado ou CNPJ
            alfanumérico. Em caso de erro de validação, o retorno inclui detalhe
            específico por motivo."
          example: 12ABC34501DE35
        email:
          type: string
          format: email
          description: Email do parceiro
          example: contato@acmecorp.com
        consoleId:
          type: string
          nullable: true
          description: ID do console
          example: console-123
        isActive:
          type: boolean
          description: Indica se o parceiro está ativo
          example: true
        createdAt:
          type: string
          format: date-time
          description: Data de criação
          example: 2024-01-15T10:30:00Z
        updatedAt:
          type: string
          format: date-time
          description: Data de última atualização
          example: 2024-01-15T10:30:00Z
```