Orientações e respostas da equipe da Direct Data

/api/BeneficioPrestacaoContinuada

💡 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.

Introdução

O Benefício de Prestação Continuada (BPC) é um benefício assistencial importante que:

• Garante um salário mínimo mensal
• Atende pessoas com deficiência e idosos
• Não requer contribuição prévia à Previdência Social
• É gerido pelo INSS

Este endpoint é fundamental para sistemas que necessitam verificar:

• Situação de beneficiários
• Análise de crédito
• Compliance
• Verificação de renda
• Onboarding de clientes

URL Base

A API está hospedada no seguinte endereço:

https://apiv3.directd.com.br

Endpoint

GET /api/BeneficioPrestacaoContinuada

Este endpoint retorna informações detalhadas sobre beneficiários do BPC, exigindo autenticação por meio de um TOKEN válido.

Autenticação

Para utilizar este endpoint, você deve incluir o parâmetro TOKEN na URL. O TOKEN serve para autenticar o usuário e garantir o acesso aos recursos. Sem um TOKEN válido, a API retornará um erro de autenticação (401).

Regras de Autenticação

1. O TOKEN é obrigatório para todas as consultas.
2. O IP de origem da requisição deve estar autorizado no sistema.
3. Em caso de dúvidas ou problemas com o TOKEN, entre em contato com o suporte técnico pelo e-mail: suporte@directd.com.br.

Campos da API

• CPF: Número do CPF do beneficiário
• Data ou Mês de Competência: Data de competência do benefício
• Data ou Mês de Referência: Data de referência do benefício
• Flag Benefício concedido Judicialmente: Indica se o benefício foi concedido por via judicial
• Lista de Benefícios: Relação de benefícios do titular
• Município: Cidade do beneficiário
• NIS: Número de Identificação Social
• Nome: Nome completo do beneficiário
• Número do Registro: Identificador único do benefício
• UF: Estado do beneficiário
• Valor: Valor do benefício

Parâmetros

*É necessário informar pelo menos um dos parâmetros: CPF ou NIS.

Exemplo de Requisição

Usando cURL

'https://apiv3.directd.com.br/api/BeneficioPrestacaoContinuada?CPF=DOCUMENTO_AQUI&TOKEN=SEU_TOKEN_AQUI'

Respostas

A API retorna respostas em formato JSON com os seguintes códigos de status:

Sucesso (200)

Essa resposta é retornada quando a consulta é processada corretamente.

{
  "metaDados": {
    "consultaNome": "BPC",
    "consultaUid": "direct-uid-123456",
    "chave": "CPF=12345678900;",
    "usuario": "UsuarioTeste",
    "mensagem": "Consulta realizada com sucesso.",
    "ip": "0.0.0.0",
    "resultadoId": 1,
    "resultado": "Sucesso",
    "apiVersao": "v3",
    "gerarComprovante": false,
    "urlComprovante": null,
    "assincrono": false,
    "data": "05/12/2024 16:09:04",
    "tempoExecucaoMs": 120
  },
  "retorno": {
    "nis": "12345678901",
    "cpf": "12345678900",
    "nome": "João da Silva",
    "beneficioConcedidoJudicialmente": false,
    "beneficios": [
      {
        "numeroRegistro": 123456789,
        "dataMesCompetencia": "03/2024",
        "dataMesReferencia": "03/2024",
        "valor": "1412,00",
        "municipio": "São Paulo",
        "uf": "SP"
      }
    ]
  }
}

Em Processamento (202)

Retornado quando a consulta assíncrona ainda está em processamento.

{
  "metaDados": {
    "consultaNome": "BPC",
    "consultaUid": "direct-uid-789012",
    "chave": "CPF=12345678900;",
    "usuario": "UsuarioTeste",
    "mensagem": "Consulta em processamento",
    "ip": "0.0.0.0",
    "resultadoId": 2,
    "resultado": "Em Processamento",
    "apiVersao": "v3",
    "gerarComprovante": false,
    "urlComprovante": null,
    "assincrono": true,
    "data": "05/12/2024 16:09:04",
    "tempoExecucaoMs": 1000
  },
  "retorno": null
}

Erro de Autenticação (401)

Retornado quando o TOKEN fornecido é inválido ou o IP não está autorizado.

{
  "metaDados": {
    "consultaNome": "BPC",
    "consultaUid": "direct-uid-654321",
    "chave": "CPF=12345678900;",
    "usuario": null,
    "mensagem": "IP ou Token inválido. Verifique.",
    "ip": "0.0.0.0",
    "resultadoId": 3,
    "resultado": "Não Autorizado",
    "apiVersao": "v3",
    "gerarComprovante": false,
    "urlComprovante": null,
    "assincrono": false,
    "data": "05/12/2024 16:09:04",
    "tempoExecucaoMs": 1
  },
  "retorno": null
}

Códigos de Resposta

Notas Importantes

• É necessário informar pelo menos um dos parâmetros de busca: CPF ou NIS
• Os parâmetros podem ser enviados com ou sem formatação
• Esta consulta não possui opção de comprovante em PDF
• Para dúvidas ou suporte, contate suporte@directd.com.br
• Certifique-se de que o IP da requisição está previamente autorizado
• O valor da consulta é R$ 0,36 por requisição