Documentação¶
Endpoints¶
Endereço de autenticação¶
| Ambiente | URL |
|---|---|
| Homologação | https://auth-h-sigap-rec.df-1.estaleiro.serpro.gov.br/recepcao-autenticacao/token |
| Produção | https://auth-sigap-rec.ni.estaleiro.serpro.gov.br/recepcao-autenticacao/token |
Para mais detalhes sobre a autenticação, consulte a seção Autenticação na API.
Operação para recuperação da condição de impedimento de um cidadão para apostas¶
Indica se um determinado cidadão (identificado pelo seu CPF) está impedido de realizar apostas por ser beneficiário de algum programa social como Bolsa Família (BF) ou Benefício de Prestação Continuada (BPC) ou por ter registrado a sua autoexclusão do mercado de apostas esprtivas e jogos online.¶
[GET] /impedimento/v1/condicao/{cpf}
Endpoints¶
| Ambiente | URL |
|---|---|
| Homologação | https://hom-api-sigap-impedidos.estaleiro.serpro.gov.br/impedimento/v1/condicao/{cpf} |
| Produção | https://sigap-impedidos.fazenda.gov.br/impedimento/v1/condicao/{cpf} |
Entrada¶
| Parâmetro | Tipo | Descrição |
|---|---|---|
| cpf | string | CPF (Cadastro de Pessoa Física) sem formatação (ex.: "36878304032") |
- ATENÇÃO: Em Homologação use qualquer um dos CPFs FICTÍCIOS: 28784142090, 08782758000, 08940473965, para retornar resultado IMPEDIDO [PROGRAMA_SOCIAL] ou 51077358008, 62564939074, 15690288691 [AUTOEXCLUSAO_CENTRALIZADA], para quaisquer outros CPFs, o resultado retornado será NAO_IMPEDIDO.
Saída¶
| Parâmetro | Tipo | Descrição |
|---|---|---|
| cpf | string | CPF (Cadastro de Pessoa Física) sem formatação e 11 dígitos (ex.: "36878304032") |
| resultado | string | "NAO_IMPEDIDO" ou "IMPEDIDO" |
| motivo | string | "AUTOEXCLUSAO_CENTRALIZADA" ou "PROGRAMA_SOCIAL" se resultado IMPEDIDO, se resultado NAO_IMPEDIDO o campo é omitido |
| idRequisicao | string | identificador da requisição HTTP para log e rastreabilidade (ex.: "96a101dd-c49a-4fea-aee2-a76510f32190") |
| dataConsulta | string | data do processamento da consulta, no formato "yyyy-MM-dd'T'HH:mm:ss.SSS" (ex.: "2025-05-23T12:48:45.326") |
Códigos de Retorno¶
As requisições à API Sigap podem receber como retorno os seguintes código HTTP:
Code / Responses¶
200 (Ok)¶
Requisição recebida e processada com sucesso, no caso dos endpoints que não envolvem envio de arquivos.
400 Requisição inválida (Bad Request)¶
A requisição não foi aceita pois existe alguma inconsistência no parâmetro de CPF. Uma mensagem especificando o tipo de erro será retornada no corpo da resposta. Exemplos de inconsistências: o parâmetro passado como CPF tem tamanho menor ou maior que 11; nem todos os caracteres são dígitos; os dígitos verificadores do CPF (os 2 últimos dígitos) não são válidos.
401 Usuário não autorizado (Unauthorized)¶
Problemas durante a autenticação/autorização.
404 Recurso não encontrado (Not Found)¶
A requisição referenciou um endpoint não existente ou para o qual não há dados.
500 Erro interno no servidor (Internal Server Error)¶
Ocorreu algum erro inesperado na aplicação.