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:
Capacidade | Endereç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:
Nome | Tipo | Observação | Obrigatório? |
cpf | number | Deve ser informado CPF, com DV, sem pontos ou traços. | SIM |
codigoEspecie | number | Código da espécie. De acordo com a tabela de Espécies | NÃO |
codigoSituacao | number | Código da situação. De acordo com a tabela de situações | Não |
Dados de Retorno:
Nome | Tipo | Conteúdo |
cpf | number | Número do CPF consultado |
Lista de Benefícios | ||
nit | number | NIT do titular do benefício |
nomeTitular | string | Nome do títular do benefício |
nomeMaeTitular | string | Nome da mãe do títular do benefício |
genero | string | Gênero do titular do benefício |
dataNascimento | string | Data de nascimento do titular do benefício |
numeroBeneficio | number | Número do benefício |
codigoEspecieBeneficio | number | Código da Especie de Benefício |
descricaoEspecieBeneficio | string | Descrição da Especie de Benefício |
codigoSituacaoBeneficio | number | Código de Situação do benefício |
descricaoSituacaoBeneficio | string | Código de Situação do benefício |
dataInicioBeneficio | String | Data de início do benefício |
dataCessacaoBeneficio | string | Data de cessação do benefício |
formaFiliacao | number | Código da Forma de Filiação |
descricaoFormaFiliacao | string | Descrição da Forma de Filiação |
ramoAtividade | number | Código do Ramo de Atividade |
descricaoRamoAtividade | string | Descriçã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:
Nome | Tipo | Observação | Obrigatório? |
cpf | number | Deve ser informado CPF, com DV, sem pontos ou traços. | SIM |
codigoEspecie | number | Código da espécie. De acordo com a tabela de Espécies | NÃO |
codigoSituacao | number | Código da situação. De acordo com a tabela de situações | Não |
Dados de Retorno:
Nome | Tipo | Conteúdo |
pertencimentoEspecie | boleano | TRUE 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:
Nome | Tipo | Observação | Obrigatório? |
cpf | number | Deve ser informado CPF, com DV, sem pontos ou traços. | SIM |
Dados de Retorno:
Nome | Tipo | Conteúdo |
pertencimentoEspecie | boleano | TRUE ou FALSE |