Onboarding

Nossa solução para validação de identidade possui três fluxos diferentes:

Fluxo	Finalidade
Documento	Captura o documento de seu usuário, garante a qualidade da imagem e extrai as informações desejadas.
Prova de Vida	Realiza a captura biométrica com prova de vida.
Completo	Realiza a captura de documento, garante a qualidade da imagem, extrai as informações desejadas, faz a captura biométrica com prova de vida e também efetua a comparação de faces (Face Match).

Compatibilidade

Este produto pode ser facilmente integrado em diversas plataformas e frameworks através de iframes, uma vez que eles são amplamente suportados em ambientes web. Abaixo estão alguns exemplos de onde o iframe pode ser utilizado:

Aplicações Web: Compatível com frameworks modernos como React, Angular, Vue.js, Next.js, Svelte, entre outros.
Aplicações Móveis Híbridas: Em aplicativos construídos com React Native (via WebView), Ionic e Cordova, permitindo integração em ambientes móveis.

Como Usar

1º Passo: Autenticação

Para acessar nossa aplicação é necessário um OnboardingID. Para gerar um, basta realizar um POST na rota https://app.bigdatacorp.com.br/bigid/onboarding/OpenSession. Seu token da BigDataCorp deve ser incluído nos headers da requisição como AccessToken e o body precisa estar estruturado dessa forma:

{ "ClientWebHookKey": "ID_Do_Usuario", "OnboardingType": "ONBOARDING" }

O parâmetro ClientWebHookKey é uma forma de identificar seu usuário final ao fim do fluxo, quando você irá receber o webhook com todas as informações obtidas. Já o OnboardingTypeé o que determina qual fluxo você deseja que seu usuário final realize.

Fluxo	Parâmetro
Documento	DOCUMENTOSCOPY
Prova de Vida	LIVENESS
Completo	ONBOARDING

Essa requisição HTTP irá retornar, entre outras coisas, o OnboardingID.

2º Passo: Inicialização

Com o OnboardingID em mãos, basta utilizar a seguinte URL em seu iframe ou webview:

https://iframe.bigdatacorp.com.br/onboardingID

Exemplo: https://iframe.bigdatacorp.com.br/0e2701ff-927a-4abc-84e9-026121dc7cfe

3º Passo: Finalização

Quando o usuário finalizar o fluxo, você será notificado via Post Message do componente web que está utilizando.

Parâmetro	Explicação
STATUS_CODE	Status interno utilizado para reconhecer o que aconteceu com a aplicação.
MESSAGE	Mensagem com uma breve descrição sobre o acontecido.
ON_FINISH	Informa se o componente web deve ser encerrado ou não.

STATUS_CODE	MESSAGE	ON_FINISH
`2`	`Ok`	`true`
`-100`	`Access Denied`	`true`
`-201`	`TimeOut`	`true`
`-202`	`Max retries`	`true`
`-298`	`Invalid Request`	`true`
`-299`	`Unexpected`	`true`
`400`	`Closed without completing`	`true`
`500`	`Internal Error`	`true`

Exemplo em React

import React from "react";

interface IData {
  STATUS_CODE: number;
  MESSAGE: string;
  ON_FINISH: boolean;
}

function App() {
  const [open, setOpen] = React.useState<boolean>(false);
  const iFrameURL = `https://iframe.bigdatacorp.com.br/${ONBOARDING_ID}`;

  const [data, setData] = React.useState<IData>({
    STATUS_CODE: 0,
    MESSAGE: "",
    ON_FINISH: false,
  });

  // Evento responsável por escutar o retorno que será dado de nossa aplicação
  window.addEventListener("message", function (e) {
    setData(e.data);

    if (e.data.ON_FINISH) setOpen(false);
  });

  //Um evento o qual irá ser responsável por carregar nosso IFrame
  if (!open) {
    return (
      <>
        <Button onClick={() => setOpen(true)}>Fazer onboarding</Button>
      </>
    );
  }

  //Uso do IFrame
  return (
    <>
      <iframe
        src={iFrameURL}
        allow="camera"
        className="w-dvw h-dvh"
      />
    </>
  );
}

export default App;