Parâmetros de Entrada Lote

Arquivo json contendo os dados do documento a ser disponibilizado na wallet do app gov.br.

Parâmetros de Saída Mensagem

Mensagem informando se o lote enviado através do arquivo json foi gravado com sucesso. Exemplo: "status": 200, "message": "Lote 1872 gravado com sucesso!", "lote": 1872,

Parâmetros de Entrada Authorization

Credencial de acesso à API disponibilizada pela SGD

Parâmetros de Saída Token

Token de acesso necessário para realizar a chamada ao serviço de envio e atualização dos documentos

Parâmetros de Entrada Data_inicio

Data inicial a qual deseja-se obter o status do processamento dos lotes enviados

Data_fim

Data final a qual deseja-se obter o status do processamento dos lotes enviados

Parâmetros de Saída Numero

Número do lote enviado

Recebido_em

Data em que o lote foi enviado para a wallet do gov.br

Processado_em

Data de processamento do lote pela wallet do gov.br

status

Consultar o status do processamento do lote enviado, o qual poderá assumir os seguintes valores: PENDENTE – lote ainda está na fila aguardando o processamento do lado do servidor gov.br. NAO_PROCESSADO – ocorreu erro durante o processamento do lote. Recomenda-se consultar o serviço de detalhe do processamento a fim de obter o log de execução. PROCESSAMENTO_INICIADO – lote está em execução pelo servidor do gov.br. PROCESSADO_PARCIALMENTE – ocorreu erro em pelo menos um registro do lote. Recomenda-se consultar o serviço de detalhe do processamento. Após a resolução do problema no arquivo de carga (JSON), será necessário reenviar apenas os registros com erro. PROCESSADO – processamento de todos os registros do lote realizado com sucesso.

Parâmetros de Entrada lote

Número lote

Parâmetros de Saída Data do evento

Data em que o lote foi processado

Total de registros

Quantidade de documentos(registros) enviados em determinado lote (arquivo json)

Registros processados

Quantidade de documentos processados com sucesso pela wallet do gov.br

Duração processamento

Duração do processamento do lote

Parâmetros de Entrada processado

Consulta os documentos que foram processados com sucesso.

situação

Consulta os documentos que estão ativo na wallet do gov.br

Parâmetros de Saída Tipo do documento

Apresenta o nome do documento ao qual o usuário que está realizando a requisição tem acesso

Total

Total de documentos já enviados com sucesso para a wallet do gov.br.

Total baixados

Quantidade de vezes que o documento já foi baixado pelo usuário no aplicativo gov.br.

Parâmetros de Entrada CPF

Número do CPF a ser excluído

Tipo do documento

Nome do documento a ser excluído

Parâmetros de Saída Timestamp

Data do processamento da exclusão

Status

Status da exclusão

Message

Mensagem do processamento da exclusão.

Parâmetros de Entrada CPF

Lista de CPFs

Parâmetros de Saída CPF

Lista de CPFs

Tipo do documento

Nome do documento

Versão

Versão da API da wallet

Situação

Verifica o status do documento na wallet

Data de processamento

Verifica a data em que ocorreu o processamento do lote do CPF

Número do lote

Número do lote o qual foi enviado o documento do cidadão

Total de downloads

Quantidade de vezes o cidadão realizou o download do documento no aplicativo gov.br