Skip to main content

Documentation Index

Fetch the complete documentation index at: https://developers.gyramais.com.br/llms.txt

Use this file to discover all available pages before exploring further.

Resumo: a aba Solicitações é o lugar onde você dispara fluxos que exigem o envolvimento direto do cliente final — opt-in de SCR (autorização para a GYRA+ consultar o SCR do Banco Central em nome dele) e Face Match com liveness (validação de identidade em onboarding). As duas rodam via WhatsApp e ficam listadas aqui com status em tempo real.

​
Onde fica

Menu lateral, Solicitações. A listagem mostra todos os clientes já solicitados, documento, tipo de solicitação, status e ações. Dois botões principais no topo direito:
  • Criar solicitação, dispara o fluxo pelo WhatsApp do cliente.
  • Autorizar cliente, registra uma autorização que você já coletou fora da plataforma.

​
Criar solicitação

1

Clicar em Criar solicitação

Abre o formulário de nova solicitação.
2

Preencher os dados do cliente

  • Documento (CPF).
  • Nome completo.
  • Telefone (WhatsApp do cliente — é por onde ele vai receber o fluxo).
  • E-mail.
  • Tipo, SCR ou Face Match.
3

Criar

Ao confirmar, o cliente recebe automaticamente uma mensagem no WhatsApp com o link para seguir o fluxo. O status da solicitação aparece na listagem e atualiza em tempo real conforme o cliente avança.

​
Tipo SCR: opt-in para consulta do Banco Central

A consulta SCR (Sistema de Informações de Crédito do Banco Central) exige autorização formal do titular. O fluxo pelo WhatsApp resolve isso ponta a ponta:
  1. Cliente recebe a mensagem com o link.
  2. Valida a identidade via confirmação de e-mail; se não for possível, cai automaticamente para Face Match com liveness.
  3. Assina o documento de autorização para consulta ao SCR.
  4. A solicitação passa para status autorizado na listagem.
A partir desse momento, a sua organização está liberada para consultar os dados de SCR daquele cliente em qualquer análise na GYRA+ (inclusive via POST /v2/report com política que tenha SCR habilitado). A autorização fica registrada para fins de auditoria.

​
Tipo Face Match: validação de identidade em onboarding

Usado em fluxos de onboarding para confirmar que o cliente é quem diz ser, sem exigir presença física.
  1. Cliente recebe a mensagem com o link.
  2. Captura do documento (RG ou CNH).
  3. Face Match com prova de vida (liveness).
  4. A plataforma responde se a identidade foi validada ou não — o resultado fica visível na listagem.

​
Autorizar cliente

Botão Autorizar Cliente no topo da listagem. Use quando você já coletou a autorização formal do cliente fora da plataforma (contrato físico, assinatura eletrônica própria, consentimento registrado no seu fluxo) e só precisa registrar isso na GYRA+ para habilitar a consulta.
Periodicamente a GYRA+ audita as autorizações registradas por esse caminho para confirmar que foram coletadas corretamente e em conformidade com a legislação aplicável (LGPD, Resolução Bacen sobre SCR, etc.). Use somente com autorização formal, documentada e revogável pelo titular a qualquer momento.

​
Listagem e acompanhamento

Toda solicitação criada fica na aba Solicitações, com:
  • Documento e nome do cliente.
  • Tipo (SCR ou Face Match).
  • Ícone de status por tipo (indicando pendente, autorizado, falhou).
  • Ações por linha (reenviar, reabrir detalhes, duplicar).
Use os filtros Ativo e Filtro no topo da listagem para restringir a visão (ex: só solicitações pendentes de opt-in SCR).

​
Perguntas frequentes

O link enviado via WhatsApp não tem expiração dura, mas recomendamos reengajar o cliente se ele não responder em 24-48h. Na listagem, a ação reenviar dispara nova mensagem.
SCR é por CPF. Para CNPJ, a consulta SCR precisa do opt-in dos sócios relevantes, não da empresa em si.
Sim. O titular pode revogar a qualquer momento. Em caso de revogação, a consulta deixa de ser permitida a partir daí. Consultas anteriores continuam válidas e auditáveis.
Captura suporta RG e CNH. O liveness valida que é pessoa real presente na hora, não foto estática.
Vale enquanto o titular não revogar. Recomendamos revalidar periodicamente em operações de relacionamento de longo prazo.
Você fica exposto a sanção regulatória e risco reputacional. A GYRA+ audita amostras e pode suspender o acesso à feature em caso de irregularidade confirmada. Use só com autorização formal, documentada.

​
Próximos passos

SCR (conceito e dado)

O que o SCR entrega depois que a autorização sai.

Rodar uma Análise

Usar a autorização em uma análise de crédito.

Interpretar Resultado

Ler o relatório com a seção SCR populada.

Usuários e Permissões

Quem pode criar e autorizar solicitações.