Webhook Background Check

Após a conclusão de todos os serviços solicitados na requisição de background check, o webhook envia automaticamente os resultados para a URL cadastrada pela entidade. Veja a documentação que preparamos e saiba como realizar a implementação desse módulo.

Modelo de Chamada

Response:

POST apiurl/webhook HTTP/1.1
Content-Type: application/json
x-api-key: CJY1srRgcyTVa4BiNaQFYjzaBDifqrnDH0njy0tK5KI
{
    "transactionId": "e2c8ca6f-5ba1-4a18-902b-08da05e9e5a5",
    "backgroundCheckId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "status": "Completed",
    "results": [
        {
            "service": "BasicInfos",
            "status": "Completed",
            "response": {
                "cpf": "000.000.000-00",
                "civilName": "NOME COMPLETO",
                "rg": "0.000.000-0",
                "issuingAgency": "SSP",
                "gender": "M",
                "birthDate": "1961-08-19",
                "age": 60,
                "employment": "Developer",
                "mothersName": "NOME COMPLETO DA MÃE",
                "nationality": "Brasileiro",
                "placeOfBirth": "Sao Paulo",
                "maritalStatus": "Casado",
                "addresses": [
                    {
                        "street": "R DO ENDEREÇO",
                        "type": "",
                        "number": "1000",
                        "complement": "CPL 1",
                        "zipcode": "11111-111",
                        "county": "CENTRO",
                        "city": "CIDADE",
                        "state": "ST"
                    },
                    {
                        "street": "R DO ENDEREÇO",
                        "type": "",
                        "number": "1000",
                        "complement": "CPL 1",
                        "zipcode": "11111-111",
                        "county": "CENTRO",
                        "city": "CIDADE",
                        "state": "ST"
                    }
                ],
                "phones": [
                    {
                        "areaCode": "11",
                        "number": "99999-9999"
                    },
                    {
                        "areaCode": "21",
                        "number": "99999-9999"
                    }                    
                ],
                "emails": [
                    {
                        "email": "[email protected]"
                    },
                    {
                        "email": "[email protected]"
                    }
                ]
            }
        },
        {
            "service": "ReceitaFederal",
            "status": "Completed",
            "response": {
               "cpf": "000.000.000-00",
               "civilName": "Full Name",
               "birthDate": "1961-08-19",
               "cadastralSituation": "Regular",
               "date": "2022-02-21",
               "hour": "15:31:19"
            }
        },
        {
            "service": "RegistrationCheck",
            "status": "Completed",
            "response": {
                "cpf": "123.456.789-00",
                "birthDate": "1961-08-19",
                "cpfDoesNotExist": false,
                "isBirthDateDivergent": false,
                "rules": {
                    "isCpfIrregular": true,
                    "cpfIrregularReason": "",
                    "hasDeathIndication": false,
                    "isYoungerThanThirteen": false,
                    "isYoungerThanSixteen": false,
                    "isYoungerThanEighteen": false,
                    "betweenThirteenAndSixteen": false
                }
            }
        }
    ]
}