Skip to main content
cURL
Inclui o cliente como assinante do Termo de Retenção de Portabilidade e dispara, automaticamente, toda a jornada de retenção digital: geração do termo, notificação do cliente, coleta da assinatura e envio da evidência à Núclea.

Quando usar

Utilize este endpoint quando decidir formalizar a retenção do cliente por assinatura digital do Termo de Retenção.

O que acontece depois da chamada

A chamada só cria a assinatura; o restante da jornada é automático:
  1. Validação síncrona — a BMP confirma que nuPortabilidade existe, pertence à carteira do parceiro autenticado e ainda está dentro do prazo regulatório (D+2). Fora disso, a requisição é rejeitada e nenhuma assinatura é criada.
  2. Geração do Termo — PDF pré-preenchido com os dados do cliente, contrato e portabilidade, a partir do modelo padronizado pela Autorregulação.
  3. Envio do link de assinatura — pelos canais marcados como true (notificarPorEmail, notificarPorWhatsApp, notificarPorSMS); quando mais de um canal é indicado, o envio ocorre simultaneamente em todos. O link é único, seguro e expira ao final do prazo D+1 (dataLimiteAssinatura) — após isso, o cliente não consegue mais acessá-lo.
  4. Coleta da assinatura — o cliente assina digitalmente; a BMP registra IP/geolocalização e gera o código de autenticação (Hash) exigido pela Núclea, consolidando o PDF final.
  5. Envio ao Repositório de Evidências da Núclea — dentro da janela de operação do repositório (5h–18h) e ainda dentro do D+2.
  6. Montagem e envio da estrutura de retenção à CTC, encerrando a jornada com aceite ou recusa da retenção.
O parceiro acompanha cada uma dessas etapas pelos eventos cadastrados em Cadastrar Callback ou pelo campo statusAssinatura em Consultar Portabilidades.

Parâmetros da Requisição

string
obrigatório
Número CTC da portabilidade em retenção (mesmo valor retornado como nuPortabilidade na consulta gerencial). Deve existir e pertencer à carteira do parceiro autenticado.
string
Número da Cédula de Crédito Bancário do contrato retido.
string
Identificador da proposta no CaaS (equivalente ao codigoProposta retornado na consulta gerencial).
string
CPF do cliente titular do contrato.
string
E-mail do cliente, usado quando notificarPorEmail for true.
string
Telefone celular do cliente, usado quando notificarPorWhatsApp e/ou notificarPorSMS forem true.
boolean
Se true, envia o link de assinatura do Termo de Retenção por e-mail.
boolean
Se true, envia o link de assinatura do Termo de Retenção por WhatsApp.
boolean
Se true, envia o link de assinatura do Termo de Retenção por SMS.
string
Identificador de controle do próprio parceiro para esta solicitação de retenção (referência/rastreabilidade do lado do parceiro).
Ao menos um canal de notificação deve ser indicado (notificarPorEmail, notificarPorWhatsApp ou notificarPorSMS), com o respectivo dado de contato preenchido — sem isso o cliente não recebe o link de assinatura. Regra de validação exata a confirmar com o time responsável.

Campos da Resposta

O restante da jornada é acompanhado pelo campo statusAssinatura do endpoint Consultar Portabilidades, ou pelos eventos recebidos na URL cadastrada em Cadastrar CallbackPORTABILIDADE_SOLICITADA, DOCUMENTO_ENVIADO, ASSINATURA_COLETADA e TIMEOUT_ASSINATURA. Correlação sempre por nuPortabilidade; ver detalhes em Eventos de Callback.

Autorizações

Authorization
string
header
obrigatório

Informe o token

Corpo

nuPortabilidade
string | null
numeroCCB
string | null
codigoProposta
string | null
documento
string | null
email
string | null
telefoneCelular
string | null
notificarPorEmail
boolean
notificarPorWhatsApp
boolean
notificarPorSMS
boolean
codigoIdentificador
string | null

Resposta

OK

success
boolean
data
object
errors
object[] | null