Pular para o conteúdo principal

​
API de Consulta – Não Me Perturbe

Tipo: Síncrona Este serviço permite consultar um número de telefone para verificar se existe bloqueio na base do Não Me Perturbe, retornando de forma imediata o status do telefone informado.

​
Objetivo do Serviço

Permitir a validação de elegibilidade de contato do trabalhador, identificando se o número informado possui bloqueio ativo na base do Não Me Perturbe, requisito essencial para a continuidade da operação de crédito consignado.

​
Endpoints

Homologação 
POST https://api.bmpdigital.moneyp.dev.br/Bureau/ConsultarNaoPerturbe
Produção 
POST https://api.bmpdigital.moneyp.com.br/Bureau/ConsultarNaoPerturbe

​
Autenticação

O serviço utiliza o padrão OAuth 2.0, garantindo segurança e integridade no acesso às APIs. O fluxo de autenticação envolve:
  • Geração de par de chaves (pública e privada);
  • Validação da chave pública junto à BMP;
  • Recebimento do client_id;
  • Geração de token JWT (RS256);
  • Obtenção do access token (Bearer Token).

​
Geração de Chaves

Antes da autenticação, é necessário gerar um par de chaves: Chave privada 
openssl genrsa -out private.pem 2048
Chave pública 
openssl rsa -in private.pem -pubout > public.pem
A chave pública deverá ser enviada conforme instruções recebidas por e-mail.

​
Geração do JWT

O token JWT deve ser gerado utilizando o algoritmo RS256, contendo os seguintes campos obrigatórios:
  • jti: Identificador único do token;
  • sub: Client ID fornecido pela BMP;
  • iat: Data/hora de emissão;
  • nbf: Data/hora mínima de validade;
  • exp: Data/hora de expiração;
  • iss: Emissor (client_id);
  • aud: Endpoint de autenticação.

​
Geração do Bearer Token

Endpoint 
POST https://auth.moneyp.dev.br/connect/token
Exemplo de requisição (cURL) 
curl --location 'https://auth.moneyp.dev.br/connect/token' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Cache-Control: no-cache' \
--data-urlencode 'grant_type=client_credentials' \
--data-urlencode 'client_id=client_id' \
--data-urlencode 'scope=bmp.digital.api.full.access' \
--data-urlencode 'client_assertion=<<Token JWT>>' \
--data-urlencode 'client_assertion_type=urn:ietf:params:oauth:client-assertion-type:jwt-bearer'
Após a autenticação, o token deve ser enviado no header: 
Authorization: Bearer <<AccessToken>>

​
Requisição da API

Exemplo (cURL) 
curl -X 'POST' \
'https://api.bmpdigital.moneyp.dev.br/Bureau/ConsultarNaoPerturbe' \
-H 'accept: text/plain' \
-H 'IdempotencyKey: 1' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <<AccessToken>>' \
-d '{
  "consulta": {
    "ddd": "string",
    "numero": "string"
  }
}'

​
Parâmetros

PropriedadeTipoObrigatórioDescrição
consulta.dddStringSimDDD com 2 dígitos numéricos
consulta.numeroStringSimNúmero com 8 a 9 dígitos

​
Retorno da Consulta

Telefone sem bloqueio 
{
  "hasError": false,
  "falha": false,
  "json": "{\"Motivo\":\"Telefone/Documento não encontrado.\",\"Data\":{\"PossuiBloqueio\":false,\"DataArquivo\":\"2026-03-03T00:00:00Z\",\"EmpresaBloqueada\":[],\"OrigemDescricao\":null}}",
  "msg": "",
  "messages": []
}
Telefone com bloqueio 
{
  "hasError": false,
  "falha": false,
  "json": "{\"Motivo\":\"\",\"Data\":{\"PossuiBloqueio\":true,\"DataArquivo\":\"2026-03-03T00:00:00\",\"EmpresaBloqueada\":[\"TODAS\"],\"OrigemDescricao\":\"WEB SITE\"}}",
  "msg": "",
  "messages": []
}

​
Interpretação do Retorno

  • PossuiBloqueio = true → Telefone bloqueado (operação não permitida);
  • PossuiBloqueio = false → Telefone elegível para contato;
  • EmpresaBloqueada → Indica abrangência do bloqueio;
  • OrigemDescricao → Origem do bloqueio (quando disponível).

​
Cenários de Erro

DDD inválido ou não informado 
{
  "hasError": true,
  "msg": "O parâmetro 'DDD' é obrigatório e não foi fornecido corretamente.",
  "messages": [
    {
      "code": "A0601",
      "description": "O parâmetro 'DDD' é obrigatório e não foi fornecido corretamente."
    }
  ]
}
Número inválido ou não informado 
{
  "hasError": true,
  "msg": "O parâmetro 'Numero' é obrigatório e não foi fornecido corretamente.",
  "messages": [
    {
      "code": "A0601",
      "description": "O parâmetro 'Numero' é obrigatório e não foi fornecido corretamente."
    }
  ]
}

​
Considerações Técnicas

  • A autenticação via OAuth 2.0 é obrigatória para consumo da API;
  • O uso do Bearer Token deve ocorrer em todas as requisições;
  • A validação do telefone é síncrona e deve ser realizada antes da originação;
  • Telefones com bloqueio ativo devem impedir a continuidade da operação;
  • Recomenda-se implementar tratamento de erros e validação prévia de formato dos campos.