Developers

Aparência

Vai integrar a API REST da Zarv 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 REST da Zarv. Use a documentação oficial como fonte da verdade.

- Página desta integração: https://developers.zarv.com/api/smartflow/getFacematchLink
- Autenticação Bearer JWT e hosts: https://developers.zarv.com/setup
- Índice das APIs: https://developers.zarv.com/api
- Í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

Os specs OpenAPI publicados são a fonte da verdade para rotas e schemas — use o spec da API que você escolher antes de escrever qualquer request.

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.: escolher a API certa e fazer a primeira chamada autenticada]

Obter link de facematch​

GET
/api/v1/smartflow/leads/{id}/facematch-link

Quando o próximo passo é facematch, retorna o envelope padrão com handoffUrl: um link hospedado de captura (não é iframe nem SDK) para enviar ao usuário. A captura ocorre no dispositivo dele (câmera) e a conclusão é sinalizada de forma assíncrona pelo webhook lead.face.completed; depois disso, retome o fluxo.

Authorizations​

Authentication v2

For more details, see Authentication v2

Type
HTTP (bearer)

Parameters​

Path Parameters

id*

Identificador do lead (leadId).

Type
string
Required

Responses​

Envelope com o link de captura.

application/json
JSON
{
  
"leadId": "lead_01HZX",
  
"status": "in_progress",
  
"step": "email",
  
"nextStep": "phone",
  
"nextStepUrl": "/api/v1/smartflow/leads/lead_01HZX/phone",
  
"progress": 40,
  
"finished": false,
  
"handoffUrl": "string"
}

Playground​

Authorization
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI