Links de Onboarding

API de criação e atualização de links de onboarding.

Criar um link

POST

https://api.combateafraude.com/reports/<REPORT_ID>/onboarding-ext?token=<ACCESS_TOKEN>

Header

Identificador	Valor
Content-type	application/json

Path

Identificador	Tipo	Descrição
REPORT_ID	String	Identificador do relatório que será utilizado como base para o processamento dos dados enviados

Query

Identificador	Descrição
ACCESS_TOKEN	Token de acesso

Body

Identificador	Tipo	Descrição
cpf	String	Opcional. CPF da pessoa que irá realizar o onboarding.
noExpire¹	Boolean	Configuração de limite de envios. Quando true, o link aceitará múltiplas utilizações. Default false
email	String	Opcional. Se informado, enviaremos um e-mail com o link e instruções de uso.
smsPhoneNumber	String	Opcional. Se informado, enviaremos um SMS com o link e instruções de uso.
variables	Object	Opcional. Objeto que você pode adiconar atributos auxiliadores. (Limite: 20 atributos)
variables.auxiliary	Object	Opcional. Atributo de exemplo.

[¹]: um link que não expira (noExpire = true) aceitará envios até que seja desabilitado. Por esse motivo, recomenda-se que seja utilizado apenas em fluxos controlados a fim de evitar que seja exposto publicamente de forma indevida.

Atualizar um link

PATCH

https://api.combateafraude.com/reports/<REPORT_ID>/onboarding-ext/<ONBOARDING_ID>?token=<ACCESS_TOKEN>

Header

Identificador	Valor
Content-type	application/json

Path

Identificador	Tipo	Descrição
REPORT_ID	String	Identificador do relatório que será utilizado como base para o processamento dos dados enviados
ONBOARDING_ID	String	Identificador do onboarding ou seu token

Query

Identificador	Descrição
ACCESS_TOKEN	Token de acesso

Body

Identificador	Tipo	Descrição
active	Boolean	Ativar ou desativar link de onboarding.

Integração em WebView e IFrame

WebView

• Android: Nas integrações do onboarding web em WebView no Android é necessário definir a configuração setDomStorageEnabled da WebView para true para o funcionamento correto do onboarding. Ex.: myWebView.getSettings().setDomStorageEnabled(true);
• Outras plataformas: Nas demais plataformas (IOS, Flutter, React Native, etc.) a criação da WebView não depende de nenhuma configuração específica.

IFrame

Para integrar o onboarding dentro de um IFrame pode ser usado o código de exemplo abaixo, é necessário somente dar permissão de acesso à câmera do dispositivo no atributo allow.

<iframe src="https://cadastro.io/:token" allow="camera"></iframe>

Outro ponto de atenção é que nosso onboarding não irá funcionar dentro de um IFrame caso o usuário tenha habilitado em seu navagador a configuração Bloquear cookies de terceiros. Essa configuração é mais comum em casos aonde o usuário acessa a página a partir de uma aba anônima.

Eventos Emitidos

Nosso onboarding emite eventos utlizando o window.postMessage() para comunicar o iframe ou webview de alguns acontecimentos durante o processo. Atualmente temos suporte dos eventos para IFrame, Flutter* e React Native.

Os eventos emitidos hoje são os seguintes:

• SDK_CAPTURE_INVALID: Será disparado quando a captura for inválida, como um documento incorreto ou baixa qualidade da imagem. (Document Detector e Passive Face Liveness)
• SDK_CAPTURE_FAILED: Alguma outra falha na captura. (Document Detector e Passive Face Liveness)
• SDK_BACK_CAPTURE_STARTED: Iniciou captura do verso do documento. (Document Detector)
• SDK_FRONT_CAPTURE_STARTED: Iniciou captura da frente do documento. (Document Detector)

*Flutter

No Flutter deve ser usado o recurso Web Message Listeners do Flutter InAppWebView, sendo passado no campo jsObjectName o valor FlutterOnboardingChannel.