Webhooks

9 min

Monitore atualizações em seus relatórios de análise de crédito através do seu endpoint de webhook para que sua integração possa reagir automaticamente a essas mudanças.

Por que usar webhooks

Ao integrar com a GYRA+, é crucial que suas aplicações recebam atualizações em tempo real sobre as várias seções dos relatórios de análise de crédito. Isso permite que seus sistemas de backend executem ações conforme as atualizações ocorrem. Para habilitar eventos de webhook, você precisa Criar uma rota de webhook. Após o registro, a GYRA+ pode enviar dados de eventos em tempo real para o endpoint de webhook da sua aplicação sempre que houver atualizações em qualquer seção do relatório de análise de crédito. A GYRA+ utiliza HTTPS para enviar eventos de webhook para sua aplicação como um payload JSON que inclui um objeto Evento.

Receber eventos de webhook é particularmente útil para escutar atualizações assíncronas, como mudanças no status de análise de crédito ou atualizações em seções específicas dos relatórios.

Ao registrar endpoints de webhook na sua conta GYRA+, você permite que a GYRA+ envie automaticamente objetos de dados como parte de requisições POST para o endpoint de webhook registrado hospedado pela sua aplicação. Após seu endpoint de webhook receber o objeto de dados, sua aplicação pode executar ações no backend, como atualizar o status da análise de crédito ou iniciar processos automatizados baseados nos novos dados.

Na geração do relatório é enviado os dados mais recentes disponíveis até que a atualização esteja completa
A cada atualização das informações que a seção possui, é enviado um novo webhook com os dados atualizados

Seção Política de Crédito (CREDIT_POLICY)

Esta seção é especialmente importante, pois traz informações sobre o resultado da política de crédito implementada. O objeto 'policyInfoGeneral' contém as informações gerais do resultado da política de crédito. Este objeto fornece o resultado ('status') final de todas as regras aplicadas durante a análise de crédito, facilitando a visualização do desempenho geral da política implementada.

O exemplo abaixo mostra um payload de evento para uma atualização na seção de Política de Crédito:

{
  "data": {
    "id": "66e1b130fa2b9c561556930d",
    "integrationCount": 0,
    "report": {
      "id": "66e1b130fa2b9c561556930c",
      "document": "44369701000178",
      "organizationId": "6602cba04faa2a9211fb6fa6",
      "type": {
        "id": "6635373fc3d5b420091d806d",
        "createdAt": "2024-05-03T19:13:03.761Z",
        "updatedAt": "2024-05-03T19:17:25.031Z",
        "title": "GYRA360+",
        "value": "CUSTOMER_GYRA_360_PLUS_COMPANY",
        "isPaid": true
      },
      "status": {
        "title": "Aprovado",
        "value": "APPROVED"
      }
    },
    "type": {
      "value": "CREDIT_POLICY",
      "integrationTypes": [
        "CREDIT_POLICY_COMPANY_OPENING_TIME",
        "CREDIT_POLICY_CNAE_RESTRICTIVE",
        "CREDIT_POLICY_REGISTRATION_CHANGES_ADDRESS",
        "CREDIT_POLICY_REGISTRATION_CHANGES_MEMBERSHIP",
        "CREDIT_POLICY_REGISTRATION_CHANGES_CNAES",
        "CREDIT_POLICY_REFIN_LAST_DAYS",
        "CREDIT_POLICY_REFIN_NOT_CALCULATED_REVENUE",
        "CREDIT_POLICY_REFIN_CALCULATED_REVENUE",
        "CREDIT_POLICY_CERTIFICATES_FEDERAL_CERT",
        "CREDIT_POLICY_PEP_DONATIONS",
        "CREDIT_POLICY_PEP_LEVEL",
        "CREDIT_POLICY_SANCTIONS",
        "CREDIT_POLICY_CERTIFICATES_PGFN",
        "CREDIT_POLICY_CERTIFICATES_FGTS",
        "CREDIT_POLICY_CERTIFICATES_ABSENCE_STATE",
        "CREDIT_POLICY_CERTIFICATES_LABOR_ABSENCE",
        "CREDIT_POLICY_NOTARIES_LAST_DAYS",
        "CREDIT_POLICY_NOTARIES_LAST_YEARS",
        "CREDIT_POLICY_NOTARIES_NOT_CALCULATED_REVENUE",
        "CREDIT_POLICY_NOTARIES_CALCULATED_REVENUE",
        "CREDIT_POLICY_LAWSUITS_LABOR",
        "CREDIT_POLICY_LAWSUITS_CIVEL",
        "CREDIT_POLICY_LAWSUITS_CRIMINAL",
        "CREDIT_POLICY_LAWSUITS_TERMS",
        "CREDIT_POLICY_LAWSUITS_NOT_CALCULATED_REVENUE",
        "CREDIT_POLICY_LAWSUITS_CALCULATED_REVENUE",
        "CREDIT_POLICY_BAD_CHECK",
        "CREDIT_POLICY_PEFIN_LAST_DAYS",
        "CREDIT_POLICY_PEFIN_NOT_CALCULATED_REVENUE",
        "CREDIT_POLICY_PEFIN_CALCULATED_REVENUE",
        "CREDIT_POLICY_SCR_TOTAL_LOSSES",
        "CREDIT_POLICY_SCR_NOT_CALCULATED_REVENUE_LATE",
        "CREDIT_POLICY_SCR_NOT_CALCULATED_REVENUE_EXPIRED",
        "CREDIT_POLICY_SCR_CALCULATED_REVENUE_LATE",
        "CREDIT_POLICY_SCR_CALCULATED_REVENUE_EXPIRED",
        "CREDIT_POLICY_SCORE"
      ]
    },
    "sectionDetails": [
      {
        "errors": [],
        "id": "66e1b134fa2b9c5615569326",
        "createdAt": "2024-09-11T15:03:16.689Z",
        "updatedAt": "2024-09-11T15:03:16.689Z",
        "sectionId": "66e1b130fa2b9c561556930d",
        "values": {
          "policyInfoGeneral": {
            "status": "APPROVED",
            "document": "44369701000178",
            "yearMonth": 202409,
            "policyId": "66cf8fa8d4b3748fe9259802"
          },
          "creditPolicyScore": {
            "policyResult": {
              "status": "APPROVED",
              "rulesResults": [
                {
                  "title": "Score - Score Bureau",
                  "description": "",
                  "status": "Aprovado"
                }
              ]
            }
          }
        },
        "integrationTypes": [
          "CREDIT_POLICY_SCORE"
        ]
      },
      {
        "errors": [],
        "id": "66e1b134fa2b9c561556932c",
        "createdAt": "2024-09-11T15:03:16.918Z",
        "updatedAt": "2024-09-11T15:03:16.918Z",
        "sectionId": "66e1b130fa2b9c561556930d",
        "values": {
          "policyInfoGeneral": {
            "status": "APPROVED",
            "document": "44369701000178",
            "yearMonth": 202409,
            "policyId": "66cf8fa8d4b3748fe9259802"
          },
          "creditPolicyCompanyOpeningTime": {
            "policyResult": {
              "status": "APPROVED",
              "rulesResults": [
                {
                  "title": "Dados Cadastrais - Tempo de abertura da empresa em meses",
                  "description": "",
                  "status": "Aprovado"
                }
              ]
            }
          }
        },
        "integrationTypes": [
          "CREDIT_POLICY_COMPANY_OPENING_TIME"
        ]
      }
    ]
  },
  "organizationId": "6602cba04faa2a9211fb6fa6"
}

Outras Seções

Demonstramos abaixo um payload de evento para uma atualização na seção de Certidões.

Modelo de Retorno

{
  "data": {
    "id": "66e1e3b35613ae88b8b536ff",
    "integrationCount": 0,
    "report": {
      "id": "66e1e3b35613ae88b8b536f1",
      "document": "09662563000110",
      "organizationId": "65eb4989a4a87b9a94d1920f",
      "type": {
        "id": "6614758260513064a5af1064",
        "createdAt": "2024-04-08T22:53:54.548Z",
        "updatedAt": "2024-04-24T18:35:03.774Z",
        "title": "GYRA360+",
        "value": "CUSTOMER_GYRA_360_PLUS_COMPANY",
        "isPaid": true
      },
      "status": {
        "title": "Não iniciado",
        "value": "PENDING"
      }
    },
    "type": {
      "value": "BASIC_INFORMATION",
      "integrationTypes": [
        "BDC_COMPANY_BASIC_DATA",
        "BDC_COMPANY_HISTORY_BASIC_DATA",
        "BDC_COMPANY_ECONOMIC_GROUP_RELATIONSHIP",
        "LEMIT"
      ]
    },
    "sectionDetails": [
      {
        "errors": [],
        "id": "66e1e3b45613ae88b8b53700",
        "createdAt": "2024-09-11T18:38:44.447Z",
        "updatedAt": "2024-09-11T18:38:44.447Z",
        "sectionId": "66e1e3b35613ae88b8b536ff",
        "values": {
          "lemitPrimaryAddress": "R  ADEMAR BOMBO, 380 - PORTAO 1 2 E 3 - DISTRITO INDUSTRIAL, MOGI-GUACU - SP, 13849-224",
          "lemitPrimaryPhoneNumber": "(19) 99785-3525",
          "lemitPrimaryEmail": "[email protected]",
          "lemitProfession": "-",
          "lemitSecondaryContacts": [
            {
              "contactType": "Email",
              "contact": "[email protected]"
            },
            {
              "contactType": "Email",
              "contact": "[email protected]"
            },
            {
              "contactType": "Telefone",
              "contact": "(19) 99608-6166"
            },
            {
              "contactType": "Telefone",
              "contact": "(19) 99883-1747"
            },
            {
              "contactType": "Telefone",
              "contact": "(19) 99739-3514"
            },
            {
              "contactType": "Telefone",
              "contact": "(19) 99910-7542"
            },
            {
              "contactType": "Telefone",
              "contact": "(19) 3851-3080"
            },
            {
              "contactType": "Telefone",
              "contact": "(11) 3841-4100"
            }
          ],
          "deceased": "Não",
          "cPFSituation": ""
        },
        "integrationTypes": [
          "LEMIT"
        ]
      },
      {
        "errors": [],
        "id": "66e1e3b45613ae88b8b53703",
        "createdAt": "2024-09-11T18:38:44.883Z",
        "updatedAt": "2024-09-11T18:38:44.883Z",
        "sectionId": "66e1e3b35613ae88b8b536ff",
        "values": {
          "historyData": {
            "id": "202409-09662563000110",
            "createdAt": "2024-09-11T18:38:44.694Z",
            "updatedAt": "2024-09-11T18:38:44.694Z",
            "document": "09662563000110",
            "yearMonth": 202409,
            "company": {
              "historyNames": [
                {
                  "id": "66e1e3b4e5607af9ada551a7",
                  "createdAt": "2024-09-11T18:38:44.760Z",
                  "updatedAt": "2024-09-11T18:38:44.760Z",
                  "bDCCompanyId": "202409-09662563000110",
                  "name": "ASW BRASIL TECNOLOGIA EM PLASTICOS LTDA",
                  "tradeName": "",
                  "officialName": "ASW BRASIL TECNOLOGIA EM PLASTICOS LTDA",
                  "changeDate": "2019-08-01T00:00:00.000Z"
                }
              ],
              "historyActivities": [
                {
                  "id": "66e1e3b4e5607af9ada551ab",
                  "createdAt": "2024-09-11T18:38:44.780Z",
                  "updatedAt": "2024-09-11T18:38:44.780Z",
                  "bDCCompanyId": "202409-09662563000110",
                  "code": "2229399",
                  "docNumber": "00003036000129",
                  "activity": "FABRICACAO DE ARTEFATOS DE MATERIAL PLASTICO PARA OUTROS USOS NAO ESPECIFICADOS ANTERIORMENTE",
                  "economicActivityDivision": "FABRICACAO DE PRODUTOS DE BORRACHA E DE MATERIAL PLASTICO",
                  "economicActivityGroup": "FABRICACAO DE PRODUTOS DE MATERIAL PLASTICO",
                  "isMainEconomicActivity": false,
                  "changeDate": "2019-08-01T00:00:00.000Z"
                },
                {
                  "id": "66e1e3b4e5607af9ada551ac",
                  "createdAt": "2024-09-11T18:38:44.780Z",
                  "updatedAt": "2024-09-11T18:38:44.780Z",
                  "bDCCompanyId": "202409-09662563000110",
                  "code": "2790201",
                  "docNumber": "00024780000100",
                  "activity": "FABRICACAO DE ELETRODOS, CONTATOS E OUTROS ARTIGOS DE CARVAO E GRAFITA PARA USO ELETRICO, ELETROIMAS E ISOLADORES",
                  "economicActivityDivision": "FABRICACAO DE MAQUINAS, APARELHOS E MATERIAIS ELETRICOS",
                  "economicActivityGroup": "FABRICACAO DE EQUIPAMENTOS E APARELHOS ELETRICOS NAO ESPECIFICADOS ANTERIORMENTE",
                  "isMainEconomicActivity": false,
                  "changeDate": "2019-08-01T00:00:00.000Z"
                },
                {
                  "id": "66e1e3b4e5607af9ada551ad",
                  "createdAt": "2024-09-11T18:38:44.780Z",
                  "updatedAt": "2024-09-11T18:38:44.780Z",
                  "bDCCompanyId": "202409-09662563000110",
                  "code": "2790299",
                  "docNumber": "00002776000140",
                  "activity": "FABRICACAO DE OUTROS EQUIPAMENTOS E APARELHOS ELETRICOS NAO ESPECIFICADOS ANTERIORMENTE",
                  "economicActivityDivision": "FABRICACAO DE MAQUINAS, APARELHOS E MATERIAIS ELETRICOS",
                  "economicActivityGroup": "FABRICACAO DE EQUIPAMENTOS E APARELHOS ELETRICOS NAO ESPECIFICADOS ANTERIORMENTE",
                  "isMainEconomicActivity": false,
                  "changeDate": "2019-08-01T00:00:00.000Z"
                },
                {
                  "id": "66e1e3b4e5607af9ada551ae",
                  "createdAt": "2024-09-11T18:38:44.780Z",
                  "updatedAt": "2024-09-11T18:38:44.780Z",
                  "bDCCompanyId": "202409-09662563000110",
                  "code": "2229302",
                  "docNumber": "00002455000146",
                  "activity": "FABRICACAO DE ARTEFATOS DE MATERIAL PLASTICO PARA USOS INDUSTRIAIS",
                  "economicActivityDivision": "FABRICACAO DE PRODUTOS DE BORRACHA E DE MATERIAL PLASTICO",
                  "economicActivityGroup": "FABRICACAO DE PRODUTOS DE MATERIAL PLASTICO",
                  "isMainEconomicActivity": false,
                  "changeDate": "2019-08-01T00:00:00.000Z"
                },
                {
                  "id": "66e1e3b4e5607af9ada551af",
                  "createdAt": "2024-09-11T18:38:44.780Z",
                  "updatedAt": "2024-09-11T18:38:44.780Z",
                  "bDCCompanyId": "202409-09662563000110",
                  "code": "4930201",
                  "docNumber": "00000688000100",
                  "activity": "TRANSPORTE RODOVIARIO DE CARGA, EXCETO PRODUTOS PERIGOSOS E MUDANCAS, MUNICIPAL",
                  "economicActivityDivision": "TRANSPORTE TERRESTRE",
                  "economicActivityGroup": "TRANSPORTE RODOVIARIO DE CARGA",
                  "isMainEconomicActivity": false,
                  "changeDate": "2019-08-01T00:00:00.000Z"
                },
                {
                  "id": "66e1e3b4e5607af9ada551b0",
                  "createdAt": "2024-09-11T18:38:44.780Z",
                  "updatedAt": "2024-09-11T18:38:44.780Z",
                  "bDCCompanyId": "202409-09662563000110",
                  "code": "4930202",
                  "docNumber": "00000917000277",
                  "activity": "TRANSPORTE RODOVIARIO DE CARGA, EXCETO PRODUTOS PERIGOSOS E MUDANCAS, INTERMUNICIPAL, INTERESTADUAL E INTERNACIONAL",
                  "economicActivityDivision": "TRANSPORTE TERRESTRE",
                  "economicActivityGroup": "TRANSPORTE RODOVIARIO DE CARGA",
                  "isMainEconomicActivity": false,
                  "changeDate": "2019-08-01T00:00:00.000Z"
                },
                {
                  "id": "66e1e3b4e5607af9ada551b1",
                  "createdAt": "2024-09-11T18:38:44.780Z",
                  "updatedAt": "2024-09-11T18:38:44.780Z",
                  "bDCCompanyId": "202409-09662563000110",
                  "code": "2221800",
                  "docNumber": "00002479000103",
                  "activity": "FABRICACAO DE LAMINADOS PLANOS E TUBULARES DE MATERIAL PLASTICO",
                  "economicActivityDivision": "FABRICACAO DE PRODUTOS DE BORRACHA E DE MATERIAL PLASTICO",
                  "economicActivityGroup": "FABRICACAO DE PRODUTOS DE MATERIAL PLASTICO",
                  "isMainEconomicActivity": false,
                  "changeDate": "2022-06-01T00:00:00.000Z"
                },
                {
                  "id": "66e1e3b4e5607af9ada551b2",
                  "createdAt": "2024-09-11T18:38:44.780Z",
                  "updatedAt": "2024-09-11T18:38:44.780Z",
                  "bDCCompanyId": "202409-09662563000110",
                  "code": "2319200",
                  "docNumber": "00006386000149",
                  "activity": "FABRICACAO DE ARTIGOS DE VIDRO",
                  "economicActivityDivision": "FABRICACAO DE PRODUTOS DE MINERAIS NAO METALICOS",
                  "economicActivityGroup": "FABRICACAO DE VIDRO E DE PRODUTOS DO VIDRO",
                  "isMainEconomicActivity": false,
                  "changeDate": "2022-06-01T00:00:00.000Z"
                },
                {
                  "id": "66e1e3b4e5607af9ada551b3",
                  "createdAt": "2024-09-11T18:38:44.780Z",
                  "updatedAt": "2024-09-11T18:38:44.780Z",
                  "bDCCompanyId": "202409-09662563000110",
                  "code": "4663000",
                  "docNumber": "00000807000124",
                  "activity": "COMERCIO ATACADISTA DE MAQUINAS E EQUIPAMENTOS PARA USO INDUSTRIAL",
                  "economicActivityDivision": "COMERCIO POR ATACADO, EXCETO VEICULOS AUTOMOTORES E MOTOCICLETAS",
                  "economicActivityGroup": "COMERCIO ATACADISTA DE MAQUINAS, APARELHOS E EQUIPAMENTOS, EXCETO DE TECNOLOGIAS DE INFORMACAO E COMUNICACAO",
                  "isMainEconomicActivity": false,
                  "changeDate": "2022-06-01T00:00:00.000Z"
                },
                {
                  "id": "66e1e3b4e5607af9ada551b4",
                  "createdAt": "2024-09-11T18:38:44.780Z",
                  "updatedAt": "2024-09-11T18:38:44.780Z",
                  "bDCCompanyId": "202409-09662563000110",
                  "code": "4669999",
                  "docNumber": "00000326000119",
                  "activity": "COMERCIO ATACADISTA DE OUTRAS MAQUINAS E EQUIPAMENTOS NAO ESPECIFICADOS ANTERIORMENTE",
                  "economicActivityDivision": "COMERCIO POR ATACADO, EXCETO VEICULOS AUTOMOTORES E MOTOCICLETAS",
                  "economicActivityGroup": "COMERCIO ATACADISTA DE MAQUINAS, APARELHOS E EQUIPAMENTOS, EXCETO DE TECNOLOGIAS DE INFORMACAO E COMUNICACAO",
                  "isMainEconomicActivity": false,
                  "changeDate": "2022-06-01T00:00:00.000Z"
                },
                {
                  "id": "66e1e3b4e5607af9ada551b5",
                  "createdAt": "2024-09-11T18:38:44.780Z",
                  "updatedAt": "2024-09-11T18:38:44.780Z",
                  "bDCCompanyId": "202409-09662563000110",
                  "code": "4684299",
                  "docNumber": "00006027000191",
                  "activity": "COMERCIO ATACADISTA DE OUTROS PRODUTOS QUIMICOS E PETROQUIMICOS NAO ESPECIFICADOS ANTERIORMENTE",
                  "economicActivityDivision": "COMERCIO POR ATACADO, EXCETO VEICULOS AUTOMOTORES E MOTOCICLETAS",
                  "economicActivityGroup": "COMERCIO ATACADISTA ESPECIALIZADO EM OUTROS PRODUTOS",
                  "isMainEconomicActivity": false,
                  "changeDate": "2022-06-01T00:00:00.000Z"
                },
                {
                  "id": "66e1e3b4e5607af9ada551b6",
                  "createdAt": "2024-09-11T18:38:44.780Z",
                  "updatedAt": "2024-09-11T18:38:44.780Z",
                  "bDCCompanyId": "202409-09662563000110",
                  "code": "4689301",
                  "docNumber": "00001596000144",
                  "activity": "COMERCIO ATACADISTA DE PRODUTOS DA EXTRACAO MINERAL, EXCETO COMBUSTIVEIS",
                  "economicActivityDivision": "COMERCIO POR ATACADO, EXCETO VEICULOS AUTOMOTORES E MOTOCICLETAS",
                  "economicActivityGroup": "COMERCIO ATACADISTA ESPECIALIZADO EM OUTROS PRODUTOS",
                  "isMainEconomicActivity": false,
                  "changeDate": "2022-06-01T00:00:00.000Z"
                },
                {
                  "id": "66e1e3b4e5607af9ada551b7",
                  "createdAt": "2024-09-11T18:38:44.780Z",
                  "updatedAt": "2024-09-11T18:38:44.780Z",
                  "bDCCompanyId": "202409-09662563000110",
                  "code": "4744001",
                  "docNumber": "00000463000234",
                  "activity": "COMERCIO VAREJISTA DE FERRAGENS E FERRAMENTAS",
                  "economicActivityDivision": "COMERCIO VAREJISTA",
                  "economicActivityGroup": "COMERCIO VAREJISTA DE MATERIAL DE CONSTRUCAO",
                  "isMainEconomicActivity": false,
                  "changeDate": "2022-06-01T00:00:00.000Z"
                },
                {
                  "id": "66e1e3b4e5607af9ada551b8",
                  "createdAt": "2024-09-11T18:38:44.780Z",
                  "updatedAt": "2024-09-11T18:38:44.780Z",
                  "bDCCompanyId": "202409-09662563000110",
                  "code": "4789099",
                  "docNumber": "00000091000165",
                  "activity": "COMERCIO VAREJISTA DE OUTROS PRODUTOS NAO ESPECIFICADOS ANTERIORMENTE",
                  "economicActivityDivision": "COMERCIO VAREJISTA",
                  "economicActivityGroup": "COMERCIO VAREJISTA DE PRODUTOS NOVOS NAO ESPECIFICADOS ANTERIORMENTE E DE PRODUTOS USADOS",
                  "isMainEconomicActivity": false,
                  "changeDate": "2022-06-01T00:00:00.000Z"
                },
                {
                  "id": "66e1e3b4e5607af9ada551b9",
                  "createdAt": "2024-09-11T18:38:44.780Z",
                  "updatedAt": "2024-09-11T18:38:44.780Z",
                  "bDCCompanyId": "202409-09662563000110",
                  "code": "6810202",
                  "docNumber": "00000166000108",
                  "activity": "ALUGUEL DE IMOVEIS PROPRIOS",
                  "economicActivityDivision": "ATIVIDADES IMOBILIARIAS",
                  "economicActivityGroup": "ATIVIDADES IMOBILIARIAS DE IMOVEIS PROPRIOS",
                  "isMainEconomicActivity": false,
                  "changeDate": "2022-06-01T00:00:00.000Z"
                }
              ],
              "historyTaxRegimes": [
                {
                  "id": "66e1e3b4e5607af9ada551a9",
                  "createdAt": "2024-09-11T18:38:44.769Z",
                  "updatedAt": "2024-09-11T18:38:44.769Z",
                  "bDCCompanyId": "202409-09662563000110",
                  "taxRegime": "LTDA",
                  "changeDate": "2019-08-01T00:00:00.000Z"
                },
                {
                  "id": "66e1e3b4e5607af9ada551aa",
                  "createdAt": "2024-09-11T18:38:44.769Z",
                  "updatedAt": "2024-09-11T18:38:44.769Z",
                  "bDCCompanyId": "202409-09662563000110",
                  "taxRegime": "LUCRO REAL",
                  "changeDate": "2023-02-01T00:00:00.000Z"
                }
              ]
            }
          }
        },
        "integrationTypes": [
          "BDC_COMPANY_HISTORY_BASIC_DATA"
        ]
      }
    ]
  },
  "organizationId": "65eb4989a4a87b9a94d1920f"
}

Estrutura do Retorno

Campo	Definição
data.id	Id da seção do relatório
data.report.id	Id do relatório
data.report.organizationId	Id da organização
data.report.type.id	Id do tipo de relatório
data.report.type.createdAt	Data de criação do relatório
data.report.type.updatedAt	Data da última atualização do relatório
data.report.type.title	Nome do relatório
data.report.type.value	Nome do relatório no sistema
data.report.type.isPaid	Classificação da consulta. True: consulta extra False: consulta dentro do plano
data.type.id	Id do tipo de seção (lista de seções)
data.type.value	Nome do tipo de seção
data.type.tabs.type	Nome da aba do relatório
data.type.tabs.order	Ordenação da informação na aba do relatório
data.createdAt	Data de criação da seção do relatório
data.updatedAt	Data da última atualização da seção do relatório
data.completedAt	Data em que a seção do relatório foi finalizada
details	Objeto de detalhamento dos dados
erros	Array de erros
organizationId	Id da organização

O objeto evento

O objeto de dados que enviamos para seu endpoint de webhook fornece uma visão instantânea da seção que foi atualizada. Ele também inclui um tipo de valor ('type.value') para cada uma das seções. As seções incluem:

Nome	Descrição	Value
Informações Básicas	Dados básicos da empresa/pessoa	BASIC_INFORMATION
Resumo de alertas	Alertas agrupados com os principais dados do relatório	SUMMARY
Certidões emitidas	Certidões federais, estaduais emitidas	CERTIFICATES
Antecedente Criminal	Certidão nada consta na policia federal	CRIMINAL_RECORD
Localização	Latitude, longitude e URL (GoogleMaps)	LOCATION
Pessoa politicamente exposta	Análise de exposição política dos sócios ou da pessoa	PEP
Processos	Processos da empresa e sócios ou da pessoa	PROCESS
Protestos	Protestos da empresa ou pessoa	PROTESTS
Relacionamentos	CPF's e CNPJ's relacionados em até 3o nível	RELATIONS
Sanções	Sanções nacionais e internacionais nos principais banco de dados do mundo	SANCTIONS
Histórico SCR (bacen)	Histórico das atividades de crédito notificadas no banco central	HISTORY
Categorias de uso SCR (bacen)	Categorias do banco central em relação a atividades de crédito	CATEGORIES
Pendencias financeiras (birôs)	Dados de Pefin vinculados a empresa ou pessoa	PEFIN
Refinanciamento financeiro (SERASA)	Dados de Refin vinculados a empresa ou pessoa	REFIN
Cheque sem fundo	Dados de cheque sem fundo	BAD_CHECK
Política de crédito	Resultado das regras da politica de crédito configuradas	CREDIT_POLICY

Antecedente Criminal é uma informação exclusiva para consultas de Pessoas Físicas

Detalhamento das Seções

Consulta ao relatório