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

# Obter eSIM da linha

> Consulta os dados de ativação do eSIM de uma linha móvel ou global da empresa pelo ID. Enquanto o eSIM ainda está sendo preparado, `status` retorna "provisioning" e os demais campos ficam nulos — repita a consulta em instantes. Quando o código está pronto, `status` é "ready" e os campos de ativação são preenchidos. Se o eSIM já foi instalado em um aparelho, `status` é "installed". Retorna 422 para linhas que não utilizam eSIM, como linhas com chip físico ou linhas de número virtual.



## OpenAPI

````yaml api-reference/v3/openapi.json GET /api/v3/phone-accounts/{id}/esim
openapi: 3.1.0
info:
  version: v3
  title: Salvy API
  x-logo:
    url: web/logo.png
servers:
  - url: https://api.salvy.com.br
    description: Salvy API URL
security:
  - bearerAuth: []
tags:
  - name: Public API
  - name: Outgoing Webhooks
paths:
  /api/v3/phone-accounts/{id}/esim:
    get:
      tags:
        - Public API
      description: >-
        Consulta os dados de ativação do eSIM de uma linha móvel ou global da
        empresa pelo ID. Enquanto o eSIM ainda está sendo preparado, `status`
        retorna "provisioning" e os demais campos ficam nulos — repita a
        consulta em instantes. Quando o código está pronto, `status` é "ready" e
        os campos de ativação são preenchidos. Se o eSIM já foi instalado em um
        aparelho, `status` é "installed". Retorna 422 para linhas que não
        utilizam eSIM, como linhas com chip físico ou linhas de número virtual.
      operationId: publicGetPhoneAccountEsimV3
      parameters:
        - name: id
          in: path
          required: true
          schema:
            $schema: https://json-schema.org/draft/2020-12/schema
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $schema: https://json-schema.org/draft/2020-12/schema
                type: object
                properties:
                  status:
                    type: string
                    enum:
                      - provisioning
                      - ready
                      - installed
                    description: >-
                      Situação do eSIM desta linha. "provisioning": o eSIM ainda
                      está sendo preparado — consulte novamente em instantes.
                      "ready": o código de ativação está disponível e os campos
                      abaixo estão preenchidos. "installed": o eSIM já foi
                      instalado em um aparelho. Novos valores poderão ser
                      adicionados sem mudança de versão da API — trate qualquer
                      valor não reconhecido como "provisioning".
                    example: ready
                  qrCodeBase64:
                    description: >-
                      Imagem do QR Code de ativação do eSIM como data URL em
                      base64, pronta para exibição. Nulo enquanto o código não
                      está disponível (status diferente de "ready").
                    example: data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAKQ...
                    type:
                      - string
                      - 'null'
                  fullCode:
                    description: >-
                      Código de ativação completo do eSIM, no formato
                      "1$dominio-smdp$codigo". Use quando não for possível
                      instalar pelo QR Code. Nulo enquanto o código não está
                      disponível.
                    example: 1$smdp.gigs.com$K2-1A2B3C-4D5E6F
                    type:
                      - string
                      - 'null'
                  code:
                    description: >-
                      Parte final do código de ativação, após o domínio do
                      servidor SM-DP+. Nulo enquanto o código não está
                      disponível.
                    example: K2-1A2B3C-4D5E6F
                    type:
                      - string
                      - 'null'
                  smdpDomain:
                    description: >-
                      Domínio do servidor SM-DP+ do eSIM. Nulo enquanto o código
                      não está disponível.
                    example: smdp.gigs.com
                    type:
                      - string
                      - 'null'
                required:
                  - status
                  - qrCodeBase64
                  - fullCode
                  - code
                  - smdpDomain
                additionalProperties: false
        '401':
          description: ''
          content:
            application/json:
              schema:
                $schema: https://json-schema.org/draft/2020-12/schema
                type: object
                properties:
                  code:
                    type: string
                    enum:
                      - unauthorized
                  message:
                    type: string
                required:
                  - code
                  - message
                additionalProperties: {}
        '403':
          description: ''
          content:
            application/json:
              schema:
                $schema: https://json-schema.org/draft/2020-12/schema
                type: object
                properties:
                  code:
                    type: string
                    enum:
                      - forbidden
                      - insufficient-scope
                  message:
                    type: string
                required:
                  - code
                  - message
                additionalProperties: {}
        '404':
          description: ''
          content:
            application/json:
              schema:
                $schema: https://json-schema.org/draft/2020-12/schema
                type: object
                properties:
                  code:
                    type: string
                    enum:
                      - resource-not-found
                  message:
                    type: string
                required:
                  - code
                  - message
                additionalProperties: {}
        '413':
          description: ''
          content:
            application/json:
              schema:
                $schema: https://json-schema.org/draft/2020-12/schema
                type: object
                properties:
                  code:
                    type: string
                    enum:
                      - payload-too-large
                  message:
                    type: string
                required:
                  - code
                  - message
                additionalProperties: {}
        '422':
          description: ''
          content:
            application/json:
              schema:
                $schema: https://json-schema.org/draft/2020-12/schema
                type: object
                properties:
                  code:
                    type: string
                    enum:
                      - input-validation-error
                      - unprocessable-entity
                      - phone-account-invalid-sim-type
                      - phone-account-invalid-provider
                      - company-not-active
                  message:
                    type: string
                  details:
                    type: array
                    items:
                      type: object
                      properties:
                        key:
                          type: string
                        message:
                          type: string
                      required:
                        - key
                        - message
                      additionalProperties: false
                required:
                  - code
                  - message
                additionalProperties: {}
        '500':
          description: ''
          content:
            application/json:
              schema:
                $schema: https://json-schema.org/draft/2020-12/schema
                type: object
                properties:
                  code:
                    type: string
                    enum:
                      - unknown
                      - phone-account-provider-error
                  message:
                    type: string
                required:
                  - code
                  - message
                additionalProperties: {}
      deprecated: false
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: key

````