eSIM de Viagem — API
Conceitos

Ativação do eSIM

Como o cliente final ativa o eSIM — e por que a emissão acontece só nesse momento.

A emissão do eSIM é self-service: quando você cria o pedido, a plataforma envia um link de ativação ao cliente e o eSIM só é emitido quando o cliente ativa por esse link. Isso mantém o eSIM "fresco" para os dias da viagem e evita desperdiçar a validade do plano.

Criar o pedido não emite o eSIM. A emissão ocorre na ativação pelo cliente.

O que o cliente recebe

Ao criar o pedido, a plataforma dispara o link de ativação pelos canais cadastrados no cliente (e-mail e/ou WhatsApp). O endereço tem o formato:

https://{agencia}.esimdeviagem.com.br/ativar/{token}

Você também recebe esse link no campo activationUrl da resposta do pedido, caso queira enviá-lo pelo seu próprio canal.

O passo a passo do cliente

Uma página pública (sem login) mostra os detalhes do plano, a data da viagem, as orientações de instalação e o aviso sobre uso de dados no Brasil.

Confirma a identidade com o CPF

Para ver e ativar o eSIM, o cliente informa os 5 primeiros dígitos do CPF usado no cadastro. Se não conferir, a plataforma responde CPF incorreto e não revela os dados do eSIM. Veja Clientes e CPF.

Ativa o eSIM

Ao clicar em Ativar, a plataforma emite o eSIM. Em caso de sucesso, o cliente vê o QR Code, a string LPA para instalação manual e os links de instalação para iOS/Android.

Estados do pedido

pending_activation ──► activated
        │                 ▲
        ├──► activation_failed ──┘   (o cliente pode tentar de novo)
        └──► cancelled
StatusSignificado
pending_activationAguardando o cliente ativar pelo link.
activatedeSIM emitido; o objeto esim fica preenchido no pedido.
activation_failedFalha na emissão. O cliente pode tentar novamente pelo mesmo link.
cancelledPedido cancelado (só possível enquanto pending_activation).

Em falhas, a plataforma nunca expõe o erro técnico ao cliente — mostra o contato da agência. Um pedido em activation_failed continua ativável pelo mesmo link.

Como você acompanha

O acompanhamento padrão é por polling no detalhe do pedido: quando o status virar activated, o objeto esim (ICCID, lpaString, qrCodeUrl, links de instalação) estará preenchido.

curl https://api.esimdeviagem.com.br/v1/agencies/{agencyId}/orders/{id} \
  -H "Authorization: Bearer ong_sk_..."

Prefere ser notificado em vez de consultar? Atualizações via webhook podem ser habilitadas sob demanda — fale com o time comercial para avaliar a integração.

On this page