Como Usar
Para utilizar nosso sistema onboarding é necessário primeiramente abrir uma sessão. A abertura de sessão gera um OnboardingID que serve como chave de autenticação para as chamadas subsequentes à solução de validação de identidade. 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": "USER_ID", "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 |
|---|---|
| Completo (todas as etapas de validação de Identidade) | ONBOARDING |
| Apenas Documentoscopia | DOCUMENTOSCOPY |
| Apenas Prova de Vida (Liveness) | LIVENESS |
Parâmetros Opcionais
Endereços Diferentes de Callback (Webhook)
Configurando
Caso deseje, podem ser configurados múltiplos endereços de callback na sua conta. Isso fará com que o webhook envie o resultado do onboarding para endereços que você escolher na criação do OnboardingID. Você pode, por exemplo, configurar endereços diferentes para suas utilizações em ambientes diversos (Dev, Homolog, UAT, PROD). Para configurar envie um email para [email protected] passando uma lista de "chave | valor", onde a chave é uma pequena string que identifica cada endereço de callback. As URLs dos endereços devem ser passadas no "valor".
Exemplo:
| Chave | Parâmetro |
|---|---|
| "DEV" | htttp://SEU_ENDERECO_DE_DEV |
| "HOMOLOG" | htttp://SEU_ENDERECO_DE_HOMOLOG |
| "PROD" | htttp://SEU_ENDERECO_DE_PROD |
Você também deve definir um desses endereços para ser o "default", para isso basta avisar no email qual deles você quer que seja. O endereço default será utilizado pela nossa ferramenta para enviar o callback quando nenhum endereço específico for enviado na chamada de criação do OnboardingID.
Utilizando
Para utilizar esse parâmetro você deve passar no body da requisição o campo PostBackEnv preenchido com uma chave dentre as que você configurou previamente, contendo o endereço que você deseja receber a callback deste processo de onboarding específico.
{ "PostBackEnv": "HOMOLOG", "ClientWebHookKey": "USER_ID", "OnboardingType": "ONBOARDING" }