Skip to main content
cURL
Retorna somente as portabilidades da carteira do parceiro autenticado (client_id), com filtros por período, CPF, etapa e número de proposta.

Endpoint

Autenticação

O token é o reference token BMP e precisa conter a claim client_id. Mensagens de erro possíveis no 401: Token não informado, Token inválido ou expirado, Token não contém client_id.

Parâmetros da Requisição

Todos os parâmetros abaixo são enviados via query string e são opcionais.
date (yyyy-MM-dd)
Início do período, considerando a data de solicitação da portabilidade.
date (yyyy-MM-dd)
Fim do período, considerando a data de solicitação da portabilidade. Se enviado sem dataInicio, é ignorado — veja regras abaixo.
string
CPF do cliente, com ou sem máscara.
string (repetível)
Etapa gerencial da portabilidade. Repita o parâmetro para filtrar mais de uma etapa. Case-insensitive. Valores aceitos:
Também são aceitos RETIDA e PORTADA (equivalentes a Retida e Portada).
string (repetível)
Número da proposta no CaaS (CodigoPropostaAN). Repita o parâmetro para consultar mais de uma proposta.
int
padrão:"1"
Página da consulta (mínimo 1). Cada página tem 20 registros.

Regras de negócio

  • Filtros informados em conjunto são cumulativos (AND).
  • Sem dataInicio e sem dataFim: retorna no máximo as 50 portabilidades mais recentes da carteira, ordenadas por dataSolicitacao decrescente, paginadas de 20 em 20.
  • Somente dataInicio informado (sem dataFim): dataFim assume a data corrente no horário de Brasília.
  • dataFim anterior a dataInicio400.
  • Sem resultado → 200 com items: [].
  • numeroProposta informado como lista vazia → 400.
  • CPF inválido → 400.
  • statusOperacao fora da lista aceita → 400, com os valores aceitos na mensagem de erro.

Campos do item retornado

Todo campo abaixo está sempre presente na resposta. Quando não se aplica ao registro, o valor é null — o campo não é omitido.

Respostas de erro (400)

Domínio — motivoRetencao

Código CTC (MtvRetenContrto). Inteiro. null quando a operação não está em retenção.

Domínio — motivoCancelamento

Código CTC (mtvCanceltPortldd). Inteiro. Preenchido apenas quando o cancelamento veio do ACTC104.
Decurso de prazo simples (statusPortabilidade 910) devolve motivoCancelamento = null.

Autorizações

Authorization
string
header
obrigatório

Informe o token

Parâmetros de consulta

DataInicio
string<date>
DataFim
string<date>
CpfEmitente
string
StatusOperacao
string[]
NumeroProposta
string[]
Page
integer<int32>

Resposta

OK

success
boolean
data
object
errors
object[] | null