O endpoint /api/BeneficioPrestacaoContinuada permite realizar consultas sobre o Benefício de Prestação Continuada (BPC), um benefício assistencial que garante um salário mínimo mensal a pessoas com deficiência de qualquer idade e idosos com 67 anos ou mais que comprovem não possuir meios de prover a própria subsistência ou de tê-la provida por sua família.
Benefício de Prestação Continuada - BPC
O Benefício de Prestação Continuada corresponde à garantia de um salário mínimo, devido à pessoa portadora de deficiência, independente da idade, e ao idoso com 67 anos ou mais, que comprove não possuir meios de prover a própria manutenção e nem de tê-la provida por sua família.
Casos de Uso
- Integração com Benefício de Prestação Continuada - BPC
- Onboarding KYC e validação de identidade
- Análise de risco/crédito com dados cadastrais e socioeconômicos
- Prevenção a fraude em abertura de conta e cadastro
Aplicações
- Onboarding de Clientes e Fornecedores
- Análise de Risco/Crédito
Benefícios
- Documentação de Benefício de Prestação Continuada - BPC acessível e atualizada
- Dados atualizados e padronizados
- Aumento de aprovação com menos atrito
- Conformidade com políticas internas e LGPD
URL Base
A API está hospedada no seguinte endereço:
https://apiv3.directd.com.br/api/BPCEndpoint
GET https://apiv3.directd.com.br/api/BPC?Cpf={0}&Nis={1}&Token=Seu_TokenDescrição: Endpoint para realizar consultas Benefício de Prestação Continuada - BPC.
Nota: Esta consulta não gera comprovantes.
Campos Retornados
- CPF: CPF do indivíduo
- Data ou Mês de Competência: Informa a data e mês de competência do registro.
- Data ou Mês de Referência: Informa a data e mês de referência do registro.
- Flag Benefício concedido Judicialmente.: Informa se o benefício foi concedido judicialmente. True(verdadeiro) ou false(falso).
- Lista de Benefícios: Lista os dados do benefício de bolsa família consultado
- Município: Município/cidade referente ao registro
- NIS: Código NIS (Número de Identificação Social) do titular
- Nome: Nome do indivíduo/registro
- Número do Registro: Número de registro
- UF: Unidade Federativa (estado) referente ao registro
- Valor: Valor da parcela
Parâmetros
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
NIS | string | Não | O parâmetro NIS pode ser enviado com ou sem formatação. |
CPF | string | Não | O parâmetro CPF pode ser enviado com ou sem formatação. |
TOKEN | string | Sim | O parâmetro TOKEN é essencial para efetuar esta consulta. Em caso de dúvidas, por favor, entre em contato com: suporte@directd.com.br |
Exemplo de Resposta
{
"metaDados": {
"consultaNome": "string",
"consultaUid": "string",
"chave": "string",
"usuario": "string",
"mensagem": "string",
"ip": "string",
"resultadoId": 0,
"resultado": "string",
"apiVersao": "v3",
"enviarCallback": false,
"gerarComprovante": false,
"urlComprovante": "string",
"assincrono": true,
"data": "dd/MM/yyyy HH:mm:ss",
"tempoExecucaoMs": 0
},
"retorno": {
"nis": "string",
"cpf": "string",
"nome": "string",
"beneficioConcedidoJudicialmente": true,
"beneficios": [
{
"numeroRegistro": 0,
"dataMesCompetencia": "string",
"dataMesReferencia": "string",
"valor": "string",
"municipio": "string",
"uf": "string"
}
]
}
}Erros Comuns
| Código | Descrição |
|---|---|
400 | Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos. |
401 | Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso. |
403 | Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível. |
404 | Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado. |
408 | Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido. |
500 | Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte. |
503 | Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte. |
Notas Importantes
- Informe apenas um único documento por requisição
- Para utilizar a consulta de forma assíncrona, utiliza-se: '&async=habilitar' na URL
- Em caso de dúvidas/suporte, entre em contato pelo e-mail: suporte@directd.com.br ou pelo nosso WhatsApp: (11) 93906-9228