> ## 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.

# Obter configuração de recebimento

> Retorna o estado de recebimento e o bucket de anexos selecionado. Os registros DNS são retornados na identidade. O conteúdo é retido por 30 dias, sem configuração de retenção. Cotas da organização controlam o tráfego e o tamanho das mensagens.

<Info>
  Exige a ação IAM **`email:GetReceivingConfiguration`**. 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 get /v1/identities/{identity_id}/receiving
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}/receiving:
    get:
      tags:
        - Email
      summary: Obter configuração de recebimento
      description: >-
        Retorna o estado de recebimento e o bucket de anexos selecionado. Os
        registros DNS são retornados na identidade. O conteúdo é retido por 30
        dias, sem configuração de retenção. Cotas da organização controlam o
        tráfego e o tamanho das mensagens.
      operationId: getReceivingConfiguration
      parameters:
        - name: identity_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: Sucesso
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReceivingConfigurationResponse'
        '400':
          description: Solicitação inválida.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          description: O solicitante não tem permissão.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Recurso não encontrado nesta conta.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '409':
          description: Estado conflitante.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '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:
  schemas:
    ReceivingConfigurationResponse:
      type: object
      required:
        - receiving
      properties:
        receiving:
          $ref: '#/components/schemas/ReceivingConfiguration'
    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
    ReceivingConfiguration:
      type: object
      required:
        - enabled
        - attachments_bucket
      properties:
        enabled:
          type: boolean
        attachments_bucket:
          allOf:
            - $ref: '#/components/schemas/ResourceRef'
          nullable: true
          type: object
    ResourceRef:
      type: object
      required:
        - id
        - crn
      properties:
        id:
          type: string
          format: uuid
          example: 288aa1e9-bbf5-5584-bce9-6a688f06d8a1
        crn:
          type: string
          example: crn:catalog::platform:country/288aa1e9-bbf5-5584-bce9-6a688f06d8a1
        name:
          type: string
          description: >-
            Rótulo no momento da resposta: o nome do recurso, quando houver, ou
            seu rótulo legível (número de fatura, nome de exibição da conta).
            Ausente quando o destino não existe mais. Não é uma chave de
            consulta.
          example: Brazil
  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
  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.