O Zarv ID v2 é a versão atual: cada verificação roda com um perfil (profileId), que define os módulos e as regras de score, o resultado é assíncrono (webhook ou consulta) e há resumo por IA. O Zarv ID v3 é a nova versão e, por enquanto, oferece só o enriquecimento.
Novo por aqui? Comece pelo Guia rápido: do token ao resultado por webhook.
Perfis
Peça ao time da Zarv os perfis do seu workspace. Cada perfil atende uma entidade: você precisa de um perfil PF para verificar CPF e de um perfil PJ para verificar CNPJ.
GET /api/v2/profiles?kind=verification lista os perfis que rodam uma verificação, com o profileId e a entidade de cada um, e GET /api/v2/profiles/default/{pf|pj} traz o perfil padrão do workspace para cada entidade. Uma verificação só roda perfis verification da mesma entidade do documento; veja Perfil. Para mudar os módulos ou as regras de um perfil, ou criar um novo, fale com o time da Zarv.
Zarv ID v2, a versão atual: as verificações são roteadas por profileId para o motor de perfis de scoring, o resultado é assíncrono (o POST enfileira; a conclusão chega por webhook ou consulta) e há resumo por IA. O Zarv ID v3, em /api/id-v3/, é a nova versão e, por enquanto, oferece só o enriquecimento.
Servers
Login
Autenticação para obter um token de acesso
Request Body
Responses
Autenticação realizada com sucesso
Renovar token
Troca um token de renovação válido por um novo par de tokens. Guarde sempre o novo refreshToken retornado.
Request Body
Responses
Token renovado com sucesso
Listar perfis
Os perfis do seu workspace, em ordem alfabética. Uma verificação só roda perfis verification: use ?kind=verification para listar só os que servem em POST /api/v2/verifications. Cada item traz o id (o profileId da verificação), o nome, o tipo, a entidade que o perfil atende (pf para CPF, pj para CNPJ) e se é o perfil padrão do workspace para essa entidade (isDefault). A lista não é paginada.
Authorizations
For more details, see Authentication v2
Parameters
Query Parameters
Só perfis deste tipo. Use verification para ver os perfis que rodam uma verificação. Sem o parâmetro, lista todos os tipos.
"enrichment""verification""verification"Responses
Os perfis do workspace.
Consultar o perfil padrão
O perfil marcado como padrão do seu workspace para uma entidade (pf ou pj). Só um perfil verification pode ser o padrão.
Authorizations
For more details, see Authentication v2
Responses
O perfil padrão.
Consultar verificações
Obtém todas as verificações com filtros opcionais
Authorizations
For more details, see Authentication v2
Parameters
Query Parameters
"11111111111"1114Filtra pelo status da verificação.
"CREATED""PROCESSING""ANALYZING""COMPLETED""RETRYING""FAILED""CNH_EXTRACT""COMPLETED"Busca parcial e case-insensitive por CPF/CNPJ ou nome. Combina com os demais filtros.
"maria"Filtra pelo status do feedback (decisão de aprovação) mais recente da verificação. NOTSTARTED retorna verificações que ainda não receberam feedback.
"NOTSTARTED""APPROVED""REPROVED""STANDBY""WAIVED""APPROVED"Quando true, retorna apenas verificações potencialmente travadas: em CREATED ou PROCESSING e criadas entre 15 minutos e 12 horas atrás.
true1110125Filtra verificações com Zarv Score maior ou igual a este valor (inclusive, faixa 0–1000). Combine com scoreLte para um intervalo fechado.
50001000Filtra verificações com Zarv Score menor ou igual a este valor (inclusive, faixa 0–1000).
80001000Responses
Lista de verificações
Criar uma verificação
Cria uma nova verificação para um CPF ou CNPJ
Authorizations
For more details, see Authentication v2
Request Body
Responses
Verificação criada com sucesso
Criar verificações em lote
Cria uma verificação para cada nationalId da lista, aplicando a mesma configuração de verifications a todos os itens. Cada item é validado e cobrado individualmente; o resultado de cada um vem em items, um mapa indexado pelo nationalId. Itens aceitos retornam id (verification ID) para polling posterior; itens rejeitados retornam error. Face recognition e CNH não são suportados em lote — se presentes no corpo, são ignorados.
Authorizations
For more details, see Authentication v2
Request Body
Responses
Lote aceito para processamento. A resposta contém o resumo do lote e, em items, o status de cada nationalId enviado.
Consultar verificação por ID
Obtém uma verificação específica pelo ID
Authorizations
For more details, see Authentication v2
Parameters
Path Parameters
"805181ca-2956-49e1-81bb-93d1792d269d""uuid"Responses
Detalhes da verificação
Obter PDF da verificação
Retorna os bytes do arquivo PDF de uma verificação específica pelo ID. A resposta contém o conteúdo binário do arquivo e nao uma URL para download.
Authorizations
For more details, see Authentication v2
Parameters
Path Parameters
"805181ca-2956-49e1-81bb-93d1792d269d""uuid"Responses
Bytes do arquivo PDF da verificação
Obter resumo por IA da verificação
Retorna o resumo/veredito gerado por IA para uma verificação.
Quando o resumo é gerado. Há dois caminhos:
- Automático: quando a verificação tem
ia.resume, ao concluir o processamento (statusCOMPLETED, com dados de módulo) o motor computa e persiste o resumo e registra a decisão do autopilot antes de finalizar.ia.resumeé a única condição — sem ele, nem o resumo nem o autopilot rodam ao fim do processamento. - Lazy (sob demanda): este endpoint computa o resumo na primeira chamada e persiste; chamadas seguintes retornam o resultado pronto. Não registra decisão do autopilot.
Requer uma verificação com profileId já concluída.
Authorizations
For more details, see Authentication v2
Parameters
Path Parameters
"uuid"Responses
Resumo por IA da verificação
Criar feedback para uma verificação
Criar feedback para uma verificação
Authorizations
For more details, see Authentication v2
Request Body
Responses
Feedback criado com sucesso
Consultar lista restritiva
Obtém os registros da lista restritiva com paginação por workspace
Authorizations
For more details, see Authentication v2
Parameters
Query Parameters
"fc31805a-9ac5-423b-b3cb-b626c769b27c""uuid"10110011Responses
Lista restritiva consultada com sucesso
Adicionar item na lista restritiva
Cria um novo registro na lista restritiva para um workspace
Authorizations
For more details, see Authentication v2
Parameters
Query Parameters
"fc31805a-9ac5-423b-b3cb-b626c769b27c""uuid"Request Body
Responses
Item adicionado na lista restritiva com sucesso
Remover item da lista restritiva
Remove um registro da lista restritiva por nationalId e workspace
Authorizations
For more details, see Authentication v2
Parameters
Path Parameters
"91439362025"1114Query Parameters
"fc31805a-9ac5-423b-b3cb-b626c769b27c""uuid"Responses
Item removido da lista restritiva com sucesso