Skip to main content
GET
Listar Validações KYC de uma Entidade

Visão Geral

Este endpoint recupera o histórico completo de validações KYC de uma entidade específica. Isso é útil para auditorias, acompanhamento de conformidade e compreensão da jornada de verificação de uma entidade. Recursos principais:
  • Retorna todas as validações (atuais e históricas) de uma entidade
  • Suporta paginação para grandes históricos de validações
  • Inclui detalhes completos de verificação para cada validação
  • Ordenado por data de criação (mais recente primeiro)
  • Mostra qual validação está atualmente ativa

Quando Usar Isso

  • Auditar histórico de verificação: Ver todas as tentativas de KYC e seus resultados
  • Relatórios de conformidade: Rastrear tentativas de verificação para conformidade regulatória
  • Suporte ao usuário: Investigar por que a verificação de um usuário falhou ou teve sucesso
  • Análises: Analisar taxas de sucesso de verificação e padrões de abandono
  • Depuração: Solucionar problemas de verificação revisando o histórico completo

Solicitação

Endpoint

Parâmetros de Rota

string
required
O UUID da entidade para recuperar validações

Parâmetros de Query

integer
default:"1"
Número da página para paginação (começa em 1)
integer
default:"100"
Número de validações por página (máx 100)
string
Filtrar validações por status. Valores possíveis:
  • pending - Validação criada, usuário não começou
  • in_progress - Usuário está completando ativamente a verificação (preenchendo formulário)
  • in_review - Verificação completa, requer revisão manual da equipe de compliance
  • approved - Verificação bem-sucedida
  • rejected - Verificação falhou
  • expired - Validação expirou (usuário não completou a tempo)
  • abandoned - Usuário começou mas não completou
  • cancelled - Validação foi cancelada pela organização
boolean
Filtrar para mostrar apenas a validação ativa atual (true) ou validações históricas (false)

Cabeçalhos

Resposta

Resposta de Sucesso (200 OK)

Retorna uma lista paginada de validações:

Campos de Resposta

array
Array de objetos de validação
integer
Número total de validações que correspondem à consulta
integer
Número da página atual
integer
Número de validações por página

Exemplos de Solicitações

Obter Todas as Validações de uma Entidade


Filtrar por Status

Obter apenas validações aprovadas:

Obter Apenas a Validação Atual


Exemplo de Paginação

Respostas de Erro

Entidade Não Encontrada (404)

Parâmetros de Query Inválidos (400)

Não Autorizado (401)

Casos de Uso

1. Trilha de Auditoria para Conformidade

Rastrear todas as tentativas de verificação para conformidade regulatória:

2. Calcular Taxa de Sucesso

Analisar taxas de sucesso de verificação:

3. Encontrar Validações Falhadas para Suporte

Ajudar usuários que tiveram problemas de verificação:

4. Exportar Histórico de Validação

Exportar histórico completo de validação para relatórios:

Notas Importantes

Por padrão, este endpoint retorna até 100 validações por página. Se uma entidade tiver mais de 100 validações, você precisará usar paginação para recuperar todos os registros.
As validações são retornadas em ordem decrescente por data de criação (mais recente primeiro). A validação atual normalmente aparecerá primeiro na lista.
Apenas uma validação por entidade pode ter isCurrent: true por vez. Quando uma nova validação é criada, a validação atual anterior é automaticamente marcada como isCurrent: false.
Todas as validações são retidas indefinidamente para fins de auditoria e conformidade. As validações históricas nunca são excluídas, mesmo que estejam abandonadas ou expiradas.
Para entidades com muitas validações (>100), considere usar paginação e filtros de status para reduzir o tamanho da resposta e melhorar o desempenho.

Diferenças com Endpoints Similares

Próximos Passos

Obter Validação Atual

Obter apenas a validação ativa de uma entidade

Criar Validação KYC

Iniciar uma nova sessão de verificação

Verificar Status da Entidade

Obter resumo do status de verificação

Sincronizar Validação

Atualizar dados de validação manualmente