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

# Iniciar verificação DNS

<Info>
  Exige a ação IAM **`email:VerifyIdentity`**. Veja [permissões de Email](/pt/email/permissions) for the full list, what each one covers, and an example policy.
</Info>


## OpenAPI

````yaml /pt/api-reference/specs/email.yaml post /v1/identities/{identity_id}/verify
openapi: 3.0.3
info:
  title: API Basaltic Email
  version: 1.0.0
  description: >
    API regional para enviar e receber emails, gerenciar identidades e registros
    DNS, templates, conjuntos de configurações, pools de IPs, regras de
    destinatário, conteúdo e anexos.


    As identidades devem ser verificadas em cada região. Crie uma identidade,
    publique seus dns_records e solicite a verificação. Apenas identidades
    verificadas podem enviar ou ativar o recebimento.


    Referências aceitam UUID, nome exclusivo na conta ou CRN do tipo esperado.
    Nomes são imutáveis. Referências malformadas ou de tipo/região incorretos
    retornam 400; inexistentes ou de outra conta retornam 404. Caminhos de
    recursos usam UUIDs. Filtros são exatos, limitados à conta e aplicados antes
    da paginação; referências inexistentes ou de outro escopo retornam
    resultados vazios.


    O conteúdo enviado e recebido expira após 30 dias. Os objetos dos anexos
    seguem o ciclo de vida do bucket independentemente. Use Telemetry para
    métricas agregadas e os endpoints de diagnóstico para eventos e registros
    DMARC.
  contact:
    name: Basaltic Support
    email: ping@basaltic.sh
  license:
    name: Proprietary
    url: https://basaltic.sh/terms
servers:
  - url: https://email.{region}.basaltic.sh
    description: Endpoint de API regional
    variables:
      region:
        default: sa-saopaulo-1
        description: Código de região
security:
  - BearerAuth: []
tags:
  - name: Email
    description: Envio de emails para clientes (regional).
paths:
  /v1/identities/{identity_id}/verify:
    parameters:
      - $ref: '#/components/parameters/IdentityId'
    post:
      tags:
        - Email
      summary: Iniciar verificação DNS
      operationId: verifyIdentity
      parameters:
        - $ref: '#/components/parameters/IdempotencyKey'
      responses:
        '200':
          description: Identidade verificada.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IdentityResponse'
        '400':
          description: Registros não encontrados ou incompatíveis.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          description: Identidade não encontrada.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '409':
          $ref: '#/components/responses/Conflict'
        '422':
          $ref: '#/components/responses/UnprocessableEntity'
        '429':
          description: Cota ou limite de taxa excedido.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Erro interno.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '503':
          description: Dependência indisponível.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  parameters:
    IdentityId:
      name: identity_id
      in: path
      required: true
      schema:
        type: string
        format: uuid
    IdempotencyKey:
      name: Idempotency-Key
      in: header
      description: >-
        Chave opcional gerada pelo cliente que torna uma criação segura para
        reprodução. A reintentar uma solicitação com a mesma chave retorna o
        resultado original literalmente em vez de criar um recurso duplicado. A
        reutilização de uma chave com um corpo de solicitação diferente é
        rejeitada (422); uma solicitação cuja chave ainda está sendo processada
        retorna 409. Os registros são honrados por 24 horas. Use um UUID ou
        token exclusivo semelhante.
      required: false
      schema:
        type: string
        maxLength: 255
      example: 550e8400-e29b-41d4-a716-446655440000
  schemas:
    IdentityResponse:
      type: object
      required:
        - identity
      properties:
        identity:
          $ref: '#/components/schemas/Identity'
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
            - request_id
          properties:
            code:
              type: string
              description: Código de erro identificando o tipo de erro
              example: INVALID_INPUT
            message:
              type: string
              description: Mensagem de erro legível pelo ser humano
              example: Invalid request parameters
            params:
              type: object
              additionalProperties: true
              description: >-
                Valores não sensíveis opcionais para interpolação de erros
                localizados, codificados por código de erro. Nunca presente para
                erros de servidor.
              example:
                instances: 2
                pools: 0
            request_id:
              type: string
              format: uuid
              description: Solicitar ID para depuração
              example: 550e8400-e29b-41d4-a716-446655440000
    Identity:
      type: object
      required:
        - id
        - crn
        - name
        - type
        - status
        - dkim_selector
        - created_at
        - updated_at
      properties:
        id:
          type: string
          format: uuid
        crn:
          type: string
        name:
          type: string
          description: >-
            Domínio do remetente. Nomes não podem começar com crn: nem ser UUIDs
            (canônicos, compactos, entre chaves ou urn:uuid:, em qualquer
            capitalização).
        type:
          type: string
          enum:
            - domain
        status:
          type: string
          enum:
            - pending
            - verified
            - failed
            - suspended
        dkim_selector:
          type: string
        dkim_pending_selector:
          type: string
        dkim_selector_old:
          type: string
        dkim_old_expires_at:
          type: string
          format: date-time
          nullable: true
        mail_from_domain:
          type: string
        mail_from_status:
          type: string
          enum:
            - pending
            - verified
            - failed
        mail_from_verified_at:
          type: string
          format: date-time
          nullable: true
        bimi_logo_url:
          type: string
        bimi_vmc_url:
          type: string
        bimi_status:
          type: string
          enum:
            - pending
            - verified
            - failed
        bimi_verified_at:
          type: string
          format: date-time
          nullable: true
        verified_at:
          type: string
          format: date-time
          nullable: true
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
        suspended_reason:
          type: string
        suspended_at:
          type: string
          format: date-time
          nullable: true
        tags:
          $ref: '#/components/schemas/Tags'
        dns_records:
          type: array
          items:
            $ref: '#/components/schemas/DNSRecord'
    Tags:
      type: object
      additionalProperties:
        type: string
      example:
        environment: production
        team: backend
    DNSRecord:
      type: object
      required:
        - purpose
        - type
        - name
        - value
        - required
        - group
      properties:
        purpose:
          type: string
          enum:
            - ownership
            - dkim
            - dkim_cname
            - dkim_pending
            - dkim_pending_cname
            - dkim_rotated_out
            - spf
            - dmarc
            - return_path
            - mail_from_mx
            - mail_from_spf
            - bimi
            - receiving_mx
        type:
          type: string
          enum:
            - TXT
            - CNAME
            - MX
        name:
          type: string
          description: FQDN no qual publicar o registro.
        value:
          type: string
          description: >-
            Dados completos para copiar: conteúdo TXT sem aspas, destino CNAME
            ou prioridade MX seguida do host.
        required:
          type: boolean
          description: >-
            Obrigatório para esta função de envio/recebimento. Em um
            alternative_group, uma alternativa atende ao requisito.
        group:
          type: string
          enum:
            - sending
            - receiving
        alternative_group:
          type: string
          description: >-
            Registros com este valor são alternativas. Publique exatamente um
            registro de um grupo de alternativas obrigatório; TXT e CNAME não
            podem coexistir no mesmo nome.
  responses:
    Unauthorized:
      description: Autenticação necessária ou token inválido
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: UNAUTHORIZED
              message: Authentication required
              request_id: 550e8400-e29b-41d4-a716-446655440000
    Forbidden:
      description: Permissões insuficientes
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: ACCESS_DENIED
              message: You don't have permission to perform this action
              request_id: 550e8400-e29b-41d4-a716-446655440000
    Conflict:
      description: Conflito de recursos (por exemplo, já existe, estado inválido)
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: CONFLICT
              message: Resource with this name already exists
              request_id: 550e8400-e29b-41d4-a716-446655440000
    UnprocessableEntity:
      description: >
        A solicitação está bem formada, mas não pode ser processada conforme
        enviada. Nas operações que aceitam `Idempotency-Key` este é o caso de
        reutilização de chave: a chave foi vista pela primeira vez com uma carga
        de solicitação diferente, então reproduzir o resultado armazenado
        responderia a uma pergunta que o chamador não fez.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: IDEMPOTENCY_KEY_REUSED
              message: >-
                This Idempotency-Key was already used with a different request
                payload
              request_id: 550e8400-e29b-41d4-a716-446655440000
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >+
        Um token bearer OAuth 2.0, enviado como `Authorization: Bearer <token>`.
        Esta é a forma recomendada de autenticação.


        Obtenha o token trocando o par de chaves de acesso de uma conta de
        serviço em `POST /v1/oauth/token` com `grant_type=client_credentials`.
        Esse é o fluxo padrão de credenciais de cliente; bibliotecas compatíveis
        com OAuth podem obter e renovar o token para você.


        ```

        curl -s -u "$KEY_ID:$SECRET" -d grant_type=client_credentials \
          https://iam.basaltic.sh/v1/oauth/token
        ```


        Os tokens duram uma hora por padrão. O mesmo par de chaves de acesso
        também serve como credencial AWS SigV4 para o endpoint de objetos
        compatível com S3, que aceita somente esse método de autenticação.


````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.