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-impedidos-sigap.estaleiro.serpro.gov.br/impedimento/v1/condicao/{cpf} |
| Produção | https://impedidos-sigap.estaleiro.serpro.gov.br/impedimento/v1/condicao/{cpf} Atenção: Este endpoint ainda não está liberado para uso. |
Entrada¶
| Parâmetro | Tipo | Descrição |
|---|---|---|
| cpf | string | CPF (Cadastro de Pessoa Física) sem formatação (ex.: "36878304032") |
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 | "PERMITIDO" ou "IMPEDIDO" |
| motivosImpedimento | array[string] | se o resultado for "PERMITIDO" esse atributo não será enviado na resposta, se o resultado for "IMPEDIDO", será enviado um array contendo os motivos para impedimento (ex.: [ "PBF", "BPC", "AUTOEXCLUSAO" ], onde PBF = Programa Bolsa Família, BPC = Benefício de Prestação Continuada) |
| 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.
201 (Created)¶
Tudo funcionou como esperado, no caso de envio de arquivo.
250 Falha na validação do esquema XML do lote¶
A requisição não foi aceita pois existe alguma inconsistência entre o arquivo xml enviado e a validação com o esquema xsd do tipo de arquivo enviado.
400 Requisição inválida¶
A requisição não foi aceita pois existe alguma inconsistência em algum parâmetro. Uma mensagem especificando o tipo de erro será retornado no corpo da resposta.
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.
413 Tamanho máximo do arquivo excedido¶
Tamanho máximo do arquivo permitido 3mb.
500 Erro interno na aplicação (Internal Server Error)¶
Ocorreu algum erro interno no Servidor.