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 Person:
POST apiurl/webhook HTTP/1.1
Content-Type: application/json
x-api-key: string
{
"transactionId": "e2c8ca6f-5ba1-4a18-902b-08da05e9e5a5",
"backgroundCheckId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"status": "Completed",
"results": [
{
"service": "ReceitaFederal",
"status": "Completed",
"response": {
"document": "string",
"fullName": "string",
"birthDate": "string (date)",
"cadastralSituation": "string",
"date": "string (date)",
"hour": "string (time)",
}
},
{
"service": "BasicInfos",
"status": "Completed",
"response": {
"document": "string",
"minor": "boolean",
"fullName": "string",
"birthDate": "string (date)",
"age": "number",
"motherName": "string",
"emails": [
{
"email": "string"
}
],
"gender": "string",
"rg": "string",
"issuingAgency": "string",
"profession": "string",
"presumedIncome": "string",
"nationality": "string",
"placeOfBirth": "string",
"maritalStatus": "string",
"additionalInformations": "string (json)",
"addresses": [
{
"street": "string",
"number": "string",
"city": "string",
"state": "string",
"district": "string",
"zipcode": "string",
"complement": "string"
}
],
"phones": [
{
"areaCode": "string",
"number": "string"
}
],
"connectedCompanies": [
{
"document": "string",
"businessName": "string"
}
]
}
},
{
"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
}
}
}
]
}Response Company:
POST apiurl/webhook HTTP/1.1
Content-Type: application/json
x-api-key: string
{
"backgroundCheckId": "string (UUID)",
"transactionId": "string (UUID)",
"status": "string",
"results": [
{
"service": "ReceitaFederal",
"status": "Completed",
"response": {
"document": "string",
"businessName": "string",
"fantasyName": "string",
"cadastralSituation": "string",
"foundationDate": "string (date)",
"companySize": "string",
"companyType": "string",
"legalNature": "string",
"date": "string (date)",
"hour": "string (time"
}
},
{
"service": "BasicInfos",
"status": "Completed",
"response": {
"document": "string",
"fantasyName": "string",
"businessName": "string",
"emails": [
"string"
],
"addresses": [
{
"type": "Rua",
"street": "string",
"number": "string",
"city": "string",
"state": "string",
"district": "string",
"zipcode": "string",
"complement": "string"
}
],
"phones": [
{
"areaCode": "string",
"number": "string",
"type": "string"
}
],
"simplesNacional": {
"status": "string",
"consultationDate": "string (date)",
"simpleOption": "string (date)",
"statusSimei": "string",
"simeiOptionDate": "string (date)"
},
"cnae": {
"code": "string",
"segment": "string",
"description": "string",
"secondary": [
{
"code": "string",
"description": "string"
}
]
},
"sintegra": {
"registration": "string",
"situation": "string",
"uf": "string",
"economicActivity": "string",
"secondaryActivity": "string (number)",
"consultationDateStandardized": "string (date)"
}
}
}
]
}