Webhook

Ao final do processo de onboarding um webhook é enviado para o endereço cadastrado diretamente dos nossos servidores para o servidor do cliente sem nunca passar pelo aparelho do usuário final, garantindo maior segurança.

Caso o endereço cadastrado não seja encontrado ou recuse o envio do retorno, este também pode ser obtido através do endpoint de recuperação de respostas.

O conteúdo da resposta varia de acordo com o tipo de onboarding realizado (completo, liveness ou documentoscopia). Seguem abaixo uma descrição de cada campo retornado, bem como o formato de retorno por tipo de onboarding.

Descrição dos campos do retorno:

Campo	Descrição
DocumentoscopyResult	Se trata do retorno da API de documentoscopia cujo o conteúdo esta melhor descrito na documentação da API de Documentoscopia. É importante ressaltar que, para onboarding com duas imagens de documento (frente e verso) o dados extraídos de cada face do documento são agregados neste objeto.
DocumentQualityResult	Se trata do retorno da API de qualidade de imagem cujo o conteúdo esta melhor descrito na documentação da API de Qualidade de Imagens de Documentos, referente a primeira imagem obtida pelo processo.
DocumentQualityResult2 (opcional)	Se trata do retorno da API de qualidade de imagem cujo o conteúdo esta melhor descrito na documentação da API de Qualidade de Imagens de Documentos , referente a segunda imagem obtida pelo processo.
FaceMatchResult	Se trata do retorno da API de Biometria Facial 1x1, cujo o conteúdo esta melhor descrito na documentação da API de Biometria Facial 1x1 , referente a comparação da face obtida durante o processo de prova de vida e a face contida na imagem do documento de identificação.
LivenessResult	Resultado do processo de prova de vida: - Score - valor percentual que indica o grau de confiança da imagem ser de uma pessoa real e não a foto de uma foto, ou de um cartaz, etc. - Threshold - valor percentual sugerido utilizado como limiar decisória para aceitação do resultado. - Status - pode assumir os seguintes valores: - "live_person" - quando o score é maior ou igual ao Threshold - "failed" - quando o score é menor que o Threshold - "not_available" - significa que a atividade nem sequer foi avaliada
ClientWebHookKey	Chave enviada pelo cliente durante a abertura de sessão, deve ser utilizada para fins de rastreamento.
OnboardingId	Chave do processo de onboarding como um todo, de suma importância para que possamos identificar o que ocorreu durante o processo em questão. Deve sempre ser enviada em casa de abertura de tickets.
LivenessImage	Imagem obtida durante o processo de prova de vida, odificada em base64 e em formato jpeg
DocImage	Primeira imagem obtida durante o processo de documentoscopia, em formato jpeg codificado para base64.
DocImage2 (opcional)	Segunda imagem obtida durante o processo de documentoscopia, em formato jpeg codificado para base64.

Onboarding Completo (ONBOARDING)

Essa é a modalidade que possui mais informação e, a depender da configuração de tipo de detecção de documento escolhida (documento aberto apenas, automático ou documento dobrado apenas) o conteúdo do corpo da mensagem pode mudar para incluir os retornos referentes a segunda imagem do documento.

{
    "DocumentoscopyResult": {
        "DocInfo": {
            "BIRTHDATE": "XX/XX/XXXX",
            "CPF": "XXXXXXXX",
            "DOCTYPE": "CNH",
            "FATHERNAME": "XXXXXXXXXX",
            "IDENTIFICATIONUF": "RJ",
            "MOTHERNAME": "XXXXXXX",
            "NAME": "XXXXXXX",
            "ORGEMISSION": "XXX",
            "SIDE": "A",
            "VALIDDATE": "XX/12/2018"
        },
        "OfficialInfo": {
            "BIRTHDATEMATCH": "1",
            "MOTHERNAMEMATCHPERCENTAGE": "1",
            "NAMEMATCHPERCENTAGE": "0.33",
            "OFFICIALBIRTHDATE": "2000-10-10",
            "OFFICIALMOTHERNAME": "MAE FULANO",
            "OFFICIALNAME": "FULANO DA SILVA"
        },
        "ForensicValidations": {
            "-925": "Identical image previously submited."
        },
        "EstimatedInfo": {
            "ESTIMATED_AGE": "(25-32)",
            "GENDER": "MALE"
        },
        "TicketId": "66d09f5e3ea0750e70630523",
        "ResultCode": 70,
        "ResultMessage": "Found info"
    },
    "DocumentQualityResult": {
        "TypeOfDocument": null,
        "ImageDistanceOk": true,
        "ProportionalDocumentArea": 77.2124348427231,
        "BlackAndWhite": false,
        "BlackAndWhiteRatio": null,
        "ImageIsBig": false,
        "OverSizedImage": false,
        "DownSizedImage": false,
        "PoorImage": false,
        "ContainsFace": true,
        "Brightness": 0.31,
        "Sharpness": 554.62,
        "Contrast": 0.6,
        "Width": 1280.0,
        "Height": 720.0,
        "ImageSizeInKB": 159.0,
        "ImageFormat": "Jpeg",
        "Ratio": "16:9",
        "Validation_Feedback": [],
        "TicketId": "66d09f5b4e56995f1cc76487",
        "ResultCode": 61,
        "ResultMessage": "Success"
    },
    "DocumentQualityResult2": {
        "ImageDistanceOk": true,
        "ProportionalDocumentArea": 77.2124348427231,
        "BlackAndWhite": false,
        "ImageIsBig": false,
        "OverSizedImage": false,
        "DownSizedImage": false,
        "PoorImage": false,
        "ContainsFace": true,
        "Brightness": 0.31,
        "Sharpness": 554.62,
        "Contrast": 0.6,
        "Width": 1280.0,
        "Height": 720.0,
        "ImageSizeInKB": 159.0,
        "ImageFormat": "Jpeg",
        "Ratio": "16:9",
        "Validation_Feedback": [],
        "TicketId": "66d09f5b4e56995f1cc76487",
        "ResultCode": 61,
        "ResultMessage": "Success"
    },
    "FaceMatchResult": {
        "EstimatedInfo": {
            "Similarity": "8.866699"
        },
        "Questions": [],
        "TicketId": "66d0ba15ac2f749d9cc1f1e3",
        "ResultCode": -800,
        "ResultMessage": "The face pictures does not match"
    },
    "LivenessResult": {
        "Score": 0.8,
        "Threshold": 0.75,
        "Status": "live_person"
    },
    "ClientWebHookKey": "ClientWebHookKey",
    "OnboardingId": "c9189a82-8e25-4a16-beb8-babdb48d72be",
    "LivenessImage": "iVBORw0...",
    "DocImage": "iVBORw0...",
    "DocImage2": "iVBORw0..."
}

Prova de Vida (LIVENESS)

{
    "LivenessResult": {
        "Score": 0.8,
        "Threshold": 0.75,
        "Status": "live_person"
    },
    "ClientWebHookKey": "ClientWebHookKey",
    "OnboardingId": "c9189a82-8e25-4a16-beb8-babdb48d72be",
    "LivenessImage": "iVBORw0..."
}

Documentoscopia (DOCUMENTOSCOPY)

{
    "DocumentoscopyResult": {
        "DocInfo": {
            "BIRTHDATE": "XX/XX/XXXX",
            "CPF": "XXXXXXXX",
            "DOCTYPE": "CNH",
            "FATHERNAME": "XXXXXXXXXX",
            "IDENTIFICATIONUF": "RJ",
            "MOTHERNAME": "XXXXXXX",
            "NAME": "XXXXXXX",
            "ORGEMISSION": "XXX",
            "SIDE": "A",
            "VALIDDATE": "XX/12/2018"
        },
        "OfficialInfo": {
            "BIRTHDATEMATCH": "1",
            "MOTHERNAMEMATCHPERCENTAGE": "1",
            "NAMEMATCHPERCENTAGE": "0.33",
            "OFFICIALBIRTHDATE": "2000-10-10",
            "OFFICIALMOTHERNAME": "MAE FULANO",
            "OFFICIALNAME": "FULANO DA SILVA"
        },
        "ForensicValidations": {
            "-925": "Identical image previously submited."
        },
        "EstimatedInfo": {
            "ESTIMATED_AGE": "(25-32)",
            "GENDER": "MALE"
        },
        "TicketId": "66d09f5e3ea0750e70630523",
        "ResultCode": 70,
        "ResultMessage": "Found info"
    },
    "DocumentQualityResult": {
        "TypeOfDocument": null,
        "ImageDistanceOk": true,
        "ProportionalDocumentArea": 77.2124348427231,
        "BlackAndWhite": false,
        "BlackAndWhiteRatio": null,
        "ImageIsBig": false,
        "OverSizedImage": false,
        "DownSizedImage": false,
        "PoorImage": false,
        "ContainsFace": true,
        "Brightness": 0.31,
        "Sharpness": 554.62,
        "Contrast": 0.6,
        "Width": 1280.0,
        "Height": 720.0,
        "ImageSizeInKB": 159.0,
        "ImageFormat": "Jpeg",
        "Ratio": "16:9",
        "Validation_Feedback": [],
        "TicketId": "66d09f5b4e56995f1cc76487",
        "ResultCode": 61,
        "ResultMessage": "Success"
    },
    "DocumentQualityResult2": {
        "ImageDistanceOk": true,
        "ProportionalDocumentArea": 77.2124348427231,
        "BlackAndWhite": false,
        "ImageIsBig": false,
        "OverSizedImage": false,
        "DownSizedImage": false,
        "PoorImage": false,
        "ContainsFace": true,
        "Brightness": 0.31,
        "Sharpness": 554.62,
        "Contrast": 0.6,
        "Width": 1280.0,
        "Height": 720.0,
        "ImageSizeInKB": 159.0,
        "ImageFormat": "Jpeg",
        "Ratio": "16:9",
        "Validation_Feedback": [],
        "TicketId": "66d09f5b4e56995f1cc76487",
        "ResultCode": 61,
        "ResultMessage": "Success"
    }
    "ClientWebHookKey": "ClientWebHookKey",
    "OnboardingId": "c9189a82-8e25-4a16-beb8-babdb48d72be",
    "DocImage": "iVBORw0...",
    "DocImage2": "iVBORw0..."
}