Status dos Documentos do Onboarding por CPF

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Endpoint responsável por exibir o status de cada documento do onboarding (admissão) de um colaborador no Vlow, utilizando o CPF do colaborador.
Retorna um objeto data com o nome, o CPF, o responsável e os documentos do colaborador, no formato { "status", "isCustomField" }.

Regra do status de documento: o status da análise do documento no Vlow. Fica PENDING enquanto faltar algum anexo exigido, a não ser que o documento esteja DISAPPROVED ou REANALYSIS, que prevalecem. Anexos desativados pela empresa não são exigidos.

Status possíveis: PENDING (pendente), APPROVED (aprovado), DISAPPROVED (reprovado), INCOMPLETE (incompleto) e REANALYSIS (em reanálise).

isCustomField: true quando o item é uma etapa ou um grupo de campos customizados configurado pela sua empresa no Vlow. Itens customizados usam como chave o nome em camelCase, sem acento (ex.: integracaoShopee).

responsible: usuário do Vlow que cadastrou o colaborador (coluna "Responsável" da listagem de colaboradores), ou null.

Só são retornados colaboradores da empresa da credencial. Itens que não se aplicam ao colaborador (ocultos pela configuração da empresa, declarados ausentes ou que não valem para o perfil dele) não aparecem na resposta.

Path Params
string
required

CPF do colaborador, com ou sem máscara (11 dígitos)

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json