Skip to main content
GET
Obter mídia da validação KYC

Resumo

Quando uma validação KYC por sessão termina (ex.: approved), referências a mídia aparecem em decision na resposta de GET /api/kyc/validations/:id (imagens do documento, retrato, vídeo de liveness, etc.). Formato usual: cada referência é uma chave kyc/... (string de caminho). Para baixar os bytes, use o endpoint de mídia abaixo com sua API key. Formato de decision: resultados aparecem como objeto singular e array de um elemento (ex.: id_verification e id_verifications[0]). O Gu1 mantém ambos sincronizados. Veja Eventos webhook KYC para um exemplo completo. Se a cópia ainda não terminou: o campo fica null. A resposta não inclui um link externo. Um sync ou webhook posterior tenta a cópia de novo. Quando termina, o campo vira uma chave kyc/.... Esta página é para o KYC completo por sessão (global_gueno_validation_kyc). Face Match e ID Verification usam outros endpoints (barra lateral).

Mídia que ainda não está na Gu1

  • O resto do decision permanece: só o campo daquele arquivo fica vazio até a cópia terminar.
  • Chaves kyc/...: use GET /api/kyc/validations/:id/media com key codificada na URL. O acesso fica limitado à sua organização e àquela validação.
  • Campo null: a Gu1 ainda não tem o arquivo. Não use um link externo. A próxima sincronização tenta a cópia de novo.
  • Quando a cópia termina, o mesmo campo passa a ser uma chave kyc/....

Solicitação

Endpoint

Headers

  • Authorization: Bearer SUA_API_KEY (obrigatório)

Query parameters

Permissões

A API key precisa poder ler KYC (kyc:read com permissões granulares; caso contrário, aplica-se o papel do usuário dono da chave, com fallback legado onde couber—igual a GET /api/kyc/validations/:id).

Resposta

Corpo bruto do arquivo. O Content-Type reflete o tipo (ex.: image/jpeg, video/webm).

Exemplo

No código da aplicação, use encodeURIComponent(key) na query.
O parâmetro key não é segredo e não substitui autenticação. Envie sempre Authorization: Bearer válido; a API verifica se a chave do objeto pertence àquela validação e à sua organização.

Relacionado