Developers

Aparência

Vai integrar a API do Zarv ID v2 com ajuda de IA? Copie a instrução que aponta o modelo para esta documentação.
Ver a instrução
Você vai integrar a API do Zarv ID v2. Use a documentação oficial como fonte da verdade.

- Página desta integração: https://developers.zarv.com/api/id-v2/listProfiles
- Spec OpenAPI (fonte da verdade para rotas e schemas): https://developers.zarv.com/openapi/id-v2-api.json
- Autenticação: https://developers.zarv.com/api/id-v2/authentication
- Webhook de verificação: https://developers.zarv.com/api/id-v2/webhook
- Índice da documentação em markdown: https://developers.zarv.com/llms.txt
- Documentação completa em um arquivo: https://developers.zarv.com/llms-full.txt

O spec OpenAPI acima é a fonte da verdade para rotas, parâmetros e schemas — confira nele antes de escrever qualquer request. A decisão final chega por webhook, não pela resposta da chamada que cria a verificação.

Antes de escrever qualquer código, leia a página desta integração. Siga exatamente os nomes de campos, endpoints, callbacks e formatos que estiverem documentados — não invente parâmetros nem endpoints, e não deduza comportamento a partir de outras APIs que você conhece. Se algo de que você precisa não estiver na documentação, diga que não está em vez de supor.

Minha tarefa: [ex.: enviar uma verificação e consumir o webhook de conclusão]

Listar perfis​

GET
/api/v3/profiles

Os perfis ativos do seu workspace. 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 profile.id (o profileId da verificação), o nome, o tipo, a entidade que o perfil atende (person para CPF, company para CNPJ) e os módulos habilitados. A lista não é paginada.

A rota fica em /api/v3/profiles e usa o mesmo token Bearer das rotas /api/v2.

Authorizations​

Authentication v2

For more details, see Authentication v2

Type
HTTP (bearer)

Parameters​

Query Parameters

kind

Só perfis deste tipo. Use verification para ver os perfis que rodam uma verificação. Sem o parâmetro, lista todos os tipos.

Type
string
Valid values
"enrichment""verification"
Example"verification"

Responses​

Os perfis do workspace.

application/json
JSON
{
  
"items": [
  
  
{
  
  
  
"entity": "string",
  
  
  
"modules": {
  
  
  
  
"additionalProperties": {
  
  
  
  
  
"dataset": "string",
  
  
  
  
  
"network": {
  
  
  
  
  
  
"dataset": "string"
  
  
  
  
  
}
  
  
  
  
}
  
  
  
},
  
  
  
"profile": {
  
  
  
  
"id": "string",
  
  
  
  
"kind": "string",
  
  
  
  
"name": "string"
  
  
  
}
  
  
}
  
]
}

Playground​

Authorization
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI