Consultar Status da Autorização

Consulta o status atual da autorização Dataprev de um trabalhador. Utilize este endpoint para verificar se a autorização foi concluída antes de prosseguir para a consulta de margem.

Fluxo recomendado

Após enviar a autorização, faça polling neste endpoint até que o status indique que a autorização foi concluída. Recomendamos intervalos de 10 a 30 segundos entre as consultas.

Parâmetros

Parâmetro
Local
Tipo
Descrição

cpf

path

string

CPF do employee (11 dígitos, sem pontuação)

Próximo passo

Quando a autorização estiver concluída, prossiga para Consultar Margem.

Status de Autorização

get
/api/v1/originator/employees/{cpf}/authorization/status

Consulta status de autorização Dataprev de um employee

Autorizações
AuthorizationstringObrigatório

JWT token fornecido pelo administrador

Parâmetros de rota
cpfstringObrigatório

CPF do employee (11 dígitos)

Pattern: ^\d{11}$
Respostas
chevron-right
200

Status retornado com sucesso

application/json
statusstring · enumOpcional

Status da autorização Dataprev.

Valor Significado
NOT_STARTED Processo não iniciado
PENDING_SIGNATURE Aguardando assinatura do termo
PENDING_SUBMISSION Aguardando envio ao Dataprev
AUTHORIZED Autorização concluída (termo assinado)
EXPIRED Prazo de assinatura expirado
Valores possíveis:
messagestringOpcional
signUrlstringOpcional
nsustringOpcional
expiresAtstring · date-timeOpcional
daysRemainingintegerOpcional
get
/api/v1/originator/employees/{cpf}/authorization/status

Atualizado