1. Phase
AgRisk
  • AgRisk
    • Documentação
      • AgRisk
    • API
      • versão
        • Consulta versão API
      • saúde da API
        • Consulta saúde da API
      • autenticação
        • Autenticar via credenciais
      • clientes
        • Cadastrar cliente
        • Listar clientes da empresa
        • Solicitar relatório AgRisk
        • Consultar quantide de clientes por classificação
        • Remover cliente
      • grupos
        • Cadastrar grupos
        • Listar grupos
        • Cadastrar grupo econômico expandido
        • Listar clientes de um grupo
        • Cadastrar cliente em um grupo
        • Consultar totais de clientes de um grupo
        • Renomear grupo
        • Remover grupo
        • Adicionar cliente a um grupo
        • Remover cliente de um grupo
      • empresas
      • produtos
        • Listar produtos permitidos ao usuário
        • Listar produtos permitidos por tipo de consulta
        • Consultar preço de um produto
      • serviços
      • saldo
        • Visualizar saldo de uma empresa
        • Listar histórico de créditos de uma empresa
      • usuários
        • Cadastrar resposta da pesquisa de satisfação
        • Verificar se usuário já respondeu a pesquisa de satisfação
      • agflow
      • matrículas
        • Lista análise de registro de um cliente
        • Cria análise de registro de um cliente
        • Solicitar análise de matrícula de um imóvel
        • Listar matrículas sem contrato de um cliente
        • Visualizar análise de matrícula
        • Remover análise de matrícula
        • Desvincular matrícula de um contrato
      • consultas - endividamento CPR
        • Registrar decisão sobre solicitação de consulta de CPR na CERC
        • Listar CPRs de um cliente
        • Listar solicitações de consulta de CPR na CERC
        • Visualizar solicitação de consulta de CPR na CERC
        • Exportar CPRs de um cliente (Excel)
        • Listar CPRs de um cliente (detalhado)
        • Visualizar detalhes de uma CPR
      • cobrança
        • Listar cobranças de uma empresa
        • Exportar consumo da empresa
      • relatórios financeiros
        • Listar extrações de balanço e DRE de um cliente
        • Solicitar extração de balanço e DRE
        • Visualizar relatório consolidado de um cliente
        • Solicitar relatório consolidado de um cliente
        • Visualizar relatório consolidado de um cliente (detalhado)
        • Visualizar extração de balanço e DRE
        • Remover extração de balanço e DRE
        • Atualizar extração de balanço e DRE
        • Visualizar extração de balanço e DRE (detalhado)
        • Recalcular indicadores de uma extração
        • Solicitar nova análise de uma extração
      • produção rural
        • Cadastrar referencial de custo de produção
        • Listar referenciais de custo de produção
        • Visualizar referencial de custo de produção
        • Atualizar referencial de custo de produção
        • Remover referencial de custo de produção
        • Listar produções de um cliente
        • Cadastrar produções de um cliente
        • Visualizar consolidado das produções de um cliente
        • Exportar consolidado das produções de um cliente (Excel)
        • Atualizar produção de um cliente
        • Remover produção de um cliente
        • Cadastrar imóvel rural de um cliente
        • Atualizar imóvel rural de um cliente
        • Remover imóvel rural de um cliente
        • Importar imóveis rurais de um cliente
        • Listar imóveis rurais de um cliente
        • Exportar produções de um cliente (Excel)
        • Visualizar produção de um cliente
        • Visualizar imóvel rural de um cliente
        • Calcular produções (simulação)
        • Listar filtros disponíveis das produções de um cliente
      • culturas
        • Listar culturas
      • Sapiens
      • arquivos
        • Gerar URL de upload de arquivo para análise AG-IA
        • Gerar URL de download de arquivo da análise AG-IA
        • Gerar URL de upload de arquivo de um cliente
        • Gerar URL de download de arquivo de um cliente
      • relatórios
        • Visualizar relatório-resumo de um cliente
        • Visualizar relatório personalizado de um cliente
      • planos
        • Consultar status da assinatura de um plano
        • Assinar plano ou iniciar período de testes
        • Listar planos assinados por uma empresa
      • planos de assinatura
      • Radar RJ
        • Listar ocorrências do Radar RJ
        • Pesquisar ocorrências do Radar RJ
        • Cadastrar registros do Radar RJ da empresa
        • Remover registros do Radar RJ
        • Listar registros do Radar RJ da empresa
      • recomendações
        • Listar pedidos de recomendação
        • Solicitar recomendação de um cliente
        • Listar avaliações de um pedido de recomendação
        • Avaliar um pedido de recomendação
      • API KEY
      • bancos
      • permissões
        • Consultar as permissões do usuário autenticado
      • score
        • Solicitar consulta de Score AgRisk de clientes
      • registro CPR
        • Gerar URL assinada de download de arquivo de cessão
        • Gerar URL assinada de upload de arquivo de cessão
        • Calcular custo de registro de CPR Ag
        • Registrar cessão de operações
        • Listar cessões
        • Listar operações de uma cessão
        • Pesquisar CPRs da empresa
        • Registrar CPR de um cliente
        • Registrar CPR Ag
        • Calcular custo de registro de CPR
        • Registrar CPR Ag em rascunho ou com erro
        • Listar CPRs da empresa
        • Enviar documento de CPR Ag para análise automática
        • Informar pagamento ou inadimplência de uma CPR
        • Reenviar documento de CPR Ag para análise automática
        • Exportar CPRs da empresa (Excel)
        • Cancelar CPR Ag
        • Registrar endosso de CPR de um cliente
        • Registrar endosso de CPR Ag de um cliente
        • Registrar cessão de CPR de um cliente
        • Registrar aditivo de CPR de um cliente
        • Registrar cessão de CPR Ag de um cliente
      • termos de uso
        • Registrar aceite ou recusa dos termos de uso
        • Verificar aceite dos termos de uso
      • monitoramento
        • Limpar alertas de um cliente
        • Marcar falhas de consulta do monitoramento como vistas
        • Listar monitoramentos da empresa
        • Cadastrar monitoramento
        • Listar módulos monitoráveis
        • Pesquisar clientes para monitoramento
        • Consultar alertas não lidos do usuário
        • Calcular previsão de créditos de um monitoramento
        • Atualizar monitoramento
        • Visualizar monitoramento
        • Desativar monitoramento
        • Listar histórico de alterações de um monitoramento
        • Reativar monitoramento
        • Definir clientes de um monitoramento
        • Remover cliente de um monitoramento
        • Listar alertas de um cliente do monitoramento
        • Marcar alertas de um cliente como lidos
        • Listar consultas de um monitoramento
      • antecipação
        • Solicitar contato sobre antecipação de crédito
      • documentos
        • Cadastrar arquivo de um cliente
        • Registrar autorização SCR de um cliente
        • Consultar arquivo
        • Mover arquivo para a lixeira
        • Editar arquivo
        • Mover arquivo
        • Compartilhar arquivo
        • Abrir arquivo compartilhado
        • Remover compartilhamento de arquivo
        • Criar pasta nos documentos de um cliente
        • Listar conteúdo de uma pasta
        • Editar pasta
        • Mover pasta
        • Mover pasta para a lixeira
        • Listar documentos de um cliente
        • Criar etiquetas pré-definidas de uma empresa
        • Listar etiquetas de uma empresa
        • Adicionar etiqueta personalizada a uma empresa
        • Remover etiqueta personalizada de uma empresa
      • senha
        • Solicitar redefinição de senha
      • patrimônio
        • Listar imóveis rurais detalhados de um cliente
        • Cadastrar ativo financeiro de um cliente
        • Cadastrar imóvel rural no patrimônio de um cliente
        • Consultar imóvel rural
        • Remover imóvel rural de um cliente
        • Baixar KML de um imóvel rural
        • Cadastrar imóvel urbano de um cliente
        • Atualizar imóvel urbano
        • Remover imóvel urbano
        • Atualizar ativo financeiro
        • Remover ativo financeiro
        • Atualizar bem móvel
        • Listar ativos financeiros de um cliente
        • Listar imóveis rurais de um cliente, com totais
        • Remover bem móvel
        • Cadastrar passivo de um cliente
        • Atualizar passivo
        • Remover passivo
        • Listar passivos de um cliente
        • Importar passivo bancário do SCR de um cliente
        • Solicitar extração de declaração de IR de um cliente
        • Listar extrações de IR recentes de um cliente
        • Consultar resultado de extração de IR
        • Cadastrar bem móvel de um cliente
        • Listar bens móveis de um cliente
        • Listar imóveis urbanos de um cliente
      • notificações
        • Listar notificações vigentes do usuário
      • banners
        • Listar banners em exibição
      • contratos
        • Listar contratos de um cliente
        • Cadastrar contrato de um cliente para análise
        • Visualizar detalhes de um contrato
        • Exportar conferência de matrículas de um contrato (CSV)
        • Remover contrato de um cliente
        • Comparar contrato com uma matrícula vinculada
        • Vincular várias matrículas a um contrato
        • Vincular uma matrícula analisada a um contrato
        • Enviar matrícula para análise e vincular a um contrato
      • consultas
        • Solicitar consultas
        • Listar consultas mais recentes de um cliente
        • Solicitar consulta de flag de negativação
        • Visualizar resumo de uma consulta
        • Listar consultas de um cliente
        • Listar consultas de um cliente por serviço
        • Consultar status geral de uma consulta
        • Listar status dos serviços de um cliente por produto
        • Obter URL assinada de um documento (v2)
        • Obter URL assinada de um documento
        • Listar armazéns registrados de um cliente
      • consultas - imóveis CAR
        • Obter URL assinada do recibo do CAR
        • Listar imóveis CAR de um cliente
        • Listar imóveis CAR de um cliente (detalhado)
        • Visualizar imóvel CAR
        • Cadastrar imóveis CAR em uma consulta
        • Atualizar imóvel CAR
        • Baixar certidão do CAR
        • Cadastrar geometria NDVI de um imóvel CAR
        • Visualizar imóvel CAR (streaming)
        • Exportar geometria de um imóvel CAR (KML)
        • Listar imóveis CAR por arquivo (KML ou Shapefile)
        • Listar imóveis CAR por coordenadas
        • Solicitar valores de tipologia dos imóveis CAR de um cliente
      • consultas - restritivos de créditos
        • Solicitar consulta de negativação
        • Visualizar restritivos de crédito de um cliente
        • Visualizar negativação de uma consulta
      • consultas - imóveis rurais
        • Baixar comprovante CISC de um imóvel rural
        • Verificar dados complementares de imóvel rural por NIRF
        • Verificar dados complementares de imóvel rural por código INCRA
        • Verificar dados complementares de imóvel rural por CAR
      • consultas - processos judiciais
        • Consultar status de atualização de um processo
        • Listar processos de um cliente
        • Exportar processos de um cliente (Excel)
        • Listar filtros de processos de um cliente
        • Solicitar análise de processo judicial por IA
        • Visualizar processo de um cliente
      • consultas - endividamento
        • Consultar dados de cliente na Nutrien
        • Consultar percentual IF mais recente do SCR
        • Consultar endividamento (SCR) de um cliente em uma consulta
        • Registrar decisão de autorização de SCR
        • Listar solicitações de SCR
        • Visualizar resumo do SCR de um cliente
        • Solicitar análise de endividamento por IA
      • consultas - compliance (conformidade)
        • Visualizar compliance de um cliente
        • Exportar compliance ambiental SEMA (Excel)
        • Visualizar compliance de um cliente (v2)
        • Visualizar documento de compliance
      • consultas - flag negativação
        • Consultar o resultado de uma flag de negativação
      • consultas - dados básicos
        • Listar contatos de um cliente
        • Consultar dados cadastrais de um cliente
      • consultas - BNDES
        • Listar registros do BNDES de um cliente
      • consultas - sintegra
        • Listar registros do Sintegra de um cliente
      • consultas - veículo
        • Listar veículos de uma consulta
      • consultas - Boa Vista
        • Visualizar Boa Vista de um cliente
      • consultas - protesto
        • Visualizar protestos de um cliente
      • consultas - QUOD
        • Visualizar Quod de um cliente
      • consultas - grupo familiar
        • Listar pessoas do grupo familiar de um cliente
      • consultas - grupo econômico
        • Listar pessoas do grupo econômico de um cliente
      • custódia CPR
      • débitos
        • Listar débitos da empresa
    • Esquemas
      • API Requests
        • ClientResponse
      • AppError
      • CenprotError
      • InternalError
      • CenprotTitle
      • CenprotNotary
      • CenprotResult
      • get_release_Response
      • CenprotHistoryItem
      • post_login_Response
      • get_balance_companyId_Response
      • get_clients_clientId_resume_Response
      • get_queries_queryId_resume_Response
      • get_queries_clients_clientId_cpr_queryId_detailed_Response
      • patch_balance_companyId_block_Response
      • post_balance_companyId_add_Response
      • get_health_check_Response
      • patch_services_serviceId_Response
      • post_services_Response
      • get_v2_queries_clients_clientId_report_extraction_consolidated_Response
      • get_v2_queries_clients_clientId_report_extraction_consolidated_detailed_Response
      • get_v2_queries_clients_clientId_report_extraction_id_Response
      • get_v2_rural_production_clientId_consolidated_Response
      • get_v2_rural_production_clientId_rural_properties_Response
      • get_products_Response
      • get_products_productId_Response
      • post_v2_rural_production_clientId_rural_properties_create_Response
      • put_v2_rural_production_clientId_rural_properties_areaId_Response
      • delete_v2_rural_production_clientId_rural_properties_areaId_Response
      • get_v2_rural_production_clientId_rural_properties_area_id_Response
      • post_v2_files_clients_clientId_download_Response
      • get_v2_plans_code_status_Response
      • get_v2_plans_companyId_Response
      • patch_v2_plans_code_deactivate_companyId_Response
      • post_v2_plans_charge_Response
      • post_v2_plans_code_sign_Response
      • get_v2_recommendations_Response
      • get_v2_recommendations_evaluate_recommendationId_Response
      • post_v2_recommendations_Response
      • post_v2_recommendations_evaluate_recommendationId_Response
      • get_v2_report_clients_clientId_Response
      • get_v2_report_clients_custom_clientId_Response
      • post_v2_signature_plans_Response
      • get_v2_sapiens_auth_Response
      • delete_v2_api_key__id_Response
      • get_v2_api_key_Response
      • post_v2_api_key_Response
      • get_v2_group_groupId_clients_Response
      • get_v2_rural_properties_car_carCode_Response
      • get_v2_rural_properties_clientId_clientId_rural_property_propertyId_cisc_Response
      • get_v2_rural_properties_incra_incraNumber_Response
      • get_v2_rural_properties_nirf_nirfCode_Response
      • get_v2_products_Response
      • get_v2_products_list_Response
      • get_v2_products_productCode_price_Response
      • post_v2_check_score_Response
      • get_v2_users_commercial_and_success_Response
      • patch_v2_users_userId_agflow_role_Response
      • get_v2_banks_Response
      • post_v2_terms_accept_Response
      • get_v2_terms_check_Response
      • post_v2_anticipation_Response
      • post_documents_files_Response
      • get_documents_files_idFile_Response
      • patch_documents_files_trash_idFile_Response
      • patch_documents_files_edit_Response
      • patch_documents_files_move_Response
      • get_documents_files_idFile_share_Response
      • get_documents_files_shared_idHashed_Response
      • patch_documents_files_idFile_share_remove_Response
      • post_documents_folders_Response
      • get_documents_folders_idFolder_Response
      • patch_documents_folders_edit_Response
      • patch_documents_folders_move_Response
      • patch_documents_folders_trash_idFolder_Response
      • get_documents_list_clientId_Response
      • post_documents_labels_companyId_Response
      • get_documents_labels_companyId_Response
      • patch_documents_labels_companyId_Response
      • patch_documents_labels_companyId_remove_label_Response
      • post_password_register_tokenURL_Response
      • post_password_resetPassword_Response
      • get_queries_clients_clientId_lawsuits_Response
      • get_queries_clients_clientId_scr_queryId_Response
      • get_queries_clients_clientId_lawsuits_excel_Response
      • post_queries_clients_scr_queryId_Response
      • get_queries_clients_clientId_lawsuits_detailed_Response
      • get_queries_clients_clientId_lawsuits__id_Response
      • post_v2_queries_clients_clientId_scr_ia_analysis_scrId_Response
      • get_v2_lawsuits_updates_clientId_update_status_detailId_Response
      • post_v2_scr_authorization_nutrien_Response
      • get_v2_scr_if_percent_Response
      • post_v2_scr_update_status_Response
      • get_v2_scr_requests_Response
      • post_cpr_additive_clientId_Response
      • post_cpr_cession_clientId_Response
      • post_cpr_cost_Response
      • post_cpr_endorsement_clientId_Response
      • post_cpr_payment_cprId_Response
      • post_cpr_process_cpr_id_Response
      • post_cpr_register_clientId_Response
      • get_cpr_download_Response
      • post_cpr_completed_Response
      • get_cession_generate_download_signed_url_Response
      • get_cession_generate_upload_signed_url_Response
      • get_cession_list_cessions_Response
      • get_cession_list_details_cession_id_Response
      • post_cession_save_cession_Response
      • delete_banner_banner_id_Response
      • get_banner_Response
      • get_banner_banner_id_details_Response
      • get_banner_show_Response
      • delete_notification_notificationId_Response
      • get_notification_Response
      • get_notification_notificationId_detail_Response
      • get_notification_user_Response
      • patch_notification_notificationId_Response
      • post_notification_Response
      • patch_banner_banner_id_Response
      • post_banner_Response
      • delete_assets_fiancial_fiancialId_Response
      • delete_assets_liabilities_liabilitiesId_Response
      • get_assets_clientId_properties_rural_detailed_Response
      • get_assets_ir_status_clientId_Response
      • get_assets_liabilities_clientId_Response
      • get_assets_properties_rural_kml_propertyId_Response
      • get_assets_properties_rural_propertyId_Response
      • patch_assets_fiancial_fiancialId_Response
      • patch_assets_id_properties_mobile_update_Response
      • patch_assets_id_properties_urban_update_Response
      • patch_assets_liabilities_liabilitiesId_Response
      • post_assets_clientId_properties_urban_create_Response
      • post_assets_ir_import_clientId_Response
      • post_assets_liabilities_create_Response
      • post_assets_liabilities_import_SCR_clientId_Response
      • get_v2_cpr_ag_list_Response
      • patch_v2_cpr_ag_pre_register_id_Response
      • post_v2_cpr_ag_cession_clientId_Response
      • post_v2_cpr_ag_cost_Response
      • post_v2_cpr_ag_cprId_cancel_Response
      • post_v2_cpr_ag_endorsement_clientId_Response
      • post_v2_cpr_ag_pre_register_Response
      • post_v2_cpr_ag_register_Response
      • post_v2_cpr_ag_register_id_Response
      • get_clients_client_clientId_Response
      • get_clients_details_Response
      • get_queries_clients_clientId_Response
      • get_queries_clients_clientId_bndes_Response
      • get_queries_clients_clientId_bvs_queryId_Response
      • get_queries_clients_clientId_credit_restrictive_queryId_Response
      • get_queries_clients_clientId_groups_economic_Response
      • get_queries_clients_clientId_groups_family_Response
      • get_queries_clients_clientId_protests_queryId_Response
      • get_queries_clients_clientId_quod_queryId_Response
      • get_queries_clients_clientId_sintegra_Response
      • get_queries_companies_companyId_Response
      • delete_groups_groupId_Response
      • get_groups_groupId_clients_Response
      • get_groups_groupId_clients_details_Response
      • patch_groups_groupId_Response
      • post_groups_groupId_clients_Response
      • get_queries_clients_clientId_cpr_queryId_Response
      • get_assets_clientId_properties_mobile_list_Response
      • get_assets_clientId_properties_rural_Response
      • get_assets_clientId_properties_urban_list_Response
      • get_assets_fiancial_clientId_Response
      • post_assets_clientId_properties_mobile_create_Response
      • post_assets_fiancial_create_Response
      • post_assets_properties_rural_Response
      • get_v2_queries_clients_cars_download_carId_Response
      • get_v2_queries_clients_clientId_contacts_Response
      • get_v2_queries_vehicle_assets_queryId_Response
      • post_v2_queries_clients_clientId_lawsuits_ia_analysis_Response
      • get_queries_clients_clientId_compliance_queryId_Response
      • delete_v2_clients_clientId_contracts_contractId_Response
      • get_v2_clients_Response
      • get_v2_clients_clientId_contracts_Response
      • get_v2_clients_clientId_contracts_contractId_crossing_registryAnalysisId_Response
      • get_v2_clients_clientId_contracts_contractId_details_Response
      • get_v2_clients_clientId_contracts_contractId_export_Response
      • post_v2_clients_clientId_contracts_Response
      • post_v2_clients_clientId_contracts_contractId_property_registration_registryAnalysisId_Response
      • delete_permissions_permissionId_Response
      • get_permissions_Response
      • get_permissions_permissionId_Response
      • get_permissions_user_Response
      • post_permissions_Response
      • put_permissions_permissionId_Response
      • get_v2_cpr_requests_Response
      • get_v2_cpr_requests_requestId_Response
      • post_v2_cpr_update_status_Response
      • delete_v2_radar_rj_records_Response
      • get_v2_radar_rj_Response
      • get_v2_radar_rj_records_Response
      • get_v2_radar_rj_search_Response
      • post_v2_radar_rj_records_Response
      • get_v2_queries_clients_clientId_registry_analysis_without_contract_Response
      • put_v2_queries_clients_clientId_registry_analysis_id_remove_contract_Response
      • get_v2_monitoring_Response
      • ICreateMonitoringModuleBody
      • post_v2_monitoring_Response
      • IUpdateMonitoringModuleBody
      • patch_v2_monitoring_monitoringId_Response
      • post_v2_monitoring_estimate_Response
      • get_v2_monitoring_modules_Response
      • get_v2_monitoring_monitoringId_Response
      • get_v2_monitoring_clients_Response
      • post_v2_monitoring_monitoringId_clients_Response
      • get_v2_monitoring_monitoringId_clients_clientId_Response
      • get_v2_monitoring_alerts_unread_count_Response
      • post_v2_monitoring_monitoringId_deactivate_Response
      • post_v2_monitoring_monitoringId_reactivate_Response
      • get_v2_monitoring_monitoringId_history_Response
      • get_v2_monitoring_monitoringId_queries_Response
      • post_v2_monitoring_tick_Response
      • delete_v2_monitoring_monitoringId_clients_clientId_Response
      • post_v2_monitoring_monitoringId_clients_clientId_alerts_read_Response
      • post_v2_monitoring_validator_Response
      • post_v2_monitoring_finalizer_Response
      • get_cpr_list_Response
      • get_clients_pre_approved_taxId_Response
      • post_clients_Response
      • get_queries_clients_clientId_cpr_details_cercPublicidadeCprsId_Response
      • get_queries_clients_clientId_filters_Response
      • get_queries_clients_clientId_registered_warehouses_queryId_Response
      • get_queries_queryId_general_status_Response
      • post_clients_clients_exportation_Response
      • post_documents_files_clients_clientId_scr_auth_Response
      • get_companies_Response
      • get_companies_by_tax_id_taxId_Response
      • get_companies_companyId_Response
      • get_companies_companyId_excel_Response
      • get_companies_companyId_users_Response
      • get_companies_excel_survey_recommendation_Response
      • get_companies_survey_recommendation_userAlreadyExists_Response
      • get_companies_users_customerSuccessAnalyst_Response
      • get_companies_users_userId_Response
      • patch_companies_companyId_Response
      • patch_companies_users_userId_Response
      • post_companies_Response
      • post_companies_query_consume_Response
      • post_companies_users_validate_Response
      • get_groups_Response
      • patch_groups_groupId_clients_clientId_add_Response
      • patch_groups_groupId_clients_clientId_remove_Response
      • post_groups_Response
      • post_groups_group_expanded_Response
      • get_queries_clients_clientId_documents_queryId_Response
      • get_queries_clients_clientId_excel_queryId_Response
      • get_queries_file_documents_Response
      • post_queries_Response
      • post_queries_clients_clientId_finance_Response
      • delete_assets_clients_clientId_properties_rural_propertyId_Response
      • get_assets_ir_ir_extraction_status_id_irExtractionStatusId_Response
      • patch_assets_id_properties_mobile_delete_Response
      • patch_assets_id_properties_urban_delete_Response
      • get_balance_Response
      • get_balance_companyId_log_Response
      • get_services_Response
      • post_v2_files_clients_clientId_Response
      • post_v2_files_clients_clientId_ag_ia_download_Response
      • post_v2_files_clients_clientId_ag_ia_upload_Response
      • get_v2_login_users_Response
      • post_v2_login_Response
      • post_v2_login_microsoft_Response
      • post_v2_login_user_Response
      • post_v2_billing_Response
      • post_v2_billing_negativation_clients_clientId_Response
      • post_v2_clients_clientId_contracts_contractId_property_registration_Response
      • post_v2_clients_clientId_contracts_contractId_property_registration_batch_Response
      • get_v2_cultures_Response
      • delete_v2_queries_clients_clientId_registry_analysis_id_Response
      • delete_v2_queries_clients_clientId_report_extraction_id_Response
      • get_v2_queries_clients_cars_id_Response
      • get_v2_queries_clients_cars_id_stream_Response
      • get_v2_queries_clients_cars_kml_id_Response
      • get_v2_queries_clients_clientId_Response
      • get_v2_queries_clients_clientId_compliance_queryId_Response
      • get_v2_queries_clients_clientId_latest_Response
      • get_v2_queries_clients_clientId_products_Response
      • get_v2_queries_clients_clientId_queryId_cars_Response
      • get_v2_queries_clients_clientId_queryId_cars_detailed_Response
      • get_v2_queries_clients_clientId_registry_analysis_Response
      • get_v2_queries_clients_clientId_registry_analysis_id_Response
      • get_v2_queries_clients_clientId_report_extraction_Response
      • get_v2_queries_clients_clientId_report_extraction_id_detailed_Response
      • get_v2_queries_clients_clientId_scpc_net_queryId_Response
      • get_v2_queries_clients_clientId_scr_resume_queryId_Response
      • get_v2_queries_queryId_credit_restrictive_negativation_Response
      • get_v2_queries_send_webhook_clientId_Response
      • patch_v2_queries_clients_cars_id_Response
      • patch_v2_queries_clients_clientId_report_extraction_id_Response
      • patch_v2_queries_property_registry_propertyRegistryId_Response
      • post_v2_queries_clients_cars_id_Response
      • post_v2_queries_clients_clientId_cars_property_amounts_Response
      • post_v2_queries_clients_clientId_queryId_cars_coords_Response
      • post_v2_queries_clients_clientId_queryId_cars_create_Response
      • post_v2_queries_clients_clientId_queryId_cars_file_Response
      • post_v2_queries_clients_clientId_registry_analysis_Response
      • post_v2_queries_clients_clientId_report_extraction_Response
      • post_v2_queries_clients_clientId_report_extraction_consolidated_Response
      • post_v2_queries_clients_clientId_report_extraction_id_new_analysis_Response
      • post_v2_queries_clients_clientId_report_extraction_id_new_indicators_Response
      • post_v2_queries_file_Response
      • post_v2_queries_property_registry_clientId_Response
      • delete_v2_rural_production_clientId_production_productionId_Response
      • delete_v2_rural_production_reference_referenceId_Response
      • get_v2_rural_production_clientId_consolidated_excel_Response
      • get_v2_rural_production_clientId_filters_Response
      • get_v2_rural_production_clientId_production_Response
      • get_v2_rural_production_clientId_production_excel_Response
      • get_v2_rural_production_clientId_production_production_id_Response
      • get_v2_rural_production_clientId_rural_properties_import_Response
      • get_v2_rural_production_references_Response
      • get_v2_rural_production_references_referenceId_Response
      • post_v2_rural_production_clientId_production_Response
      • post_v2_rural_production_clientId_production_calc_Response
      • post_v2_rural_production_references_Response
      • put_v2_rural_production_clientId_production_productionId_Response
      • put_v2_rural_production_references_referenceId_Response
      • get_v2_users_validate_email_Response
      • get_clients_client_report_export_clientId_Response
      • patch_clients_clientId_delete_Response
      • post_clients_client_report_Response
      • get_queries_clients_clientId_compliance_Response
      • get_queries_clients_clientId_cpr_details_Response
      • get_queries_clients_clientId_protests_Response
      • get_queries_excelSema_clients_clientId_compliance_queryId_Response
      • post_companies_companyId_users_Response
      • post_companies_survey_recommendation_Response
      • patch_products_productId_Response
      • post_products_Response
      • post_v2_agflow_Response
      • post_v2_agflow_publish_queries_Response
      • post_v2_sapiens_create_Response
      • post_v2_banks_Response
      • get_v2_car_carCode_Response
      • post_v2_monitoring_monitoringId_clients_clientId_alerts_clear_Response
      • post_v2_monitoring_monitoringId_queries_seen_Response
  • AgFlow
    • 🇧🇷 Português
      • Introdução
      • Aprovação
        • Aprovação — Visão Geral
        • Consultar configuração de aprovação
        • Criar configuração de aprovação
        • Atualizar configuração de aprovação
        • Adicionar regra de aprovação
        • Atualizar regra de aprovação
        • Remover configuração de aprovação
        • Consultar aprovação do card
        • Registrar voto de aprovação
        • Atualizar voto de aprovação
      • Fluxo
        • Fluxo — Visão Geral
        • Verificar disponibilidade
        • Criar fluxo
        • Listar fluxos
        • Obter fluxo
        • Atualizar fluxo
        • Remover fluxo
        • Adicionar usuário ao fluxo
        • Remover usuário do fluxo
        • Listar caminhos de campos dinâmicos
      • Consulta a Bureau
        • Consulta a Bureau — Visão Geral
        • Obter configuração de consulta a bureau
        • Criar configuração de consulta a bureau
        • Atualizar configuração de consulta a bureau
      • Campos
        • Campos — Visão Geral
        • Listar campos da fase
        • Atualizar campos da fase
        • Atualizar regras de campos da fase
      • Conversa
        • Conversa — Visão Geral
        • Obter configuração de conversa
        • Criar configuração de conversa
        • Remover configuração de conversa
      • Motores
        • Motores — Visão Geral
        • Consultar resultado do motor de decisão do card
        • Executar motor de decisão no card
        • Consultar inputs do motor de crédito para o card
        • Consultar resultado do motor de crédito do card
        • Executar motor de crédito no card
        • Consultar configuração do motor de decisão
        • Criar configuração do motor de decisão
        • Atualizar configuração do motor de decisão
        • Remover configuração do motor de decisão
        • Consultar detalhe da configuração do motor de crédito
        • Criar configuração do motor de crédito
        • Listar configurações do motor de crédito do flow
        • Listar políticas de crédito aplicáveis a um card
        • Atualizar configuração do motor de crédito
        • Remover configuração do motor de crédito
      • Parecer
        • Parecer — Visão Geral
        • Consultar configuração do parecer técnico
        • Criar configuração do parecer técnico
        • Atualizar configuração do parecer técnico
        • Consultar parecer registrado no card
        • Registrar parecer no card
        • Atualizar parecer no card
      • Formulário Inicial
        • Formulário Inicial — Visão Geral
        • Criar formulário inicial
        • Definir regras condicionais do formulário
        • Atualizar metadados do formulário
        • Consultar formulário inicial
        • Consultar formulário público
        • Atualizar campos do formulário
        • Remover formulário inicial
      • Filtros
        • Filtros — Visão Geral
        • Listar filtros salvos
        • Criar filtro salvo
        • Atualizar filtro salvo
        • Buscar cards do flow
        • Busca global de cards
      • AgRisk
        • AgRisk — Visão Geral
        • Listar produtos de consulta AgRisk
      • Gatilhos
        • Gatilhos — Visão Geral
        • Listar gatilhos do flow
        • Criar gatilho
        • Atualizar gatilho
        • Remover gatilho
        • Listar gatilhos da fase
        • Obter gatilho
      • Autenticação
        • Autenticação — Visão Geral
        • Autenticar usuário
      • Mensageria
        • Mensageria — Visão Geral
        • Configurar telefone
        • Consultar configuração de mensageria
        • Criar configuração de mensageria
        • Atualizar configuração de mensageria
        • Criar regras de mensageria
        • Atualizar regra de mensageria
        • Remover configuração de mensageria
      • Empresas e Papéis
        • Empresas e Papéis — Visão Geral
        • Listar usuários da empresa
        • Listar papéis da empresa
        • Atualizar papel
        • Listar catálogo de permissões
        • Criar papel
        • Gerar URL de upload do logotipo
        • Gerar URL de download do logotipo
        • Atribuir papéis a um usuário
        • Listar permissões de um papel
      • Documentos
        • Documentos — Visão Geral
        • Criar configuração de geração automática de documento
        • Remover configuração de geração automática de documento
        • Consultar configuração de geração automática de documento
        • Atualizar configuração de geração automática de documento
        • Consultar campos para geração do documento
        • Gerar documento a partir de template
        • Consultar template por ID
        • Listar templates do card
        • Ativar template
        • Criar template de documento
        • Remover template
        • Listar templates
        • Definir campos do template
        • Configurar regras condicionais do template
        • Atualizar arquivo do template
        • Listar templates
      • Cards
        • Cards — Visão Geral
        • Listar cards de uma fase
        • Mover card de fase
        • Criar card
        • Listar cards do flow
        • Criar card via link público
        • Buscar cards
        • Obter card
        • Atualizar card
        • Atualizar responsável do card
        • Atualizar campos via link público
        • Atualizar campos de fase do card
        • Remover cards em lote
        • Atualizar Ficha Cadastral do card
        • Obter responsável do card
        • Listar etiquetas do card
        • Listar campos de uma fase do card
        • Listar campos de uma fase do card (link público)
        • Obter histórico do card
        • Listar clientes do card
        • Criar comentário no card
        • Listar comentários do card
        • Remover comentário do card
        • Listar anexos do card
        • Cadastrar anexo no card
        • Remover anexo do card
        • Remover vínculo do anexo com campo de fase
        • Adicionar membros ao grupo do card
        • Remover membro do grupo do card
      • Configuração de Cliente
        • Configuração de Cliente — Visão Geral
        • Obter configuração de cliente por empresa
        • Criar configuração de cliente
        • Atualizar configuração de cliente
        • Obter configuração de cliente
        • Remover configuração de cliente
        • Listar seções
        • Criar seções
        • Obter seção
        • Atualizar seção
        • Atualizar seção parcialmente
        • Remover seção
        • Listar campos
        • Criar campos
        • Obter campo
        • Atualizar campo
        • Atualizar campo parcialmente
        • Remover campo
        • Listar regras
        • Criar regra
        • Obter regra
        • Atualizar regra
        • Atualizar regra parcialmente
        • Remover regra
      • Fase
        • Fase — Visão Geral
        • Criar ação de fase
        • Criar fase
        • Remover ação de fase
        • Remover fase
        • Listar ações da fase
        • Listar fases
        • Atualizar ação de fase
        • Atualizar fase
      • Clientes
        • Clientes — Visão geral
        • Consultar dados AgRisk do cliente
        • Listar cards do cliente
        • Criar cliente
        • Obter cliente
        • Listar clientes
        • Atualizar cliente
    • 🇺🇸 English
      • Getting Started
      • Phase
        • Phase — Overview
        • Create phase action
          POST
        • Create phase
          POST
        • Delete phase action
          DELETE
        • Delete phase
          DELETE
        • List phase actions
          GET
        • List phases
          GET
        • Update phase action
          PUT
        • Update phase
          PATCH
      • Approval
        • Approval — Overview
        • Get approval configuration
        • Create approval configuration
        • Update approval configuration
        • Add approval rule
        • Update approval rule
        • Delete approval configuration
        • Get card approval
        • Register approval vote
        • Update approval vote
      • Flow
        • Flow — Overview
        • Health check
        • Create flow
        • List flows
        • Get flow
        • Update flow
        • Delete flow
        • Add user to flow
        • Remove user from flow
        • List dynamic field paths
      • Bureau Query
        • Bureau Query — Overview
        • Get bureau query configuration
        • Create bureau query configuration
        • Update bureau query configuration
      • Fields
        • Fields — Overview
        • List phase fields
        • Update phase fields
        • Update phase field rules
      • Engines
        • Engines — Overview
        • Get card decision engine result
        • Run card decision engine
        • Get card credit engine inputs
        • Get card credit engine result
        • Run card credit engine
        • Get decision engine configuration
        • Create decision engine configuration
        • Update decision engine configuration
        • Delete decision engine configuration
        • Get credit engine configuration detail
        • Create credit engine configuration
        • List flow credit engine configurations
        • List credit policies applicable to a card
        • Update credit engine configuration
        • Delete credit engine configuration
      • Conversation
        • Conversation — Overview
        • Get conversation configuration
        • Create conversation configuration
        • Delete conversation configuration
      • Opinion
        • Opinion — Overview
        • Get opinion configuration
        • Create opinion configuration
        • Update opinion configuration
        • Get card opinion
        • Create card opinion
        • Update card opinion
      • Start Form
        • Start Form — Overview
        • Create start form
        • Set start form conditional rules
        • Update start form metadata
        • Get start form
        • Get public start form
        • Update start form fields
        • Delete start form
      • Filters
        • Filters — Overview
        • List saved filters
        • Create saved filter
        • Update saved filter
        • Search flow cards
        • Search cards across flows
      • AgRisk
        • AgRisk — Overview
        • List AgRisk query products
      • Triggers
        • Triggers — Overview
        • List flow triggers
        • Create trigger
        • Update trigger
        • Delete trigger
        • List phase triggers
        • Get trigger
      • Authentication
        • Authentication — Overview
        • Authenticate user
      • Messaging
        • Messaging — Overview
        • Configure phone
        • Get messaging config
        • Create messaging config
        • Update messaging config
        • Create messaging rules
        • Update messaging rule
        • Delete messaging config
      • Companies & Roles
        • Companies & Roles — Overview
        • List company users
        • List company roles
        • Update role
        • List permissions catalog
        • Create role
        • Generate company logo upload URL
        • Generate company logo download URL
        • Assign roles to a user
        • List role permissions
      • Documents
        • Documents — Overview
        • Create automatic document configuration
        • Delete automatic document configuration
        • Get automatic document configuration
        • Update automatic document configuration
        • Get fields for document generation
        • Generate document from template
        • Get template by ID
        • List card templates
        • Activate template
        • Create document template
        • Delete template
        • List templates
        • Set template fields
        • Configure template conditional rules
        • Update template file
        • List templates
      • Cards
        • Cards — Overview
        • List cards in a phase
        • Move card to another phase
        • Create card
        • List flow cards
        • Create card via public link
        • Search cards
        • Get card
        • Update card
        • Update card assignee
        • Update fields via public link
        • Update card phase fields
        • Delete cards in bulk
        • Update card registration record
        • Get card assignee
        • List card labels
        • List card phase fields
        • List card phase fields (public link)
        • Get card history
        • List card clients
        • Create card comment
        • List card comments
        • Delete card comment
        • List card attachments
        • Register card attachment
        • Delete card attachment
        • Delete attachment's phase-field link
        • Add members to card group
        • Remove card group member
      • Client Configuration
        • Client Configuration — Overview
        • Get client configuration by company
        • Create client configuration
        • Update client configuration
        • Get client configuration
        • Delete client configuration
        • List sections
        • Create sections
        • Get section
        • Update section
        • Partially update section
        • Delete section
        • List fields
        • Create fields
        • Get field
        • Update field
        • Partially update field
        • Delete field
        • List rules
        • Create rule
        • Get rule
        • Update rule
        • Partially update rule
        • Delete rule
      • Clients
        • Clients — Overview
        • Get client AgRisk data
        • List client cards
        • Create client
        • Get client
        • List clients
        • Update client
    • 🇧🇷 Visão de Negócio
      • Fase
      • Fluxo
      • Campos — Visão de Negócio
      • Aprovação
      • Parecer
      • Motores
      • Empresas e Papéis
      • Gatilhos
      • Conversa
      • Documentos
      • Mensageria
      • Filtros
      • Autenticação
      • Configuração de Cliente
      • Cards
      • AgRisk
      • Formulário Inicial
      • Consulta a Bureau
    • 🇺🇸 Business Overview
      • Phase
      • Flow
      • Approval
      • Fields — Business Overview
      • Opinion
      • Engines
      • Companies & Roles
      • Documents
      • Triggers
      • Messaging
      • Conversation
      • Filters
      • Authentication
      • Client Configuration
      • Cards
      • AgRisk
      • Start Form
      • Bureau Query
  • Portfolio
    • Documentação
      • Empresa
      • Gestão de portfolio
        • Análise geral
        • Dicionário de campos base (Necessário validar)
        • [Desatualizado]Fluxo de funcionamento
        • Carteiras
          • Gestão da carteira
        • Contratos
          • Contratos
          • Template Contratos
        • Pagamentos
          • Pagamentos
        • Baixas
          • Baixas
        • Clientes
          • Devedores e credores (Participantes)
          • Informações dos clientes
        • Importação de dados
          • Importação de dados
        • Garantia
          • Colaterais
      • Gestão de Cobrança
        • Régua de cobrança
          • Regras da régua por empresa
        • Atividades
          • Regras das Atividades
  • cenPROT
    • Raiz
      • Motor CENPROT (novo módulo) v0.1.0
      • Tarefa
        • Processar consulta CENPROT
      • Exportação
        • Exportar resultado CENPROT em XLSX
    • Documentação
    • Esquemas
      • CenprotError
  1. Phase

List phases

GET
/v1/flows/{id}/phases
Returns all phases (stages) of a flow, ordered by the index field.

Requisição

Parâmetros de Caminho

Respostas

🟢200Phase list
application/json
Array of the flow's phases, ordered by the index field.
Bodyapplication/json

Request Request Example
Shell
JavaScript
Java
Swift
curl --location '/v1/flows//phases'
Response Response Example
[
    {
        "id": "string",
        "name": "string",
        "color": "string",
        "index": 0,
        "start": true,
        "done": true,
        "doneType": "string",
        "latenessTime": 0,
        "sortingPreference": {},
        "cardsCanBeMovedToPhase": [
            "string"
        ],
        "flowId": "string"
    }
]
Modificado em 2026-07-29 12:58:18
Página anterior
List phase actions
Próxima página
Update phase action
Built with