Webhooks

criar uma rota docid\ dtkr nzzfj 6et6l9xogf consultar rotas docid\ sr5p4 cxnhadskun9sy deletar rotas docid\ mlobaaugboat 5yldkt f 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 docid\ dtkr nzzfj 6et6l9xogf 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" "junior\@icra com br", "lemitprofession" " ", "lemitsecondarycontacts" \[ { "contacttype" "email", "contact" "asw\@aswbrasil com br" }, { "contacttype" "email", "contact" "rh\@aswbrasil com br" }, { "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 true false 262false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type 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 true false 157,360,81false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type antecedente criminal é uma informação exclusiva para consultas de pessoas físicas detalhamento das seções consulta ao relatório docid\ iy1eczyukrmcw8xaxdqhh