> ## Documentation Index
> Fetch the complete documentation index at: https://docs.notifique.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Verificar domínio de e-mail

> Confere se o DNS está correto para liberar o domínio para envio.



## OpenAPI

````yaml /emails-api/api-reference/openapi-email.json post /v1/email/domains/{id}/verify
openapi: 3.0.3
info:
  title: Notifique API. E-mail
  description: >-
    Envie e-mails, gerencie domínios e consulte status. Autentique com
    `Authorization: Bearer sk_live_...` ou `x-api-key`.
  version: 1.0.0
servers:
  - url: https://api.notifique.dev
    description: Produção
security:
  - ntfEmailBearerAuth: []
  - ntfEmailApiKeyHeader: []
tags:
  - name: E-mail
    description: Envio e consulta de e-mail
  - name: Domínios
    description: Registro e verificação de domínios para envio de e-mail
paths:
  /v1/email/domains/{id}/verify:
    post:
      tags:
        - Domínios
        - E-mail
      summary: Verificar domínio de e-mail
      description: Confere se o DNS está correto para liberar o domínio para envio.
      operationId: ntfEmail_postV1EmailDomainVerify
      parameters:
        - name: id
          in: path
          required: true
          description: ID (cuid) do domínio a verificar.
          schema:
            type: string
      responses:
        '200':
          description: >-
            Resultado da verificação. verified: true quando o domínio passou na
            checagem DNS.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NtfEmail_VerifyEmailDomainResponse'
              examples:
                verified:
                  summary: Domínio verificado
                  value:
                    success: true
                    verified: true
                    code: EMAIL_DOMAIN_VERIFIED
                    message: >-
                      Domínio verificado. Você já pode enviar e-mails por este
                      domínio.
                    data:
                      id: clxx123...
                      domain: seudominio.com
                      status: VERIFIED
                      dnsRecords: []
                      verifiedAt: '2025-02-16T12:00:00.000Z'
                dnsPending:
                  summary: DNS ainda pendente
                  value:
                    success: true
                    verified: false
                    code: EMAIL_DOMAIN_DNS_PENDING
                    message: >-
                      Os registros DNS ainda não foram verificados. Confira no
                      seu provedor DNS e tente novamente em alguns minutos.
                    data:
                      id: clxx123...
                      domain: seudominio.com
                      status: PENDING
                      dnsRecords: []
        '401':
          description: API Key ausente ou inválida.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NtfEmail_ErrorResponse'
        '403':
          description: Escopo email:domains:list e email:domains:create ausentes.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NtfEmail_ErrorResponse'
        '404':
          description: Domínio não encontrado.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NtfEmail_ErrorResponse'
              example:
                success: false
                error: Not Found
                message: >-
                  Domínio de e-mail não encontrado ou não pertence a este
                  workspace
                code: EMAIL_DOMAIN_NOT_FOUND
        '502':
          description: Falha ao consultar status no provedor.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NtfEmail_ErrorResponse'
        '503':
          description: Serviço de e-mail não configurado.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NtfEmail_ErrorResponse'
components:
  schemas:
    NtfEmail_VerifyEmailDomainResponse:
      type: object
      required:
        - success
        - code
        - message
        - verified
      properties:
        success:
          type: boolean
          example: true
        data:
          $ref: '#/components/schemas/NtfEmail_EmailDomainItem'
        verified:
          type: boolean
          description: true quando o domínio passou na verificação DNS.
        code:
          type: string
          description: >-
            EMAIL_DOMAIN_VERIFIED, EMAIL_DOMAIN_DNS_PENDING ou
            EMAIL_DOMAIN_VERIFY_FAILED.
        message:
          type: string
          description: Mensagem legível (localizada).
    NtfEmail_ErrorResponse:
      type: object
      properties:
        success:
          type: boolean
          example: false
        error:
          type: string
          description: 'Rótulo HTTP do erro (ex.: Unauthorized, Bad Request, Not Found).'
        message:
          type: string
          description: >-
            Mensagem legível para exibir ao usuário (localizada via
            Accept-Language / x-locale quando aplicável).
        code:
          type: string
          description: >-
            Código estável da API v1 (enum). Sempre presente em erros. Use com o
            status HTTP para decidir retry ou correção. Ver [Respostas de
            erro](/guides/conceitos/resposta-de-erros).
        details:
          type: array
          items:
            type: object
            properties:
              field:
                type: string
              message:
                type: string
        data:
          type: object
          description: 'Dados adicionais em alguns erros (ex.: status do e-mail em cancel).'
      required:
        - success
        - error
        - message
        - code
    NtfEmail_EmailDomainItem:
      type: object
      description: Item de domínio de e-mail (listagem ou detalhe).
      properties:
        id:
          type: string
          description: ID (cuid) do domínio.
        domain:
          type: string
          description: 'Domínio (ex.: seudominio.com).'
        status:
          type: string
          enum:
            - PENDING
            - VERIFIED
            - FAILED
          description: >-
            PENDING = aguardando DNS; VERIFIED = verificado; FAILED =
            verificação falhou.
        dnsRecords:
          type: array
          items:
            type: object
            properties:
              type:
                type: string
                description: 'Tipo do registro (ex.: TXT, CNAME).'
              name:
                type: string
                description: Nome do registro.
              value:
                type: string
                description: Valor do registro.
          description: >-
            Registros DNS a serem configurados no domínio (quando status
            PENDING).
        verifiedAt:
          type: string
          format: date-time
          nullable: true
          description: Data/hora da verificação (quando VERIFIED).
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
          description: Presente apenas em GET por ID.
  securitySchemes:
    ntfEmailBearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: >-
        API Key no header Authorization. Exemplo: `Authorization: Bearer
        sk_live_xxxxx`
    ntfEmailApiKeyHeader:
      type: apiKey
      in: header
      name: x-api-key
      description: 'API Key no header x-api-key. Exemplo: `x-api-key: sk_live_xxxxx`'

````