1. Início
  2. Docs
  3. DaaS
  4. API Benefício
  5. Recursos e Operações

Recursos e Operações

Existem 3 (três) operações (capacidades) disponíveis para comercialização na API de Benefício, oferecidas para cada contratante, conforme as condições estabelecidas e devidamente autorizadas:

CapacidadeEndereço
/beneficios   Retorna lista com dados de Benefícios para um CPF

 
https://endpointsp.dataprev.gov.br/beneficios/v3.0/beneficios?
/beneficios/pertence-especie

Retorna SIM/NÃO conforme existência de Benefício para CPF, espécie e situação informados
 
https://endpointsp.dataprev.gov.br/beneficios/v3.0/beneficios/pertence-especie?
/beneficios/bpc Retorna true/false conforme existência de Benefício para CPF, espécie 87 e situação ATIVO 
https://endpointsp.dataprev.gov.br/beneficios/v3.0/beneficios/pertence-especie87

Operação /benefícios

Tem por objetivo retornar a lista de benefícios, com seus dados básicos, que o segurado possui. Tem como entrada principal o CPF e pode ser filtrada por espécie e situação.

Parâmetros de Requisição:

NomeTipoObservaçãoObrigatório?
cpfnumberDeve ser informado CPF, com DV, sem pontos ou traços.SIM
codigoEspecienumberCódigo da espécie. De acordo com a tabela de EspéciesNÃO
codigoSituacaonumberCódigo da situação. De acordo com a tabela de situaçõesNão

Dados de Retorno:

NomeTipoConteúdo
cpfnumberNúmero do CPF consultado
    Lista de Benefícios
nitnumberNIT do titular do benefício
nomeTitularstringNome do títular do benefício
nomeMaeTitularstringNome da mãe do títular do benefício
generostringGênero do titular do benefício
dataNascimentostringData de nascimento do titular do benefício
numeroBeneficionumberNúmero do benefício
codigoEspecieBeneficionumberCódigo da Especie de Benefício
descricaoEspecieBeneficiostringDescrição da Especie de Benefício
codigoSituacaoBeneficionumberCódigo de Situação do benefício
descricaoSituacaoBeneficiostringCódigo de Situação do benefício
dataInicioBeneficioStringData de início do benefício
dataCessacaoBeneficiostringData de cessação do benefício
formaFiliacaonumberCódigo da Forma de Filiação
descricaoFormaFiliacaostringDescrição da Forma de Filiação
ramoAtividadenumberCódigo do Ramo de Atividade
descricaoRamoAtividadestringDescrição do Ramos de Atividade

Operação /beneficios/pertence-especie

Esta capacidade tem por objetivo retornar o estado (sim/não) para consulta a Benefício para os argumentos passados:

Parâmetros de Requisição:

NomeTipoObservaçãoObrigatório?
cpfnumberDeve ser informado CPF, com DV, sem pontos ou traços.SIM
codigoEspecienumberCódigo da espécie. De acordo com a tabela de EspéciesNÃO
codigoSituacaonumberCódigo da situação. De acordo com a tabela de situaçõesNão

Dados de Retorno:

NomeTipoConteúdo
pertencimentoEspecieboleanoTRUE ou FALSE

Operação /beneficios/bpc

Esta capacidade tem por objetivo retornar o estado (true/false) para consulta a Benefício da espécie 87 que estejam ativos.

Parâmetros de Requisição:

NomeTipoObservaçãoObrigatório?
cpfnumberDeve ser informado CPF, com DV, sem pontos ou traços.SIM

Dados de Retorno:

NomeTipoConteúdo
pertencimentoEspecieboleanoTRUE ou FALSE
Este artigo foi útil para você? Não Sim

How can we help?

Tabela de Conteúdo