> ## Documentation Index > Fetch the complete documentation index at: https://docs.base39.com.br/llms.txt > Use this file to discover all available pages before exploring further. # Execute a dataset query ## OpenAPI ````yaml /api-reference/openapi.json post /v2/queries openapi: 3.1.0 info: title: Base39 API description: Base39 API version: 1.0.0 contact: name: Base39 Team url: https://base39.com.br email: suporte@base39.com.br termsOfService: https://base39.com.br/termos license: name: Proprietary url: https://base39.com.br/termos servers: - url: http://localhost:3000 description: Local - url: https://api.dev.base39.cloud description: Development - url: https://api.base39.com.br description: Production security: - OAuth2: [] tags: - name: pages description: Profiles and reports pages - name: pipelines description: Pipeline boards (kanban) of pages - name: blocks description: Blocks operations - name: search description: Search across content - name: targets description: Lookup targets via datasets - name: CognitoTriggers description: Cognito triggers paths: /v2/queries: post: tags: - queries summary: Execute a dataset query operationId: query_create_query parameters: - name: expand required: false in: query description: Comma-separated fields to expand (e.g., "dataset") schema: type: string - name: fields required: false in: query description: >- Comma-separated optional response fields. Supports "summary.short", "summary.long", and "summary.mdx". schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateQuery' responses: '200': description: Query results content: application/json: schema: $ref: '#/components/schemas/Query' '502': description: Query execution failed content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' components: schemas: CreateQuery: type: object properties: dataset: type: string description: Dataset slug to query example: empresas params: description: Query parameters. Varies by dataset. oneOf: - $ref: '#/components/schemas/DatasetAcordosDeLenienciaInputSchema' - $ref: '#/components/schemas/DatasetActivityIndicatorsInputSchema' - $ref: '#/components/schemas/DatasetAddressRiskInputSchema' - $ref: '#/components/schemas/DatasetAddressesExtendedInputSchema' - $ref: >- #/components/schemas/DatasetAmlAntiMoneyLaunderingVinculosSocietariosInputSchema - $ref: '#/components/schemas/DatasetAntifraudeChavePixInputSchema' - $ref: >- #/components/schemas/DatasetAnttConsultaDeRegularidadeDaTransportadoraInputSchema - $ref: >- #/components/schemas/DatasetApfRuralAutorizacaoProvisoriaDeFuncionamentoRuralInputSchema - $ref: '#/components/schemas/DatasetAppsNetworksAndPlatformsInputSchema' - $ref: '#/components/schemas/DatasetArchaeologicalSitesInputSchema' - $ref: '#/components/schemas/DatasetAuxilioEmergencialInputSchema' - $ref: '#/components/schemas/DatasetAuxilioReconstrucaoInputSchema' - $ref: '#/components/schemas/DatasetAvailabilityDataInputSchema' - $ref: '#/components/schemas/DatasetAwardsAndCertificationsInputSchema' - $ref: >- #/components/schemas/DatasetBancoCentralQuadroGeralDeInabilitadosInputSchema - $ref: >- #/components/schemas/DatasetBancoCentralQuadroGeralDeProibidosInputSchema - $ref: >- #/components/schemas/DatasetBasicDataWithConfigurableRecencyInputSchema - $ref: '#/components/schemas/DatasetBasicDataInputSchema' - $ref: '#/components/schemas/DatasetBeneficiarioFinalInputSchema' - $ref: >- #/components/schemas/DatasetBeneficioDePrestacaoContinuadaBpcInputSchema - $ref: >- #/components/schemas/DatasetBeneficiosSociaisPessoaFisicaInputSchema - $ref: '#/components/schemas/DatasetBetSafeComplianceInputSchema' - $ref: '#/components/schemas/DatasetBiomesDataInputSchema' - $ref: >- #/components/schemas/DatasetBoaVistaAcertaCompletoPositivoPessoaFisicaInputSchema - $ref: >- #/components/schemas/DatasetBoaVistaAcertaMaisPositivoPessoaFisicaInputSchema - $ref: >- #/components/schemas/DatasetBoaVistaDefineLimitePositivoPessoaJuridicaInputSchema - $ref: >- #/components/schemas/DatasetBoaVistaRiscoPositivoPessoaJuridicaInputSchema - $ref: '#/components/schemas/DatasetBolsaFamiliaInputSchema' - $ref: '#/components/schemas/DatasetBusinessRelationshipsInputSchema' - $ref: >- #/components/schemas/DatasetCadastroPessoaFisicaBasicaInputSchema - $ref: '#/components/schemas/DatasetCadastroPessoaFisicaPlusInputSchema' - $ref: >- #/components/schemas/DatasetCadastroPessoaJuridicaBasicaInputSchema - $ref: >- #/components/schemas/DatasetCadastroPessoaJuridicaPlusInputSchema - $ref: >- #/components/schemas/DatasetCadastroReceitaFederalPessoaFisicaInputSchema - $ref: '#/components/schemas/DatasetCadeProcessesDataInputSchema' - $ref: >- #/components/schemas/DatasetCadinSecretariaDaFazendaDeSaoPauloInputSchema - $ref: '#/components/schemas/DatasetCadinSecretariaDaFazendaInputSchema' - $ref: >- #/components/schemas/DatasetCafCadastroNacionalDeAgriculturaFamiliarPfInputSchema - $ref: >- #/components/schemas/DatasetCafCadastroNacionalDeAgriculturaFamiliarPjInputSchema - $ref: >- #/components/schemas/DatasetCafirCadastrosDeImoveisRuraisInputSchema - $ref: '#/components/schemas/DatasetCarCadastroAmbientalRuralInputSchema' - $ref: >- #/components/schemas/DatasetCarfConselhoAdministrativoDeRecursosFiscaisInputSchema - $ref: >- #/components/schemas/DatasetCcdCertidaoConjuntaDeDebitosPessoaFisicaInputSchema - $ref: >- #/components/schemas/DatasetCcdCertidaoConjuntaDeDebitosPessoaJuridicaComComprovanteProviderInputSchema - $ref: >- #/components/schemas/DatasetCcdCertidaoConjuntaDeDebitosPessoaJuridicaComComprovanteInputSchema - $ref: >- #/components/schemas/DatasetCcdCertidaoConjuntaDeDebitosPessoaJuridicaInputSchema - $ref: >- #/components/schemas/DatasetCeafCadastroDeExpulsoesDaAdministracaoFederalInputSchema - $ref: >- #/components/schemas/DatasetCeisCadastroDeEmpresasInidoneasESuspensasInputSchema - $ref: >- #/components/schemas/DatasetCepimCadastroDeEntidadesPrivadasSemFinsLucrativosImpedidasInputSchema - $ref: '#/components/schemas/DatasetCertificadoAnbimaEduInputSchema' - $ref: '#/components/schemas/DatasetCirclesBuildingInputSchema' - $ref: '#/components/schemas/DatasetCirclesCollegeClassInputSchema' - $ref: '#/components/schemas/DatasetCirclesCoworkersInputSchema' - $ref: '#/components/schemas/DatasetCirclesEmployeesInputSchema' - $ref: '#/components/schemas/DatasetCirclesFirstLevelOwnersInputSchema' - $ref: >- #/components/schemas/DatasetCirclesFirstLevelRelativesInputSchema - $ref: '#/components/schemas/DatasetCirclesHouseholdInputSchema' - $ref: '#/components/schemas/DatasetCirclesLawsuitPartiesInputSchema' - $ref: >- #/components/schemas/DatasetCirclesLegalRepresentativesInputSchema - $ref: '#/components/schemas/DatasetCirclesNeighborsInputSchema' - $ref: '#/components/schemas/DatasetCirclesPartnersInputSchema' - $ref: '#/components/schemas/DatasetCirclesRelativesInputSchema' - $ref: '#/components/schemas/DatasetCivilConstructionDataInputSchema' - $ref: '#/components/schemas/DatasetClassOrganizationInputSchema' - $ref: >- #/components/schemas/DatasetCndCertidaoNegativaDeDebitosInputSchema - $ref: >- #/components/schemas/DatasetCndirCertidaoNegativaDeDebitosEDividaAtivaDaUniaoDeImovelRuralInputSchema - $ref: >- #/components/schemas/DatasetCndmCertidaoNegativaDeDebitosMunicipalInputSchema - $ref: >- #/components/schemas/DatasetCnepCadastroNacionalDeEmpresasPunidasInputSchema - $ref: >- #/components/schemas/DatasetCniaCadastroNacionalDeCondenacoesCiveisPorAtoDeImprobidadeAdministrativaEInelegibilidadeInputSchema - $ref: '#/components/schemas/DatasetCnjMandadosDePrisaoInputSchema' - $ref: '#/components/schemas/DatasetCollectionsInputSchema' - $ref: '#/components/schemas/DatasetCompaniesDataInputSchema' - $ref: '#/components/schemas/DatasetCompaniesStatisticsInputSchema' - $ref: '#/components/schemas/DatasetCompanyEvolutionInputSchema' - $ref: >- #/components/schemas/DatasetCompanyGroupBuildingActivityInputSchema - $ref: '#/components/schemas/DatasetCompanyGroupBuildingInputSchema' - $ref: '#/components/schemas/DatasetCompanyGroupDocumentrootInputSchema' - $ref: '#/components/schemas/DatasetCompanyGroupEmployedInputSchema' - $ref: >- #/components/schemas/DatasetCompanyGroupFamilyOwnershipInputSchema - $ref: >- #/components/schemas/DatasetCompanyGroupHouseholdActivityInputSchema - $ref: >- #/components/schemas/DatasetCompanyGroupHouseholdOwnersSurnameInputSchema - $ref: '#/components/schemas/DatasetCompanyGroupHouseholdInputSchema' - $ref: >- #/components/schemas/DatasetCompanyGroupLegalRepresentativeInputSchema - $ref: '#/components/schemas/DatasetCompanyGroupOfficialnameInputSchema' - $ref: '#/components/schemas/DatasetCompanyGroupOwnersInputSchema' - $ref: '#/components/schemas/DatasetCompanyGroupOwnershipInputSchema' - $ref: '#/components/schemas/DatasetCompanyGroupRfcontactInputSchema' - $ref: '#/components/schemas/DatasetCompanyGroupSuedInputSchema' - $ref: '#/components/schemas/DatasetCompanyGroupTradenameCityInputSchema' - $ref: '#/components/schemas/DatasetCompanyGroupTradenameInputSchema' - $ref: '#/components/schemas/DatasetCompanyBasicDataInputSchema' - $ref: '#/components/schemas/DatasetCompanyCertificateIrtInputSchema' - $ref: >- #/components/schemas/DatasetCompanyCertificateNegativeIbamaInputSchema - $ref: >- #/components/schemas/DatasetCompanyCertificateSiproquimInputSchema - $ref: >- #/components/schemas/DatasetCompanyCguNegativeCertificateInputSchema - $ref: >- #/components/schemas/DatasetCompanyCnjNegativeCertificateInputSchema - $ref: '#/components/schemas/DatasetCompanyCollectionsInputSchema' - $ref: '#/components/schemas/DatasetCompanyElectoralProvidersInputSchema' - $ref: '#/components/schemas/DatasetCompanyEmailsExtendedInputSchema' - $ref: '#/components/schemas/DatasetCompanyEmbargoedIbamaInputSchema' - $ref: '#/components/schemas/DatasetCompanyFgtsInputSchema' - $ref: >- #/components/schemas/DatasetCompanyGoogleAddressVerificationInputSchema - $ref: '#/components/schemas/DatasetCompanyOnlineAdsInputSchema' - $ref: '#/components/schemas/DatasetCompanyOwnersKycInputSchema' - $ref: '#/components/schemas/DatasetCompanyPgfnInputSchema' - $ref: >- #/components/schemas/DatasetCompanyPoliticalInvolvementInputSchema - $ref: '#/components/schemas/DatasetCompanyProcessesInputSchema' - $ref: '#/components/schemas/DatasetCompanyProtestsInputSchema' - $ref: >- #/components/schemas/DatasetCompanyRelatedPeopleAddressesInputSchema - $ref: >- #/components/schemas/DatasetCompanyRelatedPeopleEmailsInputSchema - $ref: '#/components/schemas/DatasetCompanySintegraInputSchema' - $ref: >- #/components/schemas/DatasetCompanyUnifiedModelingDataX10InputSchema - $ref: >- #/components/schemas/DatasetCompanyUnifiedModelingDataX15InputSchema - $ref: >- #/components/schemas/DatasetConfeaCreaConselhoFederalDeEngenhariaEAgronomiaInputSchema - $ref: '#/components/schemas/DatasetConservationUnitsInputSchema' - $ref: >- #/components/schemas/DatasetConsultaVeicularFrotasPfEPjInputSchema - $ref: '#/components/schemas/DatasetConsultaVeicularInputSchema' - $ref: >- #/components/schemas/DatasetConsultoriaGeralDaUniaoCguInputSchema - $ref: '#/components/schemas/DatasetCorreiosBuscaCepInputSchema' - $ref: '#/components/schemas/DatasetCountiesMapInputSchema' - $ref: '#/components/schemas/DatasetCriminalStatisticsDataInputSchema' - $ref: >- #/components/schemas/DatasetCvmComissaoDeValoresMobiliariosInputSchema - $ref: >- #/components/schemas/DatasetCvmProcessosAdministrativosSancionadoresInputSchema - $ref: >- #/components/schemas/DatasetDapDeclaracaoDeAptidaoAoPronafPessoaFisicaInputSchema - $ref: >- #/components/schemas/DatasetDapDeclaracaoDeAptidaoAoPronafPessoaJuridicaInputSchema - $ref: '#/components/schemas/DatasetDemographicDataInputSchema' - $ref: '#/components/schemas/DatasetDetalhamentoNegativoInputSchema' - $ref: '#/components/schemas/DatasetDomainRegistroBrInputSchema' - $ref: '#/components/schemas/DatasetDomainsExtendedInputSchema' - $ref: '#/components/schemas/DatasetDynamicQsaDataInputSchema' - $ref: >- #/components/schemas/DatasetEconomicGroupFirstLevelExtendedInputSchema - $ref: '#/components/schemas/DatasetEconomicGroupFirstLevelInputSchema' - $ref: '#/components/schemas/DatasetEconomicGroupFullExtendedInputSchema' - $ref: '#/components/schemas/DatasetEconomicGroupFullInputSchema' - $ref: '#/components/schemas/DatasetEconomicGroupKycInputSchema' - $ref: >- #/components/schemas/DatasetEconomicGroupRelationshipsInputSchema - $ref: >- #/components/schemas/DatasetEconomicGroupSecondLevelExtendedInputSchema - $ref: '#/components/schemas/DatasetEconomicGroupSecondLevelInputSchema' - $ref: >- #/components/schemas/DatasetEconomicGroupThirdLevelExtendedInputSchema - $ref: '#/components/schemas/DatasetEconomicGroupThirdLevelInputSchema' - $ref: '#/components/schemas/DatasetElectionCandidateDataInputSchema' - $ref: '#/components/schemas/DatasetElectoralDonorsInputSchema' - $ref: '#/components/schemas/DatasetElectoralProvidersInputSchema' - $ref: '#/components/schemas/DatasetEmailsExtendedInputSchema' - $ref: '#/components/schemas/DatasetEmbargoedAreasInputSchema' - $ref: >- #/components/schemas/DatasetEmployeesIndustrialPropertyInputSchema - $ref: '#/components/schemas/DatasetEmployeesKycInputSchema' - $ref: '#/components/schemas/DatasetEmpresasInputSchema' - $ref: '#/components/schemas/DatasetEmpresasGrupoInputSchema' - $ref: '#/components/schemas/DatasetEmpresasMartInputSchema' - $ref: >- #/components/schemas/DatasetEmpresasProcessosJudiciaisInputSchema - $ref: '#/components/schemas/DatasetEmpresasSociosInputSchema' - $ref: '#/components/schemas/DatasetEnriquecimentoDeLeadInputSchema' - $ref: >- #/components/schemas/DatasetEnvironmentalPreservationAreasInputSchema - $ref: '#/components/schemas/DatasetEuFinancialSanctionsListInputSchema' - $ref: '#/components/schemas/DatasetExtraInfoDataInputSchema' - $ref: '#/components/schemas/DatasetFamilyFinancialDataInputSchema' - $ref: '#/components/schemas/DatasetFamilyFinancialRiskInputSchema' - $ref: >- #/components/schemas/DatasetFamilyLawsuitsDistributionDataInputSchema - $ref: '#/components/schemas/DatasetFamilyOnlineParticipationInputSchema' - $ref: '#/components/schemas/DatasetFamilyPoliticalHistoryInputSchema' - $ref: '#/components/schemas/DatasetFamilySocialAssistanceInputSchema' - $ref: '#/components/schemas/DatasetFbiMostWantedInputSchema' - $ref: >- #/components/schemas/DatasetFgtsRegularidadeDoEmpregadorInputSchema - $ref: '#/components/schemas/DatasetFinancialDataInputSchema' - $ref: '#/components/schemas/DatasetFinancialInterestsInputSchema' - $ref: '#/components/schemas/DatasetFinancialMarketInputSchema' - $ref: '#/components/schemas/DatasetFinancialRiskInputSchema' - $ref: >- #/components/schemas/DatasetFincenFinancialCrimesEnforcementNetworkInputSchema - $ref: '#/components/schemas/DatasetFirstLevelRelativesKycInputSchema' - $ref: >- #/components/schemas/DatasetFirstLevelRelativesLawsuitDataInputSchema - $ref: '#/components/schemas/DatasetFlagsAndFeaturesInputSchema' - $ref: '#/components/schemas/DatasetGarantiaSafraInputSchema' - $ref: >- #/components/schemas/DatasetGoogleMapsDirectionsDirectionsInputSchema - $ref: >- #/components/schemas/DatasetGoogleMapsGeocodingGeocodeInputSchema - $ref: '#/components/schemas/DatasetGoogleMapsPlacesReviewsInputSchema' - $ref: '#/components/schemas/DatasetGoogleMapsStaticImageInputSchema' - $ref: >- #/components/schemas/DatasetGoogleMapsStreetviewStaticImageInputSchema - $ref: >- #/components/schemas/DatasetGooglePlacesDetailsEnterpriseInputSchema - $ref: >- #/components/schemas/DatasetGooglePlacesDetailsEnterpriseAtmosphereInputSchema - $ref: >- #/components/schemas/DatasetGooglePlacesDetailsEssentialsInputSchema - $ref: >- #/components/schemas/DatasetGooglePlacesDetailsEssentialsIdOnlyInputSchema - $ref: '#/components/schemas/DatasetGooglePlacesDetailsProInputSchema' - $ref: '#/components/schemas/DatasetGooglePlacesPhotosInputSchema' - $ref: >- #/components/schemas/DatasetGooglePlacesTextSearchEnterpriseInputSchema - $ref: >- #/components/schemas/DatasetGooglePlacesTextSearchEnterpriseAtmosphereInputSchema - $ref: >- #/components/schemas/DatasetGooglePlacesTextSearchEssentialsIdOnlyInputSchema - $ref: '#/components/schemas/DatasetGooglePlacesTextSearchProInputSchema' - $ref: '#/components/schemas/DatasetGovernmentDebtorsInputSchema' - $ref: '#/components/schemas/DatasetHistoricalBasicDataInputSchema' - $ref: '#/components/schemas/DatasetHistoricoDeVeiculosPfEPjInputSchema' - $ref: '#/components/schemas/DatasetHistoryBasicDataInputSchema' - $ref: >- #/components/schemas/DatasetIbamaCertidaoNegativaDeDebitosInputSchema - $ref: >- #/components/schemas/DatasetIbamaCertidaoNegativaDeEmbargoInputSchema - $ref: >- #/components/schemas/DatasetIbamaCertificadoDeRegularidadeInputSchema - $ref: >- #/components/schemas/DatasetIbamaConsultaDeAutuacoesAmbientaisInputSchema - $ref: '#/components/schemas/DatasetImagesDataInputSchema' - $ref: '#/components/schemas/DatasetIndebtednessQuestionInputSchema' - $ref: '#/components/schemas/DatasetIndigenousLandsDataInputSchema' - $ref: '#/components/schemas/DatasetIndustrialPropertyInputSchema' - $ref: '#/components/schemas/DatasetInfluenceDataInputSchema' - $ref: '#/components/schemas/DatasetInterestsAndBehaviorsInputSchema' - $ref: '#/components/schemas/DatasetInterpolInputSchema' - $ref: '#/components/schemas/DatasetInvestmentFundDataInputSchema' - $ref: '#/components/schemas/DatasetKycInputSchema' - $ref: >- #/components/schemas/DatasetLawsuitPartnerTelesignPhoneIdPortingHistoryPersonInputSchema - $ref: >- #/components/schemas/DatasetLawsuitPartnerTelesignPhoneIdPortingStatusPersonInputSchema - $ref: >- #/components/schemas/DatasetLawsuitPartnerTelesignPhoneIdStandardPersonInputSchema - $ref: >- #/components/schemas/DatasetLawsuitPartnerTelesignPhoneIdSubscriberStatusPersonInputSchema - $ref: >- #/components/schemas/DatasetLawsuitPartnerTelesignPhoneScorePersonInputSchema - $ref: '#/components/schemas/DatasetLawsuitsDistributionDataInputSchema' - $ref: '#/components/schemas/DatasetLegalAmazonInputSchema' - $ref: '#/components/schemas/DatasetLegalReserveInputSchema' - $ref: '#/components/schemas/DatasetLicensePlatesInputSchema' - $ref: '#/components/schemas/DatasetLicensesAndAuthorizationsInputSchema' - $ref: '#/components/schemas/DatasetLifeStagesInputSchema' - $ref: '#/components/schemas/DatasetMarketplaceDataInputSchema' - $ref: '#/components/schemas/DatasetMediaProfileAndExposureInputSchema' - $ref: '#/components/schemas/DatasetMerchantCategoryDataInputSchema' - $ref: >- #/components/schemas/DatasetMinisterioDoTrabalhoEDoEmpregoMteInfracoesTrabalhistasInputSchema - $ref: '#/components/schemas/DatasetMinisterioDoTrabalhoPisInputSchema' - $ref: >- #/components/schemas/DatasetMinisterioPublicoDoEstadoDeMatoGrossoMpmtProcedimentosInvestigatoriosExtrajudiciaisInputSchema - $ref: >- #/components/schemas/DatasetMinisterioPublicoFederalCertidaoNegativaInputSchema - $ref: >- #/components/schemas/DatasetMptMinisterioPublicoDoTrabalhoInputSchema - $ref: >- #/components/schemas/DatasetNfeNotaFiscalEletronicaCompletaInputSchema - $ref: >- #/components/schemas/DatasetNfeNotaFiscalEletronicaInutilizacoesInputSchema - $ref: >- #/components/schemas/DatasetNivelSocioeconomicoERendaEstimadaInputSchema - $ref: '#/components/schemas/DatasetObitoInputSchema' - $ref: '#/components/schemas/DatasetOccupationDataInputSchema' - $ref: '#/components/schemas/DatasetOfacSancoesInputSchema' - $ref: >- #/components/schemas/DatasetOndemandAdministrativeSanctionsPersonInputSchema - $ref: '#/components/schemas/DatasetOndemandAnttDataVehicleInputSchema' - $ref: '#/components/schemas/DatasetOndemandCartaosusPersonInputSchema' - $ref: '#/components/schemas/DatasetOndemandCdcitCompanyInputSchema' - $ref: >- #/components/schemas/DatasetOndemandCertDebtAbsenceByStateCompanyInputSchema - $ref: >- #/components/schemas/DatasetOndemandCertDebtAbsenceByStatePersonInputSchema - $ref: >- #/components/schemas/DatasetOndemandCertLaborDebtAbsenceCompanyInputSchema - $ref: '#/components/schemas/DatasetOndemandCertRaisPersonInputSchema' - $ref: '#/components/schemas/DatasetOndemandComexCompanyInputSchema' - $ref: >- #/components/schemas/DatasetOndemandComprotProcessesCompanyInputSchema - $ref: >- #/components/schemas/DatasetOndemandComprotProcessesPersonInputSchema - $ref: '#/components/schemas/DatasetOndemandDataReceiptInputSchema' - $ref: '#/components/schemas/DatasetOndemandDetranDataVehicleInputSchema' - $ref: '#/components/schemas/DatasetOndemandEcdCompanyInputSchema' - $ref: >- #/components/schemas/DatasetOndemandEsocialCertificatePersonInputSchema - $ref: >- #/components/schemas/DatasetOndemandFreightServiceCertificateReceiptInputSchema - $ref: >- #/components/schemas/DatasetOndemandHealthInsurancePersonInputSchema - $ref: >- #/components/schemas/DatasetOndemandLaborLawsuitsCertificateCompanyInputSchema - $ref: >- #/components/schemas/DatasetOndemandLaborLawsuitsCertificatePersonInputSchema - $ref: >- #/components/schemas/DatasetOndemandLegalRepresentativeCompanyInputSchema - $ref: >- #/components/schemas/DatasetOndemandMunicipalRegistrationCompanyInputSchema - $ref: '#/components/schemas/DatasetOndemandNadaConstaPersonInputSchema' - $ref: >- #/components/schemas/DatasetOndemandPcAntecedenteByStatePersonInputSchema - $ref: >- #/components/schemas/DatasetOndemandPesquisaProtestoByStateCompanyInputSchema - $ref: >- #/components/schemas/DatasetOndemandPesquisaProtestoByStatePersonInputSchema - $ref: >- #/components/schemas/DatasetOndemandPfAntecedentePersonInputSchema - $ref: '#/components/schemas/DatasetOndemandPgmeiCompanyInputSchema' - $ref: '#/components/schemas/DatasetOndemandPisPersonInputSchema' - $ref: >- #/components/schemas/DatasetOndemandPoliceReportBoPersonInputSchema - $ref: >- #/components/schemas/DatasetOndemandPublicProjectsCompanyInputSchema - $ref: >- #/components/schemas/DatasetOndemandRaisConsultaCreaPersonInputSchema - $ref: >- #/components/schemas/DatasetOndemandRegularityCertificateIbamaCompanyInputSchema - $ref: '#/components/schemas/DatasetOndemandRestituicaoPersonInputSchema' - $ref: '#/components/schemas/DatasetOndemandRfQsaCompanyInputSchema' - $ref: '#/components/schemas/DatasetOndemandRfStatusCompanyInputSchema' - $ref: '#/components/schemas/DatasetOndemandRfStatusPersonInputSchema' - $ref: >- #/components/schemas/DatasetOndemandSanitaryLicenseCompanyInputSchema - $ref: >- #/components/schemas/DatasetOndemandSanitaryLicensePersonInputSchema - $ref: >- #/components/schemas/DatasetOndemandSeguroDesempregoPersonInputSchema - $ref: >- #/components/schemas/DatasetOndemandSicarStatementAddressInputSchema - $ref: >- #/components/schemas/DatasetOndemandSigefInstallmentsCompanyInputSchema - $ref: >- #/components/schemas/DatasetOndemandSigefInstallmentsPersonInputSchema - $ref: '#/components/schemas/DatasetOndemandSimplesCompanyInputSchema' - $ref: '#/components/schemas/DatasetOndemandSintegraCompanyV2InputSchema' - $ref: '#/components/schemas/DatasetOndemandSintegraCompanyInputSchema' - $ref: '#/components/schemas/DatasetOndemandSintegraPersonInputSchema' - $ref: >- #/components/schemas/DatasetOndemandTrafficTicketPersonInputSchema - $ref: >- #/components/schemas/DatasetOndemandTseElectoralDischargePersonInputSchema - $ref: >- #/components/schemas/DatasetOndemandTsePollingPlacePersonInputSchema - $ref: '#/components/schemas/DatasetOnlineAdsInputSchema' - $ref: '#/components/schemas/DatasetOnlineBettingComplianceInputSchema' - $ref: '#/components/schemas/DatasetOnlineBettingPropensityInputSchema' - $ref: '#/components/schemas/DatasetOnlinePresenceInputSchema' - $ref: '#/components/schemas/DatasetOwnersElectoralDonorsInputSchema' - $ref: '#/components/schemas/DatasetOwnersIndustrialPropertyInputSchema' - $ref: '#/components/schemas/DatasetOwnersInfluenceInputSchema' - $ref: >- #/components/schemas/DatasetOwnersLawsuitsDistributionDataInputSchema - $ref: '#/components/schemas/DatasetOwnersLawsuitsInputSchema' - $ref: '#/components/schemas/DatasetPartnerB2eScorePersonInputSchema' - $ref: >- #/components/schemas/DatasetPartnerB4bOptinContactPersonInputSchema - $ref: >- #/components/schemas/DatasetPartnerBlu365PhoneReportDataPersonInputSchema - $ref: >- #/components/schemas/DatasetPartnerBlu365PhoneScoreDataPersonInputSchema - $ref: >- #/components/schemas/DatasetPartnerFuellogFuelPricingDataAddressInputSchema - $ref: >- #/components/schemas/DatasetPartnerFuellogFuelPricingDataCompanyInputSchema - $ref: >- #/components/schemas/DatasetPartnerFuellogFuelPricingDataPersonInputSchema - $ref: >- #/components/schemas/DatasetPartnerGeofusionIntraurbanSegmentationCompanyInputSchema - $ref: >- #/components/schemas/DatasetPartnerGeofusionSociodemographicAndEconomicDataCompanyInputSchema - $ref: >- #/components/schemas/DatasetPartnerMurabeiCreditScoreCompanyInputSchema - $ref: '#/components/schemas/DatasetPartnerNetworkDataInputSchema' - $ref: >- #/components/schemas/DatasetPartnerPublicSafetyCompanyInputSchema - $ref: '#/components/schemas/DatasetPartnerPublicSafetyPersonInputSchema' - $ref: >- #/components/schemas/DatasetPartnerQuantumCustomScoreCompanyInputSchema - $ref: '#/components/schemas/DatasetPartnerQuantumScorePersonInputSchema' - $ref: >- #/components/schemas/DatasetPartnerQuodCreditRiskCompanyInputSchema - $ref: >- #/components/schemas/DatasetPartnerQuodCreditRiskDetailsCompanyInputSchema - $ref: >- #/components/schemas/DatasetPartnerQuodCreditRiskDetailsPersonInputSchema - $ref: >- #/components/schemas/DatasetPartnerQuodCreditRiskPersonInputSchema - $ref: >- #/components/schemas/DatasetPartnerQuodCreditScorePersonInputSchema - $ref: >- #/components/schemas/DatasetPartnerRedeVistoriasAddressInputSchema - $ref: >- #/components/schemas/DatasetPartnerScorepositivoCompanyFinanceInputSchema - $ref: >- #/components/schemas/DatasetPartnerScorepositivoIndividualFinanceInputSchema - $ref: >- #/components/schemas/DatasetPartnerUltimateBeneficialOwnersCompanyInputSchema - $ref: >- #/components/schemas/DatasetPartnerQuodCreditScoreCompanyInputSchema - $ref: '#/components/schemas/DatasetPassagesInputSchema' - $ref: >- #/components/schemas/DatasetPepEstendidaPessoaExpostaPoliticamenteParentescosInputSchema - $ref: >- #/components/schemas/DatasetPepPessoaExpostaPoliticamenteInputSchema - $ref: '#/components/schemas/DatasetPersonAddressesExtendedInputSchema' - $ref: >- #/components/schemas/DatasetPersonAwardsAndCertificationsInputSchema - $ref: '#/components/schemas/DatasetPersonBasicDataInputSchema' - $ref: >- #/components/schemas/DatasetPersonCguNegativeCertificateInputSchema - $ref: >- #/components/schemas/DatasetPersonCnjNegativeCertificateInputSchema - $ref: '#/components/schemas/DatasetPersonDomainsExtendedInputSchema' - $ref: '#/components/schemas/DatasetPersonElectoralDonorsInputSchema' - $ref: '#/components/schemas/DatasetPersonEmbargoedIbamaInputSchema' - $ref: '#/components/schemas/DatasetPersonGovernmentDebtorsInputSchema' - $ref: '#/components/schemas/DatasetPersonIndustrialPropertyInputSchema' - $ref: '#/components/schemas/DatasetPersonKycInputSchema' - $ref: >- #/components/schemas/DatasetPersonLawsuitsDistributionDataInputSchema - $ref: >- #/components/schemas/DatasetPersonLicensesAndAuthorizationsInputSchema - $ref: >- #/components/schemas/DatasetPersonMediaProfileAndExposureInputSchema - $ref: >- #/components/schemas/DatasetPersonOndemandCertLaborDebtAbsencePersonInputSchema - $ref: >- #/components/schemas/DatasetPersonOndemandIbamaCertNegativaPersonInputSchema - $ref: >- #/components/schemas/DatasetPersonOndemandIrtCertificatePersonInputSchema - $ref: >- #/components/schemas/DatasetPersonOndemandRegularityCertificateIbamaPersonInputSchema - $ref: >- #/components/schemas/DatasetPersonOndemandSintegraPersonV2InputSchema - $ref: >- #/components/schemas/DatasetPersonPartnerQuantumCustomScorePersonInputSchema - $ref: '#/components/schemas/DatasetPersonPgfnInputSchema' - $ref: '#/components/schemas/DatasetPersonPhonesExtendedInputSchema' - $ref: '#/components/schemas/DatasetPersonProcessesInputSchema' - $ref: '#/components/schemas/DatasetPersonRegistrationDataInputSchema' - $ref: '#/components/schemas/DatasetPersonRelatedPeoplePhonesInputSchema' - $ref: >- #/components/schemas/DatasetPersonUnifiedModelingDataX10InputSchema - $ref: >- #/components/schemas/DatasetPersonUnifiedModelingDataX15InputSchema - $ref: >- #/components/schemas/DatasetPetiProgramaDeErradicacaoDoTrabalhoInfantilInputSchema - $ref: >- #/components/schemas/DatasetPgfnListaDeDevedoresDaUniaoConsultaDeDebitosEDividaAtivaInputSchema - $ref: '#/components/schemas/DatasetPhonesExtendedInputSchema' - $ref: >- #/components/schemas/DatasetPoliciaCivilAntecedentesCriminaisInputSchema - $ref: >- #/components/schemas/DatasetPoliciaRodoviariaFederalInfracoesInputSchema - $ref: '#/components/schemas/DatasetPoliticalInvolvementInputSchema' - $ref: '#/components/schemas/DatasetPoliticalRelationshipsInputSchema' - $ref: '#/components/schemas/DatasetPriceDataInputSchema' - $ref: '#/components/schemas/DatasetProcessMovementsInputSchema' - $ref: >- #/components/schemas/DatasetProcessosJudiciaisAgrupadaBaseInputSchema - $ref: >- #/components/schemas/DatasetProcessosJudiciaisCivelCriminalETrabalhistaNacionalCompletaInputSchema - $ref: >- #/components/schemas/DatasetProcessosJudiciaisCivelCriminalETrabalhistaNacionalResumidaInputSchema - $ref: '#/components/schemas/DatasetProductBasicDataInputSchema' - $ref: '#/components/schemas/DatasetProfessionDataInputSchema' - $ref: '#/components/schemas/DatasetProfessionalTurnoverInputSchema' - $ref: '#/components/schemas/DatasetPropertyBasicDataInputSchema' - $ref: >- #/components/schemas/DatasetProtestosNacionalIeptbOnlineInputSchema - $ref: >- #/components/schemas/DatasetProtestosSpConsultaDeProtestosNosCartoriosDeSaoPauloInputSchema - $ref: '#/components/schemas/DatasetQsaBetDataInputSchema' - $ref: '#/components/schemas/DatasetQuodInputSchema' - $ref: >- #/components/schemas/DatasetReceitaFederalPessoaFisicaConsultaCpfESituacaoCadastralInputSchema - $ref: >- #/components/schemas/DatasetReceitaFederalPessoaJuridicaConsultaCnpjESituacaoCadastralInputSchema - $ref: >- #/components/schemas/DatasetReceitaFederalPessoaJuridicaQsaParticipacaoSocietariaInputSchema - $ref: '#/components/schemas/DatasetRegistrationDataArgentinaInputSchema' - $ref: >- #/components/schemas/DatasetRegistrationDataBrazilConsultaDeDadosCadastraisEEmpresariaisInputSchema - $ref: >- #/components/schemas/DatasetRegistrationDataMexicoConsultaDeDadosCadastraisEEmpresariaisInputSchema - $ref: '#/components/schemas/DatasetRegistrationDataInputSchema' - $ref: >- #/components/schemas/DatasetRegistroNacionalDePoblacionCurpMexicoInputSchema - $ref: '#/components/schemas/DatasetRelatedPeopleAddressesInputSchema' - $ref: '#/components/schemas/DatasetRelatedPeopleEmailsInputSchema' - $ref: '#/components/schemas/DatasetRelatedPeoplePhonesInputSchema' - $ref: '#/components/schemas/DatasetRelatedPeopleInputSchema' - $ref: '#/components/schemas/DatasetRelatedProductDataInputSchema' - $ref: '#/components/schemas/DatasetRelationshipGraphInputSchema' - $ref: '#/components/schemas/DatasetRelationshipsInputSchema' - $ref: '#/components/schemas/DatasetReputationsAndReviewsInputSchema' - $ref: >- #/components/schemas/DatasetRestituicaoImpostoDeRendaIrpfInputSchema - $ref: '#/components/schemas/DatasetReviewDataInputSchema' - $ref: '#/components/schemas/DatasetScoreDeCreditoQuodInputSchema' - $ref: '#/components/schemas/DatasetScrAnaliticoResumoBacenInputSchema' - $ref: '#/components/schemas/DatasetScrDetalhadaResumoBacenInputSchema' - $ref: '#/components/schemas/DatasetScrInputSchema' - $ref: '#/components/schemas/DatasetSecurityDataInputSchema' - $ref: '#/components/schemas/DatasetSeguroDefesoInputSchema' - $ref: '#/components/schemas/DatasetSerasaConcentreInputSchema' - $ref: '#/components/schemas/DatasetSerasaCrednetInputSchema' - $ref: '#/components/schemas/DatasetSerasaRelatoInputSchema' - $ref: '#/components/schemas/DatasetSicarPropertyDataInputSchema' - $ref: '#/components/schemas/DatasetSimilarityArgentinaInputSchema' - $ref: >- #/components/schemas/DatasetSimilarityBrazilApiDeComparacaoEAnaliseDeDadosInputSchema - $ref: >- #/components/schemas/DatasetSimilarityMexicoValidacaoDeDadosCadastraisECurpInputSchema - $ref: '#/components/schemas/DatasetSimplesNacionalInputSchema' - $ref: >- #/components/schemas/DatasetSintegraCadastroCentralizadoDeContribuinteCccInputSchema - $ref: >- #/components/schemas/DatasetSintegraCadastrosEstaduaisInputSchema - $ref: '#/components/schemas/DatasetSocialAssistanceExtendedInputSchema' - $ref: '#/components/schemas/DatasetSocialConscienceInputSchema' - $ref: '#/components/schemas/DatasetSportsExposureInputSchema' - $ref: '#/components/schemas/DatasetSuframaCnpjInputSchema' - $ref: >- #/components/schemas/DatasetSugarcaneAgroecologicalZoningInputSchema - $ref: '#/components/schemas/DatasetSyndicateAgreementsInputSchema' - $ref: >- #/components/schemas/DatasetTcuCertidaoNegativaDeLicitanteInidoneoInputSchema - $ref: >- #/components/schemas/DatasetTcuCertidaoNegativaDeProcessoInputSchema - $ref: >- #/components/schemas/DatasetTcuConsultaConsolidadaDePessoaJuridicaApfInputSchema - $ref: >- #/components/schemas/DatasetTjCertidaoCivelCriminalEFiscalTribunalDeJusticaInputSchema - $ref: >- #/components/schemas/DatasetTjTribunalDeJusticaProcessosInputSchema - $ref: >- #/components/schemas/DatasetTrfTribunalRegionalFederalCertidaoCivelEleitoralOuCriminalInputSchema - $ref: >- #/components/schemas/DatasetTrtTribunalRegionalDoTrabalhoInputSchema - $ref: >- #/components/schemas/DatasetTseCertidaoDeQuitacaoEleitoralInputSchema - $ref: '#/components/schemas/DatasetTseSituacaoEleitoralInputSchema' - $ref: '#/components/schemas/DatasetTseTituloELocalDeVotacaoInputSchema' - $ref: >- #/components/schemas/DatasetTstCertidaoNegativaDeDebitosTrabalhistasInputSchema - $ref: >- #/components/schemas/DatasetUkHmTreasuryFinancialSanctionsInputSchema - $ref: '#/components/schemas/DatasetUniversityStudentDataInputSchema' - $ref: >- #/components/schemas/DatasetUnscclUnitedNationsSecurityCouncilConsolidatedListInputSchema - $ref: '#/components/schemas/DatasetVehiclesInputSchema' - $ref: '#/components/schemas/DatasetVeiculosFipeInputSchema' - $ref: >- #/components/schemas/DatasetVerificacaoDeEmpregadorTrabalhoForcadoInputSchema - $ref: '#/components/schemas/DatasetVinculoEmpregaticioInputSchema' - $ref: '#/components/schemas/DatasetVinculosSocietariosInputSchema' asOfDate: type: string description: Logical reference date for the query (YYYY-MM-DD) example: '2024-01-31' mock: description: >- Enable mock mode. Use true/"default" for default example, or specify example key (e.g., "outro_exemplo") oneOf: - type: boolean - type: string example: true requestId: type: string description: Request ID example: req_123 targetDocument: type: string description: >- Target document (CNPJ/CPF) for property mapping. Used when the query result does not contain the document identifier. example: '57778216000108' cache: type: boolean description: Enable caching. Set to false to bypass cache and force fresh data. example: false default: true parent: description: Parent dataset query reference. Child queries persist zero cost. allOf: - $ref: '#/components/schemas/QueryParentInput' export: type: string description: >- Export task dataset summary PDF. "background" starts async export; "wait" returns the download URL. enum: - background - wait - null nullable: true required: - dataset - params Query: type: object properties: object: type: string description: Object type identifier example: query enum: - query id: type: string description: Query execution ID example: qry_abc123 status: type: string description: Query execution status enum: - success - partial_success - error - pending dataset: description: Dataset being queried (minimal reference) allOf: - $ref: '#/components/schemas/DatasetRef' provider: description: Provider used for the query allOf: - $ref: '#/components/schemas/ProviderRef' asOfDate: type: string description: Date for which data is queried example: '2025-11-21' createdAt: type: string description: Query creation timestamp example: '2025-11-21T19:00:00.000Z' format: date-time createdBy: type: object description: Principal who created this query properties: object: type: string enum: - user - service_account example: user id: type: string example: usr_abc123 apiKeyId: type: string example: bsk_abc123 isMock: type: boolean description: Whether this is a mock query (testing mode) example: false cacheStatus: type: string enum: - hit - miss results: type: array items: type: object additionalProperties: true description: >- Query results. Each item follows the schema defined by the dataset being queried. requestId: type: string summary: description: >- Rendered query summary markdown or MDX when requested via ?fields=summary.short, summary.long, summary.mdx, and/or summary.mdx-list. Single format → string. Multiple formats → object { short, long, mdx, "mdx-list" }. oneOf: - type: string - type: object properties: short: type: string long: type: string mdx: type: string mdx-list: type: string attempts: type: number duration: type: number description: Query duration in milliseconds errorMessage: type: string rawParams: type: object description: Raw query parameters used for this query additionalProperties: true cost: type: number description: Query cost in cents (0 for cached queries) affectedCanonicalTargets: description: Canonical entity query targets impacted by this dataset execution. type: array items: $ref: '#/components/schemas/QueryCanonicalInvalidationTargetOutput' rawResponseProvider: type: array description: Raw provider response captured during query execution. items: type: object additionalProperties: true nullable: true parent: description: Parent dataset query reference allOf: - $ref: '#/components/schemas/QueryParentOutput' export: description: PDF export generated for this query allOf: - $ref: '#/components/schemas/QueryExportOutput' required: - object - status - dataset - asOfDate - createdAt - isMock - cacheStatus - results - rawParams ErrorResponse: type: object properties: object: type: string description: Object type identifier example: error enum: - error status: type: number description: HTTP status code example: 502 code: type: string description: Stable application error code example: upstream_error message: type: string description: Human-readable error message example: Upstream provider returned an error request_id: type: string description: Request identifier for support and trace correlation example: req_abc123 dataset: type: string description: Dataset slug related to the error example: scr query_id: type: string description: Persisted query identifier related to the error example: qry_abc123 required: - object - status - code - message DatasetAcordosDeLenienciaInputSchema: type: object properties: doc: type: string label: Documento description: Documento a ser consultado. Pode ser enviado com ou sem formatação. required: - doc DatasetActivityIndicatorsInputSchema: type: object properties: doc: type: string description: CNPJ da empresa pattern: >- ^([0-9A-Z]{12}[0-9]{2}|[0-9A-Z]{2}\.[0-9A-Z]{3}\.[0-9A-Z]{3}/[0-9A-Z]{4}-[0-9]{2})$ label: CNPJ referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetAddressRiskInputSchema: type: object properties: doc: type: string description: Documento de identificação label: Documento zipcode: type: string description: >- Código postal utilizado como referência geográfica do ponto consultado pattern: ^[0-9]{5}-[0-9]{3}$ label: CEP addressnumber: type: string description: >- Número do endereço utilizado para refinar a localização do ponto consultado referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetAddressesExtendedInputSchema: type: object properties: doc: type: string description: CNPJ da empresa pattern: >- ^([0-9A-Z]{12}[0-9]{2}|[0-9A-Z]{2}\.[0-9A-Z]{3}\.[0-9A-Z]{3}/[0-9A-Z]{4}-[0-9]{2})$ label: CNPJ type: type: string description: Tipo de endereço enum: - work - home isratified: type: string description: Indica se o endereço está ratificado enum: - 'true' - 'false' isactive: type: string description: Indica se o endereço está ativo enum: - 'true' - 'false' isrecent: type: string description: Indica se o endereço é recente enum: - 'true' - 'false' ismain: type: string description: Indica se o endereço é principal enum: - 'true' - 'false' state: type: string description: Sigla da unidade federativa zipcode: type: string description: CEP do endereço pattern: ^[0-9]{5}-[0-9]{3}$ label: CEP addressnumber: type: string description: >- Utilizado em conjunto com o CEP para auxiliar na construção do identificador de prédio (building code), aumentando a qualidade do resultado useRawRFData: type: string description: >- Instrui o sistema a retornar o endereço exatamente como capturado na Receita Federal, sem padronizações ou correções automáticas enum: - 'true' - 'false' referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: >- Quantidade máxima de registros retornados. Use o modificador .limit(x) no campo Datasets. label: Limite next: type: string description: >- Identificador da próxima página. Use o valor retornado em NextPageId com o modificador .next(x) no campo Datasets. label: Próxima página required: - doc DatasetAmlAntiMoneyLaunderingVinculosSocietariosInputSchema: type: object properties: doc: type: string label: Documento description: Documento a ser consultado. Pode ser enviado com ou sem formatação. required: - doc DatasetAntifraudeChavePixInputSchema: type: object properties: tipo: type: string description: O parâmetro TIPO deve ser enviado (CPF, CNPJ, EMAIL, TELEFONE). label: TIPO chave: type: string description: O parâmetro CHAVE pode ser enviado com qualquer outro. label: CHAVE documento: type: string description: O parâmetro DOCUMENTO pode ser enviado com ou sem formatação. label: DOCUMENTO required: - tipo - chave - documento DatasetAnttConsultaDeRegularidadeDaTransportadoraInputSchema: type: object properties: rntrc: type: string description: O parâmetro RNTRC é um conjunto de 9 números. label: RNTRC doc: type: string label: Documento description: Documento a ser consultado. Pode ser enviado com ou sem formatação. required: - rntrc - doc DatasetApfRuralAutorizacaoProvisoriaDeFuncionamentoRuralInputSchema: type: object properties: numerocar: type: string description: O parâmetro NumeroCAR pode ser enviado com ou sem formatação. label: NUMEROCAR numeroapf: type: string description: 'O parâmetro NumeroAPF pode ser enviado com ou sem formatação. ' label: NUMEROAPF doc: type: string label: Documento description: Documento a ser consultado. Pode ser enviado com ou sem formatação. required: - numerocar - numeroapf - doc DatasetAppsNetworksAndPlatformsInputSchema: type: object properties: doc: type: string description: Documento de identificação pattern: ^([0-9]{11}|[0-9]{3}\.[0-9]{3}\.[0-9]{3}-[0-9]{2})$ label: CPF name: type: string description: >- Utilize este parâmetro para definir o nome a ser utilizado pelas ferramentas de pesquisa de notícias. Ao informar este parâmetro com abreviações, apelidos ou o nome comum da pessoa, poderão ser retornadas uma maior variedade de resultados. Por padrão, é utilizado o nome completo do indivíduo consultado. label: Nome useregionalization: type: string description: >- Quando definido como true, são aplicadas configurações extras às pesquisas de notícias, de modo a dar preferência a resultados na língua portuguesa e dentro do domínio do Brasil. Isso pode reduzir resultados de outras nacionalidades e tornar a pesquisa mais específica e acertiva. (Padrão: true) enum: - 'true' - 'false' pagetitle: type: string description: Título retornado pela máquina de busca pagedescription: type: string description: Descrição retornada pela máquina de busca pageurl: type: string description: URL retornada pela máquina de busca appname: type: string description: O nome da plataforma ou app displayname: type: string description: O nome de exibição do perfil na plataforma username: type: string description: O nome do usuário cadastrado na plataforma referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetArchaeologicalSitesInputSchema: type: object properties: zipcode: type: string description: zipcode pattern: ^[0-9]{5}-[0-9]{3}$ label: CEP polygon: type: string description: Polígono geográfico utilizado para delimitar a área de análise householdcode: type: string description: Identificador geográfico de residência buildingcode: type: string description: Identificador geográfico de edificação latitude: type: number description: Coordenadas do ponto de consulta (devem ser informadas em conjunto) longitude: type: number description: Coordenadas do ponto de consulta (devem ser informadas em conjunto) referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - zipcode DatasetAuxilioEmergencialInputSchema: type: object properties: nis: type: string description: O parâmetro NIS pode ser enviado com ou sem formatação. label: NIS doc: type: string label: Documento description: Documento a ser consultado. Pode ser enviado com ou sem formatação. required: - nis - doc DatasetAuxilioReconstrucaoInputSchema: type: object properties: nis: type: string description: O parâmetro NIS pode ser enviado com ou sem formatação. label: NIS doc: type: string label: Documento description: Documento a ser consultado. Pode ser enviado com ou sem formatação. required: - nis - doc DatasetAvailabilityDataInputSchema: type: object properties: ean: type: string description: Número do código de barras label: Código de Barras (EAN) isbn: type: string description: International Standard Book Number brand: type: string description: Marca dos produtos category: type: string description: Categoria de produtos searchterms: type: string description: Pesquisa de palavras-chaves referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite next: type: string description: >- Identificador da próxima página. Use o valor retornado em NextPageId com o modificador .next(x) no campo Datasets. label: Próxima página required: - ean DatasetAwardsAndCertificationsInputSchema: type: object properties: doc: type: string description: CNPJ da empresa pattern: >- ^([0-9A-Z]{12}[0-9]{2}|[0-9A-Z]{2}\.[0-9A-Z]{3}\.[0-9A-Z]{3}/[0-9A-Z]{4}-[0-9]{2})$ label: CNPJ awardname: type: string description: Nome do prêmio awardingorganizationname: type: string description: Nome da organização que concedeu o prêmio certificationname: type: string description: Nome da certificação certifyingentity: type: string description: Nome da entidade certificadora certificationstatus: type: string description: Status da certificação referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: >- Quantidade máxima de registros retornados. Use o modificador .limit(x) no campo Datasets. label: Limite required: - doc DatasetBancoCentralQuadroGeralDeInabilitadosInputSchema: type: object properties: doc: type: string label: Documento description: Documento a ser consultado. Pode ser enviado com ou sem formatação. required: - doc DatasetBancoCentralQuadroGeralDeProibidosInputSchema: type: object properties: doc: type: string label: Documento description: Documento a ser consultado. Pode ser enviado com ou sem formatação. required: - doc DatasetBasicDataWithConfigurableRecencyInputSchema: type: object properties: doc: type: string description: CPF da pessoa (apenas números) pattern: ^([0-9]{11}|[0-9]{3}\.[0-9]{3}\.[0-9]{3}-[0-9]{2})$ label: CPF max_days_since_update: type: integer description: >- Define o tempo máximo, em dias, desde a última atualização aceita para os dados minimum: 7 default: 30 name: type: string description: Permite comparar o nome informado com o nome encontrado na base label: Nome mothername: type: string description: Permite comparar o nome da mãe informado com o encontrado na base fathername: type: string description: Permite comparar o nome do pai informado com o encontrado na base referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetBasicDataInputSchema: type: object properties: processnumber: type: string description: Número do processo a consultar label: Número do Processo referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - processnumber DatasetBeneficiarioFinalInputSchema: type: object properties: doc: type: string label: Documento description: Documento a ser consultado. Pode ser enviado com ou sem formatação. required: - doc DatasetBeneficioDePrestacaoContinuadaBpcInputSchema: type: object properties: nis: type: string description: O parâmetro NIS pode ser enviado com ou sem formatação. label: NIS doc: type: string label: Documento description: Documento a ser consultado. Pode ser enviado com ou sem formatação. required: [] DatasetBeneficiosSociaisPessoaFisicaInputSchema: type: object properties: doc: type: string label: Documento description: Documento a ser consultado. Pode ser enviado com ou sem formatação. required: - doc DatasetBetSafeComplianceInputSchema: type: object properties: doc: type: string label: Documento description: Documento a ser consultado. Pode ser enviado com ou sem formatação. required: [] DatasetBiomesDataInputSchema: type: object properties: zipcode: type: string description: zipcode pattern: ^[0-9]{5}-[0-9]{3}$ label: CEP householdcode: type: string description: Identificador geográfico de residência buildingcode: type: string description: Identificador geográfico de edificação state: type: string description: Unidade federativa utilizada para delimitação territorial city: type: string description: Nome da cidade utilizada na consulta cities: type: string description: Lista de cidades para análise conjunta polygon: type: string description: Polígono geográfico utilizado para delimitar a área de análise geocode: type: string description: Identificador geográfico oficial referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - zipcode DatasetBoaVistaAcertaCompletoPositivoPessoaFisicaInputSchema: type: object properties: doc: type: string description: O parâmetro pode ser enviado com ou sem formatação. label: Documento required: [] DatasetBoaVistaAcertaMaisPositivoPessoaFisicaInputSchema: type: object properties: doc: type: string pattern: ^(?:\d{11}|\d{3}\.\d{3}\.\d{3}-\d{2})$ description: O parâmetro pode ser enviado com ou sem formatação. label: Documento required: - doc DatasetBoaVistaDefineLimitePositivoPessoaJuridicaInputSchema: type: object properties: doc: type: string label: Documento description: Documento a ser consultado. Pode ser enviado com ou sem formatação. required: - doc DatasetBoaVistaRiscoPositivoPessoaJuridicaInputSchema: type: object properties: doc: type: string pattern: ^(?:\d{14}|\d{2}\.\d{3}\.\d{3}/\d{4}-\d{2})$ description: O parâmetro pode ser enviado com ou sem formatação. label: Documento required: - doc DatasetBolsaFamiliaInputSchema: type: object properties: anocompetencia: type: string description: 'O parâmetro ANOCOMPETENCIA deve conter os 4 dígitos. Ex: 2024.' label: ANOCOMPETENCIA mescompetencia: type: string description: O parâmetro MESCOMPETENCIA deve ser de 01 até 12. label: MESCOMPETENCIA anoreferencia: type: string description: 'O parâmetro ANOREFERENCIA deve conter os 4 dígitos. Ex: 2024.' label: ANOREFERENCIA mesreferencia: type: string description: O parâmetro MESREFERENCIA deve ser de 01 até 12. label: MESREFERENCIA nis: type: string description: O parâmetro NIS pode ser enviado com ou sem formatação. label: NIS required: - anocompetencia - mescompetencia - anoreferencia - mesreferencia - nis DatasetBusinessRelationshipsInputSchema: type: object properties: doc: type: string description: Documento de identificação pattern: ^([0-9]{11}|[0-9]{3}\.[0-9]{3}\.[0-9]{3}-[0-9]{2})$ label: CPF birthdate: type: string description: Data de Nascimento pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ label: Data de Nascimento dateformat: type: string description: Formato da Data enum: - yyyy-MM-dd - dd/MM/yyyy label: Formato da Data relationshiptype: type: string description: Tipo do relacionamento enum: - employment - partner - ownership - legal representative relationshiplevel: type: string description: Nível do relacionamento enum: - DIRECT - SECOND-LEVEL - THIRD-LEVEL relatedentitytaxidtype: type: string description: Tipo do documento relacionado enum: - CPF - CNPJ iscurrentlyactive: type: string description: Flag de relacionamento ativo enum: - 'true' - 'false' referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: >- Quantidade máxima de registros retornados. Use o modificador .limit(x) no campo Datasets. label: Limite next: type: string description: >- Identificador da próxima página. Use o valor retornado em NextPageId com o modificador .next(x) no campo Datasets. label: Próxima página required: - doc DatasetCadastroPessoaFisicaBasicaInputSchema: type: object properties: doc: type: string label: Documento description: Documento a ser consultado. Pode ser enviado com ou sem formatação. required: - doc DatasetCadastroPessoaFisicaPlusInputSchema: type: object properties: doc: type: string label: Documento description: Documento a ser consultado. Pode ser enviado com ou sem formatação. required: - doc DatasetCadastroPessoaJuridicaBasicaInputSchema: type: object properties: doc: type: string label: Documento description: Documento a ser consultado. Pode ser enviado com ou sem formatação. required: - doc DatasetCadastroPessoaJuridicaPlusInputSchema: type: object properties: doc: type: string label: Documento description: Documento a ser consultado. Pode ser enviado com ou sem formatação. required: - doc DatasetCadastroReceitaFederalPessoaFisicaInputSchema: type: object properties: doc: type: string label: Documento description: Documento a ser consultado. Pode ser enviado com ou sem formatação. required: - doc DatasetCadeProcessesDataInputSchema: type: object properties: processnumber: type: string description: processnumber label: Número do Processo referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - processnumber DatasetCadinSecretariaDaFazendaDeSaoPauloInputSchema: type: object properties: doc: type: string label: Documento description: Documento a ser consultado. Pode ser enviado com ou sem formatação. required: - doc DatasetCadinSecretariaDaFazendaInputSchema: type: object properties: uf: type: string description: >- O(s) parâmetro(s) UF é(são) obrigatório(s) para esta consulta (AC, AL, AM, AP, BA, CE, DF, ES, GO, MA, MG, MS, MT, PA, PB, PE, PI, PR, RJ, RN, RO, RR, RS, SC, SE, SP, TO). label: UF doc: type: string label: Documento description: Documento a ser consultado. Pode ser enviado com ou sem formatação. required: - uf - doc DatasetCafCadastroNacionalDeAgriculturaFamiliarPfInputSchema: type: object properties: doc: type: string label: Documento description: Documento a ser consultado. Pode ser enviado com ou sem formatação. required: - doc DatasetCafCadastroNacionalDeAgriculturaFamiliarPjInputSchema: type: object properties: doc: type: string label: Documento description: Documento a ser consultado. Pode ser enviado com ou sem formatação. required: - doc DatasetCafirCadastrosDeImoveisRuraisInputSchema: type: object properties: cib: type: string description: O parâmetro CIB pode ser enviado com ou sem formatação. label: CIB required: - cib DatasetCarCadastroAmbientalRuralInputSchema: type: object properties: numerocar: type: string description: O parâmetro NumeroCAR pode ser enviado com ou sem formatação. label: NUMEROCAR required: - numerocar DatasetCarfConselhoAdministrativoDeRecursosFiscaisInputSchema: type: object properties: doc: type: string label: Documento description: Documento a ser consultado. Pode ser enviado com ou sem formatação. required: - doc DatasetCcdCertidaoConjuntaDeDebitosPessoaFisicaInputSchema: type: object properties: doc: type: string label: Documento description: Documento a ser consultado. Pode ser enviado com ou sem formatação. required: - doc DatasetCcdCertidaoConjuntaDeDebitosPessoaJuridicaComComprovanteProviderInputSchema: type: object properties: doc: type: string label: Documento description: Documento a ser consultado. Pode ser enviado com ou sem formatação. uf: type: string label: UF description: Unidade federativa da matriz. pattern: ^[A-Z]{2}$ required: - doc - uf DatasetCcdCertidaoConjuntaDeDebitosPessoaJuridicaComComprovanteInputSchema: type: object properties: doc: type: string label: Documento description: CNPJ de qualquer estabelecimento da empresa, com ou sem formatação. required: - doc DatasetCcdCertidaoConjuntaDeDebitosPessoaJuridicaInputSchema: type: object properties: doc: type: string label: Documento description: Documento a ser consultado. Pode ser enviado com ou sem formatação. required: - doc DatasetCeafCadastroDeExpulsoesDaAdministracaoFederalInputSchema: type: object properties: doc: type: string label: Documento description: Documento a ser consultado. Pode ser enviado com ou sem formatação. required: - doc DatasetCeisCadastroDeEmpresasInidoneasESuspensasInputSchema: type: object properties: doc: type: string label: Documento description: Documento a ser consultado. Pode ser enviado com ou sem formatação. required: - doc DatasetCepimCadastroDeEntidadesPrivadasSemFinsLucrativosImpedidasInputSchema: type: object properties: doc: type: string label: Documento description: Documento a ser consultado. Pode ser enviado com ou sem formatação. required: - doc DatasetCertificadoAnbimaEduInputSchema: type: object properties: doc: type: string label: Documento description: Documento a ser consultado. Pode ser enviado com ou sem formatação. required: [] DatasetCirclesBuildingInputSchema: type: object properties: doc: type: string description: Documento de identificação pattern: ^([0-9]{11}|[0-9]{3}\.[0-9]{3}\.[0-9]{3}-[0-9]{2})$ label: CPF birthdate: type: string description: Data de Nascimento pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ label: Data de Nascimento dateformat: type: string description: Formato da Data enum: - yyyy-MM-dd - dd/MM/yyyy label: Formato da Data referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetCirclesCollegeClassInputSchema: type: object properties: doc: type: string description: Documento de identificação pattern: ^([0-9]{11}|[0-9]{3}\.[0-9]{3}\.[0-9]{3}-[0-9]{2})$ label: CPF birthdate: type: string description: Data de Nascimento pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ label: Data de Nascimento dateformat: type: string description: Formato da Data enum: - yyyy-MM-dd - dd/MM/yyyy label: Formato da Data referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetCirclesCoworkersInputSchema: type: object properties: doc: type: string description: Documento de identificação pattern: ^([0-9]{11}|[0-9]{3}\.[0-9]{3}\.[0-9]{3}-[0-9]{2})$ label: CPF birthdate: type: string description: Data de Nascimento pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ label: Data de Nascimento dateformat: type: string description: Formato da Data enum: - yyyy-MM-dd - dd/MM/yyyy label: Formato da Data referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetCirclesEmployeesInputSchema: type: object properties: doc: type: string description: Documento de identificação pattern: >- ^([0-9A-Z]{12}[0-9]{2}|[0-9A-Z]{2}\.[0-9A-Z]{3}\.[0-9A-Z]{3}/[0-9A-Z]{4}-[0-9]{2})$ label: CNPJ referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetCirclesFirstLevelOwnersInputSchema: type: object properties: doc: type: string description: Documento de identificação pattern: >- ^([0-9A-Z]{12}[0-9]{2}|[0-9A-Z]{2}\.[0-9A-Z]{3}\.[0-9A-Z]{3}/[0-9A-Z]{4}-[0-9]{2})$ label: CNPJ onlyactives: type: string description: >- Ao utilizar esta flag, serão retornadas apenas as informações agregadas referentes aos sócios atualmente ativos no quadro societário da empresa consultada. enum: - 'true' - 'false' referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetCirclesFirstLevelRelativesInputSchema: type: object properties: doc: type: string description: Documento de identificação pattern: ^([0-9]{11}|[0-9]{3}\.[0-9]{3}\.[0-9]{3}-[0-9]{2})$ label: CPF birthdate: type: string description: Data de Nascimento pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ label: Data de Nascimento dateformat: type: string description: Formato da Data enum: - yyyy-MM-dd - dd/MM/yyyy label: Formato da Data referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetCirclesHouseholdInputSchema: type: object properties: doc: type: string description: Documento de identificação pattern: ^([0-9]{11}|[0-9]{3}\.[0-9]{3}\.[0-9]{3}-[0-9]{2})$ label: CPF birthdate: type: string description: Data de Nascimento pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ label: Data de Nascimento dateformat: type: string description: Formato da Data enum: - yyyy-MM-dd - dd/MM/yyyy label: Formato da Data referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetCirclesLawsuitPartiesInputSchema: type: object properties: doc: type: string description: Documento de identificação pattern: ^([0-9]{11}|[0-9]{3}\.[0-9]{3}\.[0-9]{3}-[0-9]{2})$ label: CPF birthdate: type: string description: Data de Nascimento pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ label: Data de Nascimento dateformat: type: string description: Formato da Data enum: - yyyy-MM-dd - dd/MM/yyyy label: Formato da Data referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetCirclesLegalRepresentativesInputSchema: type: object properties: doc: type: string description: Documento de identificação pattern: >- ^([0-9A-Z]{12}[0-9]{2}|[0-9A-Z]{2}\.[0-9A-Z]{3}\.[0-9A-Z]{3}/[0-9A-Z]{4}-[0-9]{2})$ label: CNPJ referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetCirclesNeighborsInputSchema: type: object properties: doc: type: string description: Documento de identificação pattern: ^([0-9]{11}|[0-9]{3}\.[0-9]{3}\.[0-9]{3}-[0-9]{2})$ label: CPF birthdate: type: string description: Data de Nascimento pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ label: Data de Nascimento dateformat: type: string description: Formato da Data enum: - yyyy-MM-dd - dd/MM/yyyy label: Formato da Data referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetCirclesPartnersInputSchema: type: object properties: doc: type: string description: Documento de identificação pattern: ^([0-9]{11}|[0-9]{3}\.[0-9]{3}\.[0-9]{3}-[0-9]{2})$ label: CPF birthdate: type: string description: Data de Nascimento pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ label: Data de Nascimento dateformat: type: string description: Formato da Data enum: - yyyy-MM-dd - dd/MM/yyyy label: Formato da Data referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetCirclesRelativesInputSchema: type: object properties: doc: type: string description: Documento de identificação pattern: ^([0-9]{11}|[0-9]{3}\.[0-9]{3}\.[0-9]{3}-[0-9]{2})$ label: CPF birthdate: type: string description: Data de Nascimento pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ label: Data de Nascimento dateformat: type: string description: Formato da Data enum: - yyyy-MM-dd - dd/MM/yyyy label: Formato da Data referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetCivilConstructionDataInputSchema: type: object properties: doc: type: string description: CNPJ da empresa pattern: >- ^([0-9A-Z]{12}[0-9]{2}|[0-9A-Z]{2}\.[0-9A-Z]{3}\.[0-9A-Z]{3}/[0-9A-Z]{4}-[0-9]{2})$ label: CNPJ referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetClassOrganizationInputSchema: type: object properties: doc: type: string description: CPF da pessoa (apenas números) pattern: ^([0-9]{11}|[0-9]{3}\.[0-9]{3}\.[0-9]{3}-[0-9]{2})$ label: CPF organizationname: type: string description: Nome da entidade profissional ou conselho de classe organizationtype: type: string description: Tipo da organização enum: - CLASS ASSOCIATION - PROFESSIONAL ORGANIZATION organizationchapter: type: string description: Unidade federativa de registro status: type: string description: Situação do registro profissional enum: - ATIVO - BAIXADA - TRANSFERIDO - CANCELADO - INTERROMPIDO - REQUERIMENTO category: type: string description: Categoria ou habilitação profissional associada ao registro referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetCndCertidaoNegativaDeDebitosInputSchema: type: object properties: uf: type: string description: >- O(s) parâmetro(s) UF é(são) obrigatório(s) para esta consulta (AC, AL, AM, AP, BA, CE, DF, ES, GO, MA, MG, MS, MT, PA, PB, PE, PI, PR, RJ, RN, RO, RR, RS, SC, SE, SP, TO). label: UF ie: type: string description: O parâmetro IE pode ser enviado com ou sem formatação. label: IE doc: type: string label: Documento description: Documento a ser consultado. Pode ser enviado com ou sem formatação. required: - uf - doc allOf: - if: properties: uf: const: SP else: required: - ie DatasetCndirCertidaoNegativaDeDebitosEDividaAtivaDaUniaoDeImovelRuralInputSchema: type: object properties: cib: type: string description: O parâmetro CIB pode ser enviado com ou sem formatação. label: CIB required: - cib DatasetCndmCertidaoNegativaDeDebitosMunicipalInputSchema: type: object properties: municipio: type: string description: >- O parâmetro MUNICIPIO deve ser informado juntamente com a Unidade Federativa (MUNICIPIO-UF). label: MUNICIPIO im: type: string description: >- O parâmetro IM (Inscrição Municipal) pode ser enviado com ou sem formatação. label: IM doc: type: string label: Documento description: Documento a ser consultado. Pode ser enviado com ou sem formatação. required: - municipio - im - doc DatasetCnepCadastroNacionalDeEmpresasPunidasInputSchema: type: object properties: doc: type: string label: Documento description: Documento a ser consultado. Pode ser enviado com ou sem formatação. required: - doc DatasetCniaCadastroNacionalDeCondenacoesCiveisPorAtoDeImprobidadeAdministrativaEInelegibilidadeInputSchema: type: object properties: doc: type: string label: Documento description: Documento a ser consultado. Pode ser enviado com ou sem formatação. required: - doc DatasetCnjMandadosDePrisaoInputSchema: type: object properties: alcunha: type: string description: O parâmetro ALCUNHA pode ser enviado com qualquer outro. label: ALCUNHA nomepai: type: string description: O parâmetro NOMEPAI pode ser enviado com qualquer outro. label: NOMEPAI nomemae: type: string description: O parâmetro NOMEMAE pode ser enviado com qualquer outro. label: NOMEMAE nome: type: string description: O parâmetro NOMEPAI pode ser enviado com qualquer outro. label: NOME doc: type: string label: Documento description: Documento a ser consultado. Pode ser enviado com ou sem formatação. required: - nome - doc DatasetCollectionsInputSchema: type: object properties: doc: type: string description: CPF da pessoa (apenas números) pattern: ^([0-9]{11}|[0-9]{3}\.[0-9]{3}\.[0-9]{3}-[0-9]{2})$ label: CPF referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetCompaniesDataInputSchema: type: object properties: distance: type: string description: distance economicactivitycodes: type: string description: Código da atividade econômica legalnaturecodes: type: string description: Código da natureza jurídica namefilter: type: string description: Filtro pelo nome da empresa employeesrange: type: string description: Faixa de quantidade de funcionários enum: - ATE 01 - 002 A 005 - 006 A 009 - 010 A 019 - 020 A 049 - 050 A 099 - 100 A 499 - '>= 500' x-fern-enum: '>= 500': name: GreaterThanOrEqualTo500 taxidstatus: type: string description: Status cadastral da empresa referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: >- Quantidade máxima de registros retornados. Use o modificador .limit(x) no campo Datasets. label: Limite next: type: string description: >- Identificador da próxima página. Use o valor retornado em NextPageId com o modificador .next(x) no campo Datasets. label: Próxima página required: - distance DatasetCompaniesStatisticsInputSchema: type: object properties: zipcode: type: string description: zipcode pattern: ^[0-9]{5}-[0-9]{3}$ label: CEP referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - zipcode DatasetCompanyEvolutionInputSchema: type: object properties: doc: type: string description: CNPJ da empresa pattern: >- ^([0-9A-Z]{12}[0-9]{2}|[0-9A-Z]{2}\.[0-9A-Z]{3}\.[0-9A-Z]{3}/[0-9A-Z]{4}-[0-9]{2})$ label: CNPJ referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetCompanyGroupBuildingActivityInputSchema: type: object properties: doc: type: string description: Documento de identificação pattern: >- ^([0-9A-Z]{12}[0-9]{2}|[0-9A-Z]{2}\.[0-9A-Z]{3}\.[0-9A-Z]{3}/[0-9A-Z]{4}-[0-9]{2})$ label: CNPJ company_status: type: string description: Status da empresa head_subsidiary: type: string description: Indicador se a empresa é Matriz (H) ou Filial (S) tax_regime: type: string description: Natureza jurídica da empresa main_economic_Activity: type: string description: Código da atividade econômica da empresa company_size: type: string description: Porte da empresa referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetCompanyGroupBuildingInputSchema: type: object properties: doc: type: string description: Documento de identificação pattern: >- ^([0-9A-Z]{12}[0-9]{2}|[0-9A-Z]{2}\.[0-9A-Z]{3}\.[0-9A-Z]{3}/[0-9A-Z]{4}-[0-9]{2})$ label: CNPJ company_status: type: string description: Status do CNPJ na Receita Federal enum: - ATIVA - ATIVA - EMPRESA DOMICILIADA NO EXTERIOR - BAIXADA - CNPJ DOES NOT EXIST IN RECEITA FEDERAL DATABASE - INAPTA - NULA - NULA - EMPRESA DOMICILIADA NO EXTERIOR - SUSPENSA - SUSPENSA - EMPRESA DOMICILIADA NO EXTERIOR head_subsidiary: type: string description: Indica se a empresa é Matriz (H) ou Filial (S) enum: - H - S tax_regime: type: string description: Natureza jurídica da empresa enum: - EIRELI - EPP - ISENTO - LTDA - LUCRO PRESUMIDO - LUCRO REAL - ME - MEI - NAO ATIVA - S.A. - SIMPLES - ADMINISTRACAO PUBLICA main_economic_Activity: type: string description: Código da Atividade Econômica (CNAE) principal da empresa company_size: type: string description: Porte da empresa referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: >- Quantidade máxima de registros retornados. Use o modificador .limit(x) no campo Datasets. label: Limite next: type: string description: >- Identificador da próxima página. Use o valor retornado em NextPageId com o modificador .next(x) no campo Datasets. label: Próxima página required: - doc DatasetCompanyGroupDocumentrootInputSchema: type: object properties: doc: type: string description: Documento de identificação pattern: >- ^([0-9A-Z]{12}[0-9]{2}|[0-9A-Z]{2}\.[0-9A-Z]{3}\.[0-9A-Z]{3}/[0-9A-Z]{4}-[0-9]{2})$ label: CNPJ company_status: type: string description: Status da empresa head_subsidiary: type: string description: Indicador se a empresa é Matriz (H) ou Filial (S) tax_regime: type: string description: Natureza jurídica da empresa main_economic_Activity: type: string description: Código da atividade econômica da empresa company_size: type: string description: Porte da empresa referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetCompanyGroupEmployedInputSchema: type: object properties: doc: type: string description: Documento de identificação pattern: ^([0-9]{11}|[0-9]{3}\.[0-9]{3}\.[0-9]{3}-[0-9]{2})$ label: CPF birthdate: type: string description: Data de Nascimento pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ label: Data de Nascimento dateformat: type: string description: Formato da Data enum: - yyyy-MM-dd - dd/MM/yyyy label: Formato da Data company_status: type: string description: Status da empresa head_subsidiary: type: string description: Indicador se a empresa é Matriz (H) ou Filial (S) tax_regime: type: string description: Natureza jurídica da empresa main_economic_activity: type: string description: Código da atividade econômica da empresa company_size: type: string description: Porte da empresa referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetCompanyGroupFamilyOwnershipInputSchema: type: object properties: doc: type: string description: Documento de identificação pattern: ^([0-9]{11}|[0-9]{3}\.[0-9]{3}\.[0-9]{3}-[0-9]{2})$ label: CPF birthdate: type: string description: Data de Nascimento pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ label: Data de Nascimento dateformat: type: string description: Formato da Data enum: - yyyy-MM-dd - dd/MM/yyyy label: Formato da Data company_status: type: string description: Status da empresa head_subsidiary: type: string description: Indicador se a empresa é Matriz (H) ou Filial (S) tax_regime: type: string description: Natureza jurídica da empresa main_economic_activity: type: string description: Código da atividade econômica da empresa company_size: type: string description: Porte da empresa referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetCompanyGroupHouseholdActivityInputSchema: type: object properties: doc: type: string description: Documento de identificação pattern: >- ^([0-9A-Z]{12}[0-9]{2}|[0-9A-Z]{2}\.[0-9A-Z]{3}\.[0-9A-Z]{3}/[0-9A-Z]{4}-[0-9]{2})$ label: CNPJ company_status: type: string description: Status da empresa head_subsidiary: type: string description: Indicador se a empresa é Matriz (H) ou Filial (S) tax_regime: type: string description: Natureza jurídica da empresa main_economic_Activity: type: string description: Código da atividade econômica da empresa company_size: type: string description: Porte da empresa referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetCompanyGroupHouseholdOwnersSurnameInputSchema: type: object properties: doc: type: string description: Documento de identificação pattern: >- ^([0-9A-Z]{12}[0-9]{2}|[0-9A-Z]{2}\.[0-9A-Z]{3}\.[0-9A-Z]{3}/[0-9A-Z]{4}-[0-9]{2})$ label: CNPJ company_status: type: string description: Status da empresa head_subsidiary: type: string description: Indicador se a empresa é Matriz (H) ou Filial (S) tax_regime: type: string description: Natureza jurídica da empresa main_economic_Activity: type: string description: Código da atividade econômica da empresa company_size: type: string description: Porte da empresa referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetCompanyGroupHouseholdInputSchema: type: object properties: doc: type: string description: Documento de identificação pattern: >- ^([0-9A-Z]{12}[0-9]{2}|[0-9A-Z]{2}\.[0-9A-Z]{3}\.[0-9A-Z]{3}/[0-9A-Z]{4}-[0-9]{2})$ label: CNPJ company_status: type: string description: Status da empresa head_subsidiary: type: string description: Indicador se a empresa é Matriz (H) ou Filial (S) tax_regime: type: string description: Natureza jurídica da empresa main_economic_Activity: type: string description: Código da atividade econômica da empresa company_size: type: string description: Porte da empresa referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetCompanyGroupLegalRepresentativeInputSchema: type: object properties: doc: type: string description: Documento de identificação pattern: >- ^([0-9A-Z]{12}[0-9]{2}|[0-9A-Z]{2}\.[0-9A-Z]{3}\.[0-9A-Z]{3}/[0-9A-Z]{4}-[0-9]{2})$ label: CNPJ company_status: type: string description: Status da empresa head_subsidiary: type: string description: Indicador se a empresa é Matriz (H) ou Filial (S) tax_regime: type: string description: Natureza jurídica da empresa main_economic_Activity: type: string description: Código da atividade econômica da empresa company_size: type: string description: Porte da empresa referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetCompanyGroupOfficialnameInputSchema: type: object properties: doc: type: string description: Documento de identificação pattern: >- ^([0-9A-Z]{12}[0-9]{2}|[0-9A-Z]{2}\.[0-9A-Z]{3}\.[0-9A-Z]{3}/[0-9A-Z]{4}-[0-9]{2})$ label: CNPJ company_status: type: string description: Status da empresa head_subsidiary: type: string description: Indicador se a empresa é Matriz (H) ou Filial (S) tax_regime: type: string description: Natureza jurídica da empresa main_economic_Activity: type: string description: Código da atividade econômica da empresa company_size: type: string description: Porte da empresa referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetCompanyGroupOwnersInputSchema: type: object properties: doc: type: string description: Documento de identificação pattern: >- ^([0-9A-Z]{12}[0-9]{2}|[0-9A-Z]{2}\.[0-9A-Z]{3}\.[0-9A-Z]{3}/[0-9A-Z]{4}-[0-9]{2})$ label: CNPJ onlyactives: type: string description: >- Utilizando essa flag, serão retornados apenas os dados agregados de conjuntos de empresas que compartilham sócios atualmente ativos em seus respectivos quadros societários. enum: - 'true' - 'false' company_status: type: string description: Status da empresa head_subsidiary: type: string description: Indicador se a empresa é Matriz (H) ou Filial (S) tax_regime: type: string description: Natureza jurídica da empresa main_economic_Activity: type: string description: Código da atividade econômica da empresa company_size: type: string description: Porte da empresa referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetCompanyGroupOwnershipInputSchema: type: object properties: doc: type: string description: Documento de identificação pattern: ^([0-9]{11}|[0-9]{3}\.[0-9]{3}\.[0-9]{3}-[0-9]{2})$ label: CPF birthdate: type: string description: Data de Nascimento pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ label: Data de Nascimento dateformat: type: string description: Formato da Data enum: - yyyy-MM-dd - dd/MM/yyyy label: Formato da Data company_status: type: string description: Status da empresa head_subsidiary: type: string description: Indicador se a empresa é Matriz (H) ou Filial (S) tax_regime: type: string description: Natureza jurídica da empresa main_economic_activity: type: string description: Código da atividade econômica da empresa company_size: type: string description: Porte da empresa referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetCompanyGroupRfcontactInputSchema: type: object properties: doc: type: string description: Documento de identificação pattern: >- ^([0-9A-Z]{12}[0-9]{2}|[0-9A-Z]{2}\.[0-9A-Z]{3}\.[0-9A-Z]{3}/[0-9A-Z]{4}-[0-9]{2})$ label: CNPJ company_status: type: string description: Status da empresa head_subsidiary: type: string description: Indicador se a empresa é Matriz (H) ou Filial (S) tax_regime: type: string description: Natureza jurídica da empresa main_economic_Activity: type: string description: Código da atividade econômica da empresa company_size: type: string description: Porte da empresa referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetCompanyGroupSuedInputSchema: type: object properties: doc: type: string description: Documento de identificação pattern: ^([0-9]{11}|[0-9]{3}\.[0-9]{3}\.[0-9]{3}-[0-9]{2})$ label: CPF birthdate: type: string description: Data de Nascimento pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ label: Data de Nascimento dateformat: type: string description: Formato da Data enum: - yyyy-MM-dd - dd/MM/yyyy label: Formato da Data company_status: type: string description: Status da empresa head_subsidiary: type: string description: Indicador se a empresa é Matriz (H) ou Filial (S) tax_regime: type: string description: Natureza jurídica da empresa main_economic_activity: type: string description: Código da atividade econômica da empresa company_size: type: string description: Porte da empresa referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetCompanyGroupTradenameCityInputSchema: type: object properties: doc: type: string description: Documento de identificação pattern: >- ^([0-9A-Z]{12}[0-9]{2}|[0-9A-Z]{2}\.[0-9A-Z]{3}\.[0-9A-Z]{3}/[0-9A-Z]{4}-[0-9]{2})$ label: CNPJ company_status: type: string description: Status da empresa head_subsidiary: type: string description: Indicador se a empresa é Matriz (H) ou Filial (S) tax_regime: type: string description: Natureza jurídica da empresa main_economic_Activity: type: string description: Código da atividade econômica da empresa company_size: type: string description: Porte da empresa referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetCompanyGroupTradenameInputSchema: type: object properties: doc: type: string description: Documento de identificação pattern: >- ^([0-9A-Z]{12}[0-9]{2}|[0-9A-Z]{2}\.[0-9A-Z]{3}\.[0-9A-Z]{3}/[0-9A-Z]{4}-[0-9]{2})$ label: CNPJ company_status: type: string description: Status da empresa head_subsidiary: type: string description: Indicador se a empresa é Matriz (H) ou Filial (S) tax_regime: type: string description: Natureza jurídica da empresa main_economic_Activity: type: string description: Código da atividade econômica da empresa company_size: type: string description: Porte da empresa referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetCompanyBasicDataInputSchema: type: object properties: doc: type: string description: CNPJ da empresa pattern: >- ^([0-9A-Z]{12}[0-9]{2}|[0-9A-Z]{2}\.[0-9A-Z]{3}\.[0-9A-Z]{3}/[0-9A-Z]{4}-[0-9]{2})$ label: CNPJ referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetCompanyCertificateIrtInputSchema: type: object properties: doc: type: string description: CNPJ da empresa pattern: >- ^([0-9A-Z]{12}[0-9]{2}|[0-9A-Z]{2}\.[0-9A-Z]{3}\.[0-9A-Z]{3}/[0-9A-Z]{4}-[0-9]{2})$ label: CNPJ nirf: type: string description: >- Número do Imóvel na Receita Federal (NIRF) do imóvel rural a consultar label: NIRF referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc - nirf DatasetCompanyCertificateNegativeIbamaInputSchema: type: object properties: doc: type: string description: CNPJ da empresa pattern: >- ^([0-9A-Z]{12}[0-9]{2}|[0-9A-Z]{2}\.[0-9A-Z]{3}\.[0-9A-Z]{3}/[0-9A-Z]{4}-[0-9]{2})$ label: CNPJ referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetCompanyCertificateSiproquimInputSchema: type: object properties: doc: type: string description: CNPJ da empresa pattern: >- ^([0-9A-Z]{12}[0-9]{2}|[0-9A-Z]{2}\.[0-9A-Z]{3}\.[0-9A-Z]{3}/[0-9A-Z]{4}-[0-9]{2})$ label: CNPJ referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetCompanyCguNegativeCertificateInputSchema: type: object properties: doc: type: string description: CNPJ da empresa pattern: >- ^([0-9A-Z]{12}[0-9]{2}|[0-9A-Z]{2}\.[0-9A-Z]{3}\.[0-9A-Z]{3}/[0-9A-Z]{4}-[0-9]{2})$ label: CNPJ referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetCompanyCnjNegativeCertificateInputSchema: type: object properties: doc: type: string description: CNPJ da empresa pattern: >- ^([0-9A-Z]{12}[0-9]{2}|[0-9A-Z]{2}\.[0-9A-Z]{3}\.[0-9A-Z]{3}/[0-9A-Z]{4}-[0-9]{2})$ label: CNPJ referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetCompanyCollectionsInputSchema: type: object properties: doc: type: string description: CNPJ da empresa pattern: >- ^([0-9A-Z]{12}[0-9]{2}|[0-9A-Z]{2}\.[0-9A-Z]{3}\.[0-9A-Z]{3}/[0-9A-Z]{4}-[0-9]{2})$ label: CNPJ referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetCompanyElectoralProvidersInputSchema: type: object properties: doc: type: string description: CNPJ da empresa pattern: >- ^([0-9A-Z]{12}[0-9]{2}|[0-9A-Z]{2}\.[0-9A-Z]{3}\.[0-9A-Z]{3}/[0-9A-Z]{4}-[0-9]{2})$ label: CNPJ referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetCompanyEmailsExtendedInputSchema: type: object properties: doc: type: string description: CNPJ da empresa pattern: >- ^([0-9A-Z]{12}[0-9]{2}|[0-9A-Z]{2}\.[0-9A-Z]{3}\.[0-9A-Z]{3}/[0-9A-Z]{4}-[0-9]{2})$ label: CNPJ type: type: string description: Tipo do e-mail enum: - corporate - personal isactive: type: string description: Indica se o e-mail está ativo enum: - 'true' - 'false' isrecent: type: string description: Indica se o e-mail é recente enum: - 'true' - 'false' ismain: type: string description: Indica se o e-mail é principal enum: - 'true' - 'false' validationstatus: type: string description: Status de validação do e-mail enum: - VALID - ACCEPTALL - UNKNOWN - POSSIBLESPAM_TRAP - INVALID - HARDBOUNCE - RISKY - ACCEPT domain: type: string description: Domínio do e-mail email: type: string description: >- Permite informar um e-mail adicional para análise de informações globais do endereço, independentemente de associação direta com o CNPJ consultado. pattern: ^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}$ label: E-mail returnonlydifferentemails: type: string description: >- Define que apenas e-mails diferentes dos informados na consulta sejam retornados. enum: - 'true' - 'false' returnonlyvalidemails: type: string description: >- Define que apenas e-mails com status de validação considerado válido sejam retornados. enum: - 'true' - 'false' referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: >- Quantidade máxima de registros retornados. Use o modificador .limit(x) no campo Datasets. label: Limite required: - doc DatasetCompanyEmbargoedIbamaInputSchema: type: object properties: doc: type: string description: CNPJ da empresa pattern: >- ^([0-9A-Z]{12}[0-9]{2}|[0-9A-Z]{2}\.[0-9A-Z]{3}\.[0-9A-Z]{3}/[0-9A-Z]{4}-[0-9]{2})$ label: CNPJ referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetCompanyFgtsInputSchema: type: object properties: doc: type: string description: CNPJ da empresa pattern: >- ^([0-9A-Z]{12}[0-9]{2}|[0-9A-Z]{2}\.[0-9A-Z]{3}\.[0-9A-Z]{3}/[0-9A-Z]{4}-[0-9]{2})$ label: CNPJ referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetCompanyGoogleAddressVerificationInputSchema: type: object required: - doc properties: doc: type: string label: CNPJ description: CNPJ da empresa a ser verificada no Google Maps. mapZoom: type: number label: Zoom do Mapa description: 'Nível de zoom do mapa estático (1-21). Padrão: 16.' default: 16 mapSize: type: string label: Tamanho do Mapa description: >- Dimensões da imagem do mapa estático (ex: "600x300"). Padrão: 600x300. default: 600x300 streetviewSize: type: string label: Tamanho do Street View description: 'Dimensões da imagem do Street View. Padrão: 600x300.' default: 600x300 streetviewFov: type: number label: Campo de Visão do Street View description: 'Campo de visão da câmera (10 a 120). Padrão: 90.' default: 90 photosLimit: type: number label: Limite de Fotos description: 'Número máximo de fotos a retornar. Padrão: 10.' default: 10 photosMaxHeightPx: type: number label: Altura Máxima das Fotos description: 'Altura máxima de cada foto em pixels. Padrão: 800.' default: 800 photosMaxWidthPx: type: number label: Largura Máxima das Fotos description: 'Largura máxima de cada foto em pixels. Padrão: 800.' default: 800 DatasetCompanyOnlineAdsInputSchema: type: object properties: doc: type: string description: CNPJ da empresa pattern: >- ^([0-9A-Z]{12}[0-9]{2}|[0-9A-Z]{2}\.[0-9A-Z]{3}\.[0-9A-Z]{3}/[0-9A-Z]{4}-[0-9]{2})$ label: CNPJ referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: >- Quantidade máxima de registros retornados. Use o modificador .limit(x) no campo Datasets. label: Limite required: - doc DatasetCompanyOwnersKycInputSchema: type: object properties: doc: type: string description: CNPJ da empresa pattern: >- ^([0-9A-Z]{12}[0-9]{2}|[0-9A-Z]{2}\.[0-9A-Z]{3}\.[0-9A-Z]{3}/[0-9A-Z]{4}-[0-9]{2})$ label: CNPJ pep_level: type: string description: Nível de exposição política identificado. pep_job: type: string description: Cargo público associado à pessoa politicamente exposta. pep_motive: type: string description: Motivo da classificação como PEP. sanctions_source: type: string description: Fonte de origem da sanção ou restrição. sanctions_type: type: string description: Tipo de sanção ou restrição aplicada. minmatch: type: number minimum: 0 maximum: 100 description: >- Percentual mínimo de similaridade entre o nome da entidade consultada e o nome presente no registro de sanção a partir do qual o registro será considerado para determinar indicadores como IsCurrentlySanctioned, WasPreviouslySanctioned e contagens por período. Esta chave não restringe os registros retornados pelo dataset. referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: >- Quantidade máxima de registros retornados. Use o modificador .limit(x) no campo Datasets. label: Limite next: type: string description: >- Identificador da próxima página. Use o valor retornado em NextPageId com o modificador .next(x) no campo Datasets. label: Próxima página required: - doc DatasetCompanyPgfnInputSchema: type: object properties: doc: type: string description: CNPJ da empresa pattern: >- ^([0-9A-Z]{12}[0-9]{2}|[0-9A-Z]{2}\.[0-9A-Z]{3}\.[0-9A-Z]{3}/[0-9A-Z]{4}-[0-9]{2})$ label: CNPJ type: type: string default: status description: >- Tipo da consulta PGFN, onde list tem como fonte a Lista de Devedores e status a Receita Federal. Para obtenção do certificado em PDF, utilizar status. enum: - list - status referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetCompanyPoliticalInvolvementInputSchema: type: object properties: doc: type: string description: CNPJ da empresa pattern: >- ^([0-9A-Z]{12}[0-9]{2}|[0-9A-Z]{2}\.[0-9A-Z]{3}\.[0-9A-Z]{3}/[0-9A-Z]{4}-[0-9]{2})$ label: CNPJ referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetCompanyProcessesInputSchema: type: object properties: doc: type: string description: CNPJ da empresa pattern: >- ^([0-9A-Z]{12}[0-9]{2}|[0-9A-Z]{2}\.[0-9A-Z]{3}\.[0-9A-Z]{3}/[0-9A-Z]{4}-[0-9]{2})$ label: CNPJ name: type: string description: >- Razão social da empresa para consulta por nome quando o nome é suficientemente único label: Razão social capturedate: type: string description: Data de captura do processo pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ label: Data closedate: type: string description: Data de finalização, baixa ou arquivamento do processo pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ label: Data cnjsubject: type: string description: >- Número ou nome do assunto do processo no CNJ, conforme tabela oficial disponível no site do CNJ cnjproceduretype: type: string description: Número ou nome do tipo do processo no CNJ courtlevel: type: string description: Instância do processo enum: - '1' - '2' - '3' x-fern-enum: '1': name: Value1 '2': name: Value2 '3': name: Value3 courtname: type: string description: Nome do tribunal courttype: type: string description: Tipo de vara ou competência do processo enum: - CIVEL - CRIMINAL - TRIBUTARIA - PREVIDENCIARIA - TRABALHISTA - ESPECIAL CIVEL - ESPECIAL CRIMINAL - ADMINISTRATIVA - ELEITORAL - FAZENDA - ESPECIAL FAZENDA partypolarity: type: string description: Polaridade da parte no processo enum: - ACTIVE - PASSIVE - NEUTRAL partytype: type: string description: Tipo da parte no processo enum: - AUTHOR - DEFENDANT - CLAIMANT - CLAIMED - LAWYER - REPORTER - ATTORNEY - WITNESS - VICTIM - JUDGE - INMATE - OTHER noticedate: type: string description: Data de abertura ou distribuição do processo pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ label: Data state: type: string description: Estado de tramitação do processo (UF) status: type: string description: Status do processo enum: - ATIVO - DISTRIBUIDO - BAIXADO - APENSO - DECIDIDO - AUTUADO - EXECUCAO - FINALIZADO - ENCERRADO - EM GRAU DE RECURSO - REDISTRIBUIDO - TRANSITADO EM JULGADO - ARQUIVADO - JULGADO - INDEFINIDO - SUSPENSO resjudicatadate: type: string description: Data de trânsito em julgado pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ label: Data value: type: string description: Valor disputado no processo returnupdates: type: string description: >- Define se as movimentações dos processos devem ser retornadas, impactando diretamente o volume da resposta enum: - 'true' - 'false' applyFiltersToStats: type: string description: >- Indica se as estatísticas agregadas devem considerar os filtros aplicados na consulta enum: - 'true' - 'false' returncvmprocesses: type: string description: >- Define se processos administrativos da CVM devem ser incluídos no retorno, quando existentes. Processos da CVM possuem numeração específica e não retornam alguns campos, como CourtLevel e CourtType enum: - 'true' - 'false' updateslimit: type: integer description: >- Limita a quantidade de movimentações retornadas por processo, priorizadas pela recência minimum: 0 referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: >- Quantidade máxima de registros retornados. Use o modificador .limit(x) no campo Datasets. label: Limite next: type: string description: >- Identificador da próxima página. Use o valor retornado em NextPageId com o modificador .next(x) no campo Datasets. label: Próxima página required: [] DatasetCompanyProtestsInputSchema: type: object properties: doc: type: string description: Documento de identificação pattern: >- ^([0-9A-Z]{12}[0-9]{2}|[0-9A-Z]{2}\.[0-9A-Z]{3}\.[0-9A-Z]{3}/[0-9A-Z]{4}-[0-9]{2})$ label: CNPJ referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetCompanyRelatedPeopleAddressesInputSchema: type: object properties: doc: type: string description: Documento de identificação pattern: >- ^([0-9A-Z]{12}[0-9]{2}|[0-9A-Z]{2}\.[0-9A-Z]{3}\.[0-9A-Z]{3}/[0-9A-Z]{4}-[0-9]{2})$ label: CNPJ relationshiptype: type: string description: >- Permite recuperar somente os contatos de pessoas que tenham o tipo de relacionamento especificado enum: - QSA - Ownership - Employee - RepresentanteLegal type: type: string description: Tipo de endereço enum: - work - home isratified: type: string description: Se está ratificado enum: - 'true' - 'false' isactive: type: string description: Se está ativo enum: - 'true' - 'false' isrecent: type: string description: Se é recente enum: - 'true' - 'false' ismain: type: string description: Se é principal enum: - 'true' - 'false' state: type: string description: Sigla do estado zipcode: type: string description: Número do CEP pattern: ^[0-9]{5}-[0-9]{3}$ label: CEP referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: >- Quantidade máxima de registros retornados. Use o modificador .limit(x) no campo Datasets. label: Limite required: - doc DatasetCompanyRelatedPeopleEmailsInputSchema: type: object properties: doc: type: string description: Documento de identificação pattern: >- ^([0-9A-Z]{12}[0-9]{2}|[0-9A-Z]{2}\.[0-9A-Z]{3}\.[0-9A-Z]{3}/[0-9A-Z]{4}-[0-9]{2})$ label: CNPJ relationshiptype: type: string description: >- Este dataset suporta um parâmetro opcional, chamado relationshiptype, que permite recuperar somente os contatos de pessoas que tenham o tipo de relacionamento especificado enum: - QSA - Ownership - Employee - RepresentanteLegal type: type: string description: Tipo do e-mail enum: - corporate - personal isactive: type: string description: Se o email esta ativo enum: - 'true' - 'false' isrecent: type: string description: Se o email é recente enum: - 'true' - 'false' ismain: type: string description: Se o email é principal enum: - 'true' - 'false' validationstatus: type: string description: Status de validação enum: - VALID - ACCEPTALL - UNKNOWN - POSSIBLESPAM_TRAP - INVALID - HARDBOUNCE - RISKY - ACCEPT domain: type: string description: Domínio do email referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: >- Quantidade máxima de registros retornados. Use o modificador .limit(x) no campo Datasets. label: Limite required: - doc DatasetCompanySintegraInputSchema: type: object required: - state - doc properties: state: type: string label: Estado (UF) example: SP pattern: ^[A-Z]{2}$ maxLength: 2 minLength: 2 description: >- Sigla do estado (UF) para consulta. Estados disponíveis: AM-Amazonas, BA-Bahia, CE-Ceara, GO-Goias, MG-Minas Gerais, MS-Mato Grosso do Sul, MT-Mato Grosso, PR-Paraná, RS-Rio Grande do Sul, SP-São Paulo, AC-Acre, RN-Rio Grande do Norte, PB-Paraíba, SC-Santa Catarina e AL-Alagoas. doc: type: string label: Documento description: Documento a ser consultado. Pode ser enviado com ou sem formatação. DatasetCompanyUnifiedModelingDataX10InputSchema: type: object properties: doc: type: string description: CNPJ da empresa pattern: >- ^([0-9A-Z]{12}[0-9]{2}|[0-9A-Z]{2}\.[0-9A-Z]{3}\.[0-9A-Z]{3}/[0-9A-Z]{4}-[0-9]{2})$ label: CNPJ referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetCompanyUnifiedModelingDataX15InputSchema: type: object properties: doc: type: string description: CNPJ da empresa pattern: >- ^([0-9A-Z]{12}[0-9]{2}|[0-9A-Z]{2}\.[0-9A-Z]{3}\.[0-9A-Z]{3}/[0-9A-Z]{4}-[0-9]{2})$ label: CNPJ referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetConfeaCreaConselhoFederalDeEngenhariaEAgronomiaInputSchema: type: object properties: registronacional: type: string description: O parâmetro REGISTRONACIONAL pode ser enviado com ou sem formatação. label: REGISTRONACIONAL doc: type: string label: Documento description: Documento a ser consultado. Pode ser enviado com ou sem formatação. required: - registronacional - doc DatasetConservationUnitsInputSchema: type: object properties: zipcode: type: string description: zipcode pattern: ^[0-9]{5}-[0-9]{3}$ label: CEP polygon: type: string description: Polígono geográfico utilizado para delimitar a área de análise householdcode: type: string description: Identificador geográfico de residência buildingcode: type: string description: Identificador geográfico de edificação latitude: type: number description: Coordenadas do ponto de consulta (devem ser informadas em conjunto) longitude: type: number description: Coordenadas do ponto de consulta (devem ser informadas em conjunto) referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - zipcode DatasetConsultaVeicularFrotasPfEPjInputSchema: type: object properties: doc: type: string label: Documento description: Documento a ser consultado. Pode ser enviado com ou sem formatação. required: - doc DatasetConsultaVeicularInputSchema: type: object properties: placa: type: string description: O parâmetro PLACA pode ser enviado com ou sem formatação. label: PLACA required: - placa DatasetConsultoriaGeralDaUniaoCguInputSchema: type: object properties: tipo: type: string description: O parâmetro TIPO deve ser escolhido (AgentePúblico, EntePrivado). label: TIPO doc: type: string label: Documento description: Documento a ser consultado. Pode ser enviado com ou sem formatação. required: - tipo - doc DatasetCorreiosBuscaCepInputSchema: type: object properties: endereco: type: string description: '' label: ENDERECO required: - endereco DatasetCountiesMapInputSchema: type: object properties: zipcode: type: string description: zipcode pattern: ^[0-9]{5}-[0-9]{3}$ label: CEP polygon: type: string description: >- Permite definir manualmente a área geográfica de consulta por meio de um polígono de coordenadas longitude/latitude, utilizado para identificar os municípios com área de sobreposição referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - zipcode DatasetCriminalStatisticsDataInputSchema: type: object properties: zipcode: type: string description: zipcode pattern: ^[0-9]{5}-[0-9]{3}$ label: CEP uf: type: string description: Identificação explícita do município a ser analisado enum: - SP - RJ - MG label: UF city: type: string description: Identificação explícita do município a ser analisado polygon: type: string description: >- Área geográfica utilizada para identificar o município de referência da consulta latitude: type: number description: Coordenadas utilizadas para identificar o município de referência longitude: type: number description: Coordenadas utilizadas para identificar o município de referência referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - zipcode DatasetCvmComissaoDeValoresMobiliariosInputSchema: type: object properties: doc: type: string label: Documento description: Documento a ser consultado. Pode ser enviado com ou sem formatação. required: - doc DatasetCvmProcessosAdministrativosSancionadoresInputSchema: type: object properties: doc: type: string label: Documento description: Documento a ser consultado. Pode ser enviado com ou sem formatação. required: - doc DatasetDapDeclaracaoDeAptidaoAoPronafPessoaFisicaInputSchema: type: object properties: datanascimento: type: string description: >- O parâmetro DATANASCIMENTO deve ser fornecido, com ou sem formatação. label: DATANASCIMENTO doc: type: string label: Documento description: Documento a ser consultado. Pode ser enviado com ou sem formatação. required: - datanascimento - doc DatasetDapDeclaracaoDeAptidaoAoPronafPessoaJuridicaInputSchema: type: object properties: doc: type: string label: Documento description: Documento a ser consultado. Pode ser enviado com ou sem formatação. required: - doc DatasetDemographicDataInputSchema: type: object properties: doc: type: string description: CPF da pessoa (apenas números) pattern: ^([0-9]{11}|[0-9]{3}\.[0-9]{3}\.[0-9]{3}-[0-9]{2})$ label: CPF dataorigin: type: string description: Origem da pesquisa ou levantamento estatístico enum: - IBGE - MTE dataaggregationlevel: type: string description: Nível de agregação dos dados estatísticos datacountry: type: string description: País de referência da pesquisa referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetDetalhamentoNegativoInputSchema: type: object properties: doc: type: string label: Documento description: Documento a ser consultado. Pode ser enviado com ou sem formatação. required: - doc DatasetDomainRegistroBrInputSchema: type: object required: - domain properties: domain: type: string label: Domínio description: Domínio .br a ser consultado. example: base39.com.br pattern: >- ^(?=.{1,253}$)(?:[A-Za-z0-9](?:[A-Za-z0-9-]{0,61}[A-Za-z0-9])?\.)+br$ DatasetDomainsExtendedInputSchema: type: object properties: doc: type: string description: CNPJ da empresa pattern: >- ^([0-9A-Z]{12}[0-9]{2}|[0-9A-Z]{2}\.[0-9A-Z]{3}\.[0-9A-Z]{3}/[0-9A-Z]{4}-[0-9]{2})$ label: CNPJ referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: >- Quantidade máxima de registros retornados. Use o modificador .limit(x) no campo Datasets. label: Limite required: - doc DatasetDynamicQsaDataInputSchema: type: object properties: doc: type: string description: CNPJ da empresa pattern: >- ^([0-9A-Z]{12}[0-9]{2}|[0-9A-Z]{2}\.[0-9A-Z]{3}\.[0-9A-Z]{3}/[0-9A-Z]{4}-[0-9]{2})$ label: CNPJ recency: type: string description: >- Define o limite máximo de dias desde a última atualização dos dados de QSA. Caso os dados disponíveis sejam mais antigos que o valor informado, as fontes oficiais são reavaliadas em tempo real para obtenção das informações mais recentes possíveis referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite next: type: string description: >- Identificador da próxima página. Use o valor retornado em NextPageId com o modificador .next(x) no campo Datasets. label: Próxima página required: - doc DatasetEconomicGroupFirstLevelExtendedInputSchema: type: object properties: doc: type: string description: Documento de identificação pattern: >- ^([0-9A-Z]{12}[0-9]{2}|[0-9A-Z]{2}\.[0-9A-Z]{3}\.[0-9A-Z]{3}/[0-9A-Z]{4}-[0-9]{2})$ label: CNPJ referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetEconomicGroupFirstLevelInputSchema: type: object properties: doc: type: string description: Documento de identificação pattern: >- ^([0-9A-Z]{12}[0-9]{2}|[0-9A-Z]{2}\.[0-9A-Z]{3}\.[0-9A-Z]{3}/[0-9A-Z]{4}-[0-9]{2})$ label: CNPJ referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetEconomicGroupFullExtendedInputSchema: type: object properties: doc: type: string description: Documento de identificação pattern: >- ^([0-9A-Z]{12}[0-9]{2}|[0-9A-Z]{2}\.[0-9A-Z]{3}\.[0-9A-Z]{3}/[0-9A-Z]{4}-[0-9]{2})$ label: CNPJ referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetEconomicGroupFullInputSchema: type: object properties: doc: type: string description: Documento de identificação pattern: >- ^([0-9A-Z]{12}[0-9]{2}|[0-9A-Z]{2}\.[0-9A-Z]{3}\.[0-9A-Z]{3}/[0-9A-Z]{4}-[0-9]{2})$ label: CNPJ referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetEconomicGroupKycInputSchema: type: object properties: doc: type: string description: CNPJ da empresa pattern: >- ^([0-9A-Z]{12}[0-9]{2}|[0-9A-Z]{2}\.[0-9A-Z]{3}\.[0-9A-Z]{3}/[0-9A-Z]{4}-[0-9]{2})$ label: CNPJ pep_level: type: string description: Nível de exposição política identificado. pep_job: type: string description: Cargo público associado à pessoa politicamente exposta. pep_motive: type: string description: Motivo da classificação como PEP. sanctions_source: type: string description: Fonte de origem da sanção ou restrição. sanctions_type: type: string description: Tipo de sanção ou restrição aplicada. minmatch: type: number minimum: 0 maximum: 100 description: >- Percentual mínimo de similaridade entre o nome da entidade consultada e o nome presente no registro de sanção a partir do qual o registro será considerado para determinar indicadores como IsCurrentlySanctioned, WasPreviouslySanctioned e contagens por período. Esta chave não restringe os registros retornados pelo dataset. referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetEconomicGroupRelationshipsInputSchema: type: object properties: doc: type: string description: Documento de identificação pattern: >- ^([0-9A-Z]{12}[0-9]{2}|[0-9A-Z]{2}\.[0-9A-Z]{3}\.[0-9A-Z]{3}/[0-9A-Z]{4}-[0-9]{2})$ label: CNPJ group_level: type: integer description: >- Esse dataset suporta um parametro opcional chamado group_level, que permite ao cliente limitar até que nível serão selecionados os relacionamentos. Esse parametro deve ser preenchido com um número inteiro maior que zero. Caso não seja informado, todos os documentos do grupo econômico serão selecionados. O nível "1" são os sócios diretos da empresa consultada, e o resultado para uma chamada de nível "1" é equivalente a chamar o dataset de Relacionamentos convencional. minimum: 1 extended: type: string description: >- Esse dataset suporta um parametro opcional chamado extended, que permite ao cliente especificar que deseja receber todas as entidades que compõe o grupo econômico estendido, ou seja, que incluí não só as pessoas diretamente associadas com o grupo, mas também seus parentes, e empresas associadas aos mesmos. Esse parâmetro recebe um valor booleano (true ou false). Caso não seja informado, será retornado o grupo econômico convencional, e não o estendido. O exemplo a seguir ilustra como utilizar esse parâmetro em uma chamada. enum: - 'true' - 'false' group_search_limit: type: integer description: >- Esse dataset suporta um parâmetro opcional chamado groupsearchlimit. Ele permite limitar a consulta à quantidade de registros desejada, de forma semelhante ao limitador ".limit()". No entanto, o groupsearchlimit também impacta a performance da consulta. Seu uso é recomendado para empresas com uma quantidade muito grande de relacionamentos minimum: 1 useHeadQuartersData: type: string description: >- Flag que indica se os relacionamentos serão construídos a partir do documento da matriz enum: - 'true' - 'false' relatedentitytaxidtype: type: string description: Tipo do documento relacionado enum: - cnpj - cpf relationshiplevel: type: string description: Nível do relacionamento relationshiptype: type: string description: Tipo do relacionamnto enum: - QSA - Ownership - Employee - RepresentanteLegal referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: >- Quantidade máxima de registros retornados. Use o modificador .limit(x) no campo Datasets. label: Limite required: - doc DatasetEconomicGroupSecondLevelExtendedInputSchema: type: object properties: doc: type: string description: Documento de identificação pattern: >- ^([0-9A-Z]{12}[0-9]{2}|[0-9A-Z]{2}\.[0-9A-Z]{3}\.[0-9A-Z]{3}/[0-9A-Z]{4}-[0-9]{2})$ label: CNPJ referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetEconomicGroupSecondLevelInputSchema: type: object properties: doc: type: string description: Documento de identificação pattern: >- ^([0-9A-Z]{12}[0-9]{2}|[0-9A-Z]{2}\.[0-9A-Z]{3}\.[0-9A-Z]{3}/[0-9A-Z]{4}-[0-9]{2})$ label: CNPJ referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetEconomicGroupThirdLevelExtendedInputSchema: type: object properties: doc: type: string description: Documento de identificação pattern: >- ^([0-9A-Z]{12}[0-9]{2}|[0-9A-Z]{2}\.[0-9A-Z]{3}\.[0-9A-Z]{3}/[0-9A-Z]{4}-[0-9]{2})$ label: CNPJ referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetEconomicGroupThirdLevelInputSchema: type: object properties: doc: type: string description: Documento de identificação pattern: >- ^([0-9A-Z]{12}[0-9]{2}|[0-9A-Z]{2}\.[0-9A-Z]{3}\.[0-9A-Z]{3}/[0-9A-Z]{4}-[0-9]{2})$ label: CNPJ referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetElectionCandidateDataInputSchema: type: object properties: doc: type: string description: CPF da pessoa (apenas números) pattern: ^([0-9]{11}|[0-9]{3}\.[0-9]{3}\.[0-9]{3}-[0-9]{2})$ label: CPF referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetElectoralDonorsInputSchema: type: object properties: doc: type: string description: CNPJ da empresa pattern: >- ^([0-9A-Z]{12}[0-9]{2}|[0-9A-Z]{2}\.[0-9A-Z]{3}\.[0-9A-Z]{3}/[0-9A-Z]{4}-[0-9]{2})$ label: CNPJ referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetElectoralProvidersInputSchema: type: object properties: doc: type: string description: CPF da pessoa (apenas números) pattern: ^([0-9]{11}|[0-9]{3}\.[0-9]{3}\.[0-9]{3}-[0-9]{2})$ label: CPF referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetEmailsExtendedInputSchema: type: object properties: doc: type: string description: CPF da pessoa (apenas números) pattern: ^([0-9]{11}|[0-9]{3}\.[0-9]{3}\.[0-9]{3}-[0-9]{2})$ label: CPF type: type: string description: Tipo do e-mail enum: - corporate - personal isactive: type: string description: Indica se o e-mail está ativo enum: - 'true' - 'false' isrecent: type: string description: Indica se o e-mail é recente enum: - 'true' - 'false' ismain: type: string description: Indica se o e-mail é principal enum: - 'true' - 'false' validationstatus: type: string description: Status de validação do e-mail enum: - VALID - ACCEPTALL - UNKNOWN - POSSIBLESPAM_TRAP - INVALID - HARDBOUNCE - RISKY - ACCEPT domain: type: string description: Domínio do e-mail email: type: string description: >- Permite informar um e-mail adicional para análise de informações globais do endereço, independentemente de associação explícita com o documento consultado. pattern: ^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}$ label: E-mail returnonlydifferentemails: type: string description: >- Quando definido como true, retorna apenas e-mails diferentes dos informados na chamada, evitando duplicidade e cobrança de contatos já conhecidos. enum: - 'true' - 'false' returnonlyvalidemails: type: string description: >- Quando definido como true, retorna apenas e-mails com status de validação considerado válido, aumentando a qualidade do retorno. enum: - 'true' - 'false' referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: >- Quantidade máxima de registros retornados. Use o modificador .limit(x) no campo Datasets. label: Limite required: - doc DatasetEmbargoedAreasInputSchema: type: object properties: zipcode: type: string description: zipcode pattern: ^[0-9]{5}-[0-9]{3}$ label: CEP polygon: type: string description: Polígono geográfico utilizado para delimitar a área de análise householdcode: type: string description: Identificador geográfico de residência buildingcode: type: string description: Identificador geográfico de edificação latitude: type: number description: Coordenadas do ponto de consulta (devem ser informadas em conjunto) longitude: type: number description: Coordenadas do ponto de consulta (devem ser informadas em conjunto) referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - zipcode DatasetEmployeesIndustrialPropertyInputSchema: type: object properties: doc: type: string description: CNPJ da empresa pattern: >- ^([0-9A-Z]{12}[0-9]{2}|[0-9A-Z]{2}\.[0-9A-Z]{3}\.[0-9A-Z]{3}/[0-9A-Z]{4}-[0-9]{2})$ label: CNPJ referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: >- Quantidade máxima de registros retornados. Use o modificador .limit(x) no campo Datasets. label: Limite required: - doc DatasetEmployeesKycInputSchema: type: object properties: doc: type: string description: CNPJ da empresa pattern: >- ^([0-9A-Z]{12}[0-9]{2}|[0-9A-Z]{2}\.[0-9A-Z]{3}\.[0-9A-Z]{3}/[0-9A-Z]{4}-[0-9]{2})$ label: CNPJ pep_level: type: string description: Nível de exposição política identificado. pep_job: type: string description: Cargo público associado à pessoa politicamente exposta. pep_motive: type: string description: Motivo da classificação como PEP. sanctions_source: type: string description: Fonte de origem da sanção ou restrição. sanctions_type: type: string description: Tipo de sanção ou restrição aplicada. minmatch: type: number minimum: 0 maximum: 100 description: >- Percentual mínimo de similaridade entre o nome da entidade consultada e o nome presente no registro de sanção a partir do qual o registro será considerado para determinar indicadores como IsCurrentlySanctioned, WasPreviouslySanctioned e contagens por período. Esta chave não restringe os registros retornados pelo dataset. referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: >- Quantidade máxima de registros retornados. Use o modificador .limit(x) no campo Datasets. label: Limite next: type: string description: >- Identificador da próxima página. Use o valor retornado em NextPageId com o modificador .next(x) no campo Datasets. label: Próxima página required: - doc DatasetEmpresasInputSchema: type: object required: - doc properties: doc: type: string label: CNPJ pattern: >- ^([0-9A-Z]{12}[0-9]{2}|[0-9A-Z]{2}\.[0-9A-Z]{3}\.[0-9A-Z]{3}/[0-9A-Z]{4}-[0-9]{2})$ description: CNPJ da empresa a ser consultada. DatasetEmpresasGrupoInputSchema: type: object required: - doc properties: doc: type: string label: CNPJ pattern: >- ^([0-9A-Z]{2}\.[0-9A-Z]{3}\.[0-9A-Z]{3}|[0-9A-Z]{2}\.[0-9A-Z]{3}\.[0-9A-Z]{3}/[0-9A-Z]{4}-[0-9]{2})$ description: >- CNPJ de qualquer empresa do grupo a ser consultado. Pode ser a raiz (8 caracteres: XX.XXX.XXX) ou CNPJ completo (14 caracteres: XX.XXX.XXX/XXXX-XX). limit: type: number label: Limite default: 1000 description: Limite de resultados headquarters: type: boolean description: >- Quando verdadeiro, retorna somente a matriz da raiz do CNPJ informado. DatasetEmpresasMartInputSchema: type: object required: - doc properties: doc: type: string label: CNPJ pattern: >- ^([0-9A-Z]{12}[0-9]{2}|[0-9A-Z]{2}\.[0-9A-Z]{3}\.[0-9A-Z]{3}/[0-9A-Z]{4}-[0-9]{2})$ description: CNPJ da empresa a ser consultada. DatasetEmpresasProcessosJudiciaisInputSchema: type: object required: [] properties: doc: type: string label: CPF ou CNPJ description: |- CPF (pessoa física) ou CNPJ (empresa) para consulta de processos. Pode ser enviado com ou sem formatação. examples: - '12345678000190' - 12.345.678/0001-90 - '12345678909' nome: type: string label: Nome ou razão social description: >- Nome da pessoa ou razão social da empresa para consulta de processos quando a busca por documento não retorna todos os vínculos relevantes. cursor: type: string label: Cursor de paginação description: >- Token de paginação retornado em `links.next` da página anterior. Preenchido automaticamente pelo LawsuitsFetchPageWorker; consumidores manuais normalmente não enviam este campo. li: type: string label: Índice de paginação description: >- Parâmetro `li` retornado em `links.next` da página anterior. A API da Escavador exige este valor junto com `cursor` nas páginas seguintes. DatasetEmpresasSociosInputSchema: type: object required: - doc properties: doc: type: string label: CNPJ pattern: >- ^([0-9A-Z]{12}[0-9]{2}|[0-9A-Z]{2}\.[0-9A-Z]{3}\.[0-9A-Z]{3}/[0-9A-Z]{4}-[0-9]{2})$ description: CNPJ da empresa a ser consultada. DatasetEnriquecimentoDeLeadInputSchema: type: object properties: email: type: string description: O parâmetro EMAIL deve possuir formatação válida. label: EMAIL celular: type: string description: O parâmetro CELULAR pode ser enviado com ou sem formatação. label: CELULAR required: - email - celular DatasetEnvironmentalPreservationAreasInputSchema: type: object properties: zipcode: type: string description: zipcode pattern: ^[0-9]{5}-[0-9]{3}$ label: CEP polygon: type: string description: Polígono geográfico utilizado para delimitar a área de análise householdcode: type: string description: Identificador geográfico de residência buildingcode: type: string description: Identificador geográfico de edificação latitude: type: number description: Coordenadas do ponto de consulta (devem ser informadas em conjunto) longitude: type: number description: Coordenadas do ponto de consulta (devem ser informadas em conjunto) referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - zipcode DatasetEuFinancialSanctionsListInputSchema: type: object properties: nome: type: string description: O parâmetro NOME pode ser enviado em maiúsculo ou minúsculo. label: NOME required: - nome DatasetExtraInfoDataInputSchema: type: object properties: ean: type: string description: ean label: Código de Barras (EAN) isbn: type: string description: International Standard Book Number brand: type: string description: Marca do produto category: type: string description: Categoria do produto searchterms: type: string description: Termos de busca por palavras-chave referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite next: type: string description: >- Identificador da próxima página. Use o valor retornado em NextPageId com o modificador .next(x) no campo Datasets. label: Próxima página required: - ean DatasetFamilyFinancialDataInputSchema: type: object properties: doc: type: string description: CPF da pessoa (apenas números) pattern: ^([0-9]{11}|[0-9]{3}\.[0-9]{3}\.[0-9]{3}-[0-9]{2})$ label: CPF referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetFamilyFinancialRiskInputSchema: type: object properties: doc: type: string description: CPF da pessoa (apenas números) pattern: ^([0-9]{11}|[0-9]{3}\.[0-9]{3}\.[0-9]{3}-[0-9]{2})$ label: CPF referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetFamilyLawsuitsDistributionDataInputSchema: type: object properties: doc: type: string description: CPF da pessoa (apenas números) pattern: ^([0-9]{11}|[0-9]{3}\.[0-9]{3}\.[0-9]{3}-[0-9]{2})$ label: CPF capturedate: type: string description: Data de captura do processo pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ label: Data closedate: type: string description: Data de fechamento do processo pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ label: Data cnjsubject: type: string description: Número ou nome do assunto do processo no CNJ cnjproceduretype: type: string description: Número ou nome do tipo do processo no CNJ courtlevel: type: string description: Nível do tribunal enum: - '1' - '2' - '3' x-fern-enum: '1': name: Value1 '2': name: Value2 '3': name: Value3 courtname: type: string description: Nome do tribunal courttype: type: string description: Tipo do tribunal partypolarity: type: string description: Polaridade da parte no processo enum: - ACTIVE - PASSIVE - NEUTRAL partytype: type: string description: Tipo de participação da entidade no processo noticedate: type: string description: Data de notificação do processo pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ label: Data state: type: string description: Estado de tramitação do processo status: type: string description: Status do processo resjudicatadate: type: string description: Data de trânsito em julgado pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ label: Data value: type: string description: Valor discutido no processo referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetFamilyOnlineParticipationInputSchema: type: object properties: doc: type: string description: CPF da pessoa (apenas números) pattern: ^([0-9]{11}|[0-9]{3}\.[0-9]{3}\.[0-9]{3}-[0-9]{2})$ label: CPF referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetFamilyPoliticalHistoryInputSchema: type: object properties: doc: type: string description: CPF da pessoa (apenas números) pattern: ^([0-9]{11}|[0-9]{3}\.[0-9]{3}\.[0-9]{3}-[0-9]{2})$ label: CPF referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetFamilySocialAssistanceInputSchema: type: object properties: doc: type: string description: CPF da pessoa (apenas números) pattern: ^([0-9]{11}|[0-9]{3}\.[0-9]{3}\.[0-9]{3}-[0-9]{2})$ label: CPF referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetFbiMostWantedInputSchema: type: object properties: sobrenome: type: string description: '' label: SOBRENOME nome: type: string description: O parâmetro NOME pode ser enviado em maiúsculo ou minúsculo. label: NOME required: - sobrenome - nome DatasetFgtsRegularidadeDoEmpregadorInputSchema: type: object properties: doc: type: string label: Documento description: Documento a ser consultado. Pode ser enviado com ou sem formatação. required: - doc DatasetFinancialDataInputSchema: type: object properties: doc: type: string description: CPF da pessoa (apenas números) pattern: ^([0-9]{11}|[0-9]{3}\.[0-9]{3}\.[0-9]{3}-[0-9]{2})$ label: CPF referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetFinancialInterestsInputSchema: type: object properties: doc: type: string description: Documento de identificação pattern: ^([0-9]{11}|[0-9]{3}\.[0-9]{3}\.[0-9]{3}-[0-9]{2})$ label: CPF birthdate: type: string description: Data de Nascimento pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ label: Data de Nascimento dateformat: type: string description: Formato da Data enum: - yyyy-MM-dd - dd/MM/yyyy label: Formato da Data referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetFinancialMarketInputSchema: type: object properties: doc: type: string description: CNPJ da empresa pattern: >- ^([0-9A-Z]{12}[0-9]{2}|[0-9A-Z]{2}\.[0-9A-Z]{3}\.[0-9A-Z]{3}/[0-9A-Z]{4}-[0-9]{2})$ label: CNPJ referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetFinancialRiskInputSchema: type: object properties: doc: type: string description: CPF da pessoa (apenas números) pattern: ^([0-9]{11}|[0-9]{3}\.[0-9]{3}\.[0-9]{3}-[0-9]{2})$ label: CPF referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetFincenFinancialCrimesEnforcementNetworkInputSchema: type: object properties: nome: type: string description: O parâmetro NOME pode ser enviado em maiúsculo ou minúsculo. label: NOME required: - nome DatasetFirstLevelRelativesKycInputSchema: type: object properties: doc: type: string description: CPF da pessoa (apenas números) pattern: ^([0-9]{11}|[0-9]{3}\.[0-9]{3}\.[0-9]{3}-[0-9]{2})$ label: CPF pep_level: type: string description: Nível de Pessoa Politicamente Exposta (PEP) pep_job: type: string description: Cargo público que a pessoa ocupa pep_motive: type: string description: Motivo pelo qual a pessoa foi classificada como PEP sanctions_source: type: string description: Fonte da sanção sanctions_type: type: string description: Tipo da sanção minmatch: type: number minimum: 0 maximum: 100 description: >- Percentual mínimo de similaridade entre o nome da entidade consultada e o nome presente no registro de sanção a partir do qual o registro será considerado para determinar indicadores como IsCurrentlySanctioned, WasPreviouslySanctioned e contagens por período. Esta chave não restringe os registros retornados pelo dataset. referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetFirstLevelRelativesLawsuitDataInputSchema: type: object properties: doc: type: string description: CPF da pessoa (apenas números) pattern: ^([0-9]{11}|[0-9]{3}\.[0-9]{3}\.[0-9]{3}-[0-9]{2})$ label: CPF capturedate: type: string description: Data de captura do processo pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ label: Data closedate: type: string description: Data de finalização, baixa ou arquivamento do processo pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ label: Data cnjsubject: type: string description: >- Número ou nome do assunto do processo no CNJ, conforme tabela oficial disponível no site do CNJ cnjproceduretype: type: string description: Número ou nome do tipo do processo no CNJ courtlevel: type: string description: Instância do processo enum: - '1' - '2' - '3' x-fern-enum: '1': name: Value1 '2': name: Value2 '3': name: Value3 courtname: type: string description: Nome do tribunal courttype: type: string description: Tipo de vara ou competência do processo enum: - CIVEL - CRIMINAL - TRIBUTARIA - PREVIDENCIARIA - TRABALHISTA - ESPECIAL CIVEL - ESPECIAL CRIMINAL - ADMINISTRATIVA - ELEITORAL - FAZENDA - ESPECIAL FAZENDA partypolarity: type: string description: Polaridade da parte no processo enum: - ACTIVE - PASSIVE - NEUTRAL partytype: type: string description: Tipo da parte no processo enum: - AUTHOR - DEFENDANT - CLAIMANT - CLAIMED - LAWYER - REPORTER - ATTORNEY - WITNESS - VICTIM - JUDGE - INMATE - OTHER noticedate: type: string description: Data de abertura ou distribuição do processo pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ label: Data state: type: string description: Estado de tramitação do processo (UF) status: type: string description: Status do processo enum: - ATIVO - DISTRIBUIDO - BAIXADO - APENSO - DECIDIDO - AUTUADO - EXECUCAO - FINALIZADO - ENCERRADO - EM GRAU DE RECURSO - REDISTRIBUIDO - TRANSITADO EM JULGADO - ARQUIVADO - JULGADO - INDEFINIDO - SUSPENSO resjudicatadate: type: string description: Data de trânsito em julgado pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ label: Data value: type: string description: Valor disputado no processo referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: >- Quantidade máxima de registros retornados. Use o modificador .limit(x) no campo Datasets. label: Limite next: type: string description: >- Identificador da próxima página. Use o valor retornado em NextPageId com o modificador .next(x) no campo Datasets. label: Próxima página required: - doc DatasetFlagsAndFeaturesInputSchema: type: object properties: doc: type: string description: Documento de identificação pattern: ^([0-9]{11}|[0-9]{3}\.[0-9]{3}\.[0-9]{3}-[0-9]{2})$ label: CPF birthdate: type: string description: Data de Nascimento pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ label: Data de Nascimento dateformat: type: string description: Formato da Data enum: - yyyy-MM-dd - dd/MM/yyyy label: Formato da Data modelinputkey: type: string description: Chave de entrada do modelo modelname: type: string description: Nome do modelo modeldescription: type: string description: Descrição do modelo referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetGarantiaSafraInputSchema: type: object properties: nis: type: string description: O parâmetro NIS pode ser enviado com ou sem formatação. label: NIS doc: type: string label: Documento description: Documento a ser consultado. Pode ser enviado com ou sem formatação. required: - nis - doc DatasetGoogleMapsDirectionsDirectionsInputSchema: type: object required: - origin - destination properties: mode: enum: - driving - walking - bicycling - transit type: string label: Modo de Viagem default: driving description: Modo de transporte para a rota. avoid: type: array items: enum: - tolls - highways - ferries type: string label: Evitar description: Características a evitar na rota. units: enum: - metric - imperial type: string label: Sistema de Unidades description: Sistema de medidas para exibir distâncias. origin: type: string label: Origem description: >- Ponto de partida (endereço, lat/lng ou Place ID). Exemplo: "São Paulo, SP" ou "-23.5505,-46.6333". region: type: string label: Região description: 'Código da região para priorizar resultados (ex: "br", "us").' language: type: string label: Idioma description: 'Código do idioma para os resultados (ex: "pt-BR", "en").' waypoints: type: array items: type: string label: Pontos Intermediários description: Pontos de parada intermediários na rota (máximo 25). destination: type: string label: Destino description: >- Ponto de chegada (endereço, lat/lng ou Place ID). Exemplo: "Guarulhos, SP" ou "-23.4356,-46.4731". alternatives: type: boolean label: Rotas Alternativas default: false description: Retornar rotas alternativas quando disponível. DatasetGoogleMapsGeocodingGeocodeInputSchema: type: object properties: latlng: type: string label: Latitude e Longitude description: >- Coordenadas para geocodificação reversa no formato "latitude,longitude" (ex: "-23.5505,-46.6333"). region: type: string label: Região description: 'Código da região para priorizar resultados (ex: "br", "us").' address: type: string label: Endereço description: >- Endereço completo para geocodificação direta (ex: "Av. Paulista, 1578 - São Paulo, SP"). placeId: type: string label: ID do Local description: Identificador único de local do Google Maps para geocodificação. language: type: string label: Idioma description: 'Código do idioma para os resultados (ex: "pt-BR", "en").' DatasetGoogleMapsPlacesReviewsInputSchema: type: object required: - placeId properties: placeId: type: string label: ID do Local description: >- Identificador único do local no Google Maps (ex: "ChIJD2l2k7ZL0YkRC80d-3MV1lM"). Pode ser obtido através da API de busca de lugares. languageCode: type: string label: Idioma default: pt-BR description: 'Código do idioma para filtrar avaliações (ex: "pt-BR", "en-US").' DatasetGoogleMapsStaticImageInputSchema: type: object required: - location properties: location: type: string label: Endereço description: >- Endereço ou coordenadas (ex: "Av Paulista, 1000, São Paulo/SP" ou "-23.561,-46.656") zoom: type: number label: Zoom description: 'Nível de zoom (1-21). Padrão: 12' default: 12 size: type: string label: Tamanho description: 'Dimensões da imagem (ex: "600x300"). Padrão: 600x300' default: 600x300 maptype: type: string label: Tipo de mapa description: 'Tipo do mapa: roadmap, satellite, terrain, hybrid. Padrão: roadmap' enum: - roadmap - satellite - terrain - hybrid default: roadmap markers: type: string label: Marcador description: >- Texto do marcador (normalmente o nome da empresa). Mostra um pin vermelho no local. DatasetGoogleMapsStreetviewStaticImageInputSchema: type: object required: - location properties: locations: type: array items: type: string label: Localizações description: >- Lista de coordenadas no formato "lat,lng" para gerar múltiplas imagens. locations_meta: type: array items: type: object properties: location: type: string route_distance_m: type: number label: Localizações com Metadados description: >- Lista de objetos com "location" e metadados opcionais (ex: distância da rota). location: type: string label: Localização description: >- Endereço ou coordenadas (ex: "Av Paulista, 1000, Sao Paulo/SP" ou "-23.561,-46.656"). pano: type: string label: Panorama ID description: >- ID do panorama do Street View. Se informado, "location" pode ser omitido. heading: type: number label: Heading description: >- Direção da camera (0-360). Se omitido e "target_location" existir, o heading será calculado. pitch: type: number label: Pitch description: 'Inclinação vertical da camera (-90 a 90). Padrão: 0.' default: 0 fov: type: number label: Campo de Visao description: 'Campo de visao (10 a 120). Padrão: 90.' default: 90 size: type: string label: Tamanho description: 'Dimensões da imagem (ex: "600x300"). Padrão: 600x300.' default: 600x300 source: type: string label: Fonte description: 'Fonte do Street View: outdoor ou default. Padrão: outdoor.' enum: - outdoor - default default: outdoor radius: type: number label: Raio description: Raio (em metros) para buscar o panorama mais próximo. target_location: type: string label: Localização Alvo description: >- Coordenadas do alvo para calcular o heading automaticamente (ex: "-23.561,-46.656"). DatasetGooglePlacesDetailsEnterpriseInputSchema: type: object required: - placeId properties: placeId: type: string label: ID do Local description: >- Identificador único do local no Google Maps (ex: "ChIJD2l2k7ZL0YkRC80d-3MV1lM"). languageCode: type: string label: Idioma default: pt-BR description: 'Código do idioma para os resultados (ex: "pt-BR", "en-US").' DatasetGooglePlacesDetailsEnterpriseAtmosphereInputSchema: type: object required: - placeId properties: placeId: type: string label: ID do Local description: >- Identificador único do local no Google Maps (ex: "ChIJD2l2k7ZL0YkRC80d-3MV1lM"). languageCode: type: string label: Idioma default: pt-BR description: 'Código do idioma para os resultados (ex: "pt-BR", "en-US").' DatasetGooglePlacesDetailsEssentialsInputSchema: type: object required: - placeId properties: placeId: type: string label: ID do Local description: >- Identificador único do local no Google Maps (ex: "ChIJD2l2k7ZL0YkRC80d-3MV1lM"). languageCode: type: string label: Idioma default: pt-BR description: 'Código do idioma para os resultados (ex: "pt-BR", "en-US").' DatasetGooglePlacesDetailsEssentialsIdOnlyInputSchema: type: object required: - placeId properties: placeId: type: string label: ID do Local description: >- Identificador único do local no Google Maps (ex: "ChIJD2l2k7ZL0YkRC80d-3MV1lM"). languageCode: type: string label: Idioma default: pt-BR description: 'Código do idioma para os resultados (ex: "pt-BR", "en-US").' DatasetGooglePlacesDetailsProInputSchema: type: object required: - placeId properties: placeId: type: string label: ID do Local description: >- Identificador único do local no Google Maps (ex: "ChIJD2l2k7ZL0YkRC80d-3MV1lM"). languageCode: type: string label: Idioma default: pt-BR description: 'Código do idioma para os resultados (ex: "pt-BR", "en-US").' DatasetGooglePlacesPhotosInputSchema: type: object required: - photos properties: photos: type: array items: type: object properties: name: type: string widthPx: type: number heightPx: type: number authorAttributions: type: array items: type: object properties: displayName: type: string uri: type: string photoUri: type: string label: Fotos description: >- Lista de fotos retornadas no Place Details (campos name, widthPx, heightPx e authorAttributions). limit: type: number label: Limite description: 'Número máximo de fotos a retornar. Padrão: 10.' default: 10 maxHeightPx: type: number label: Altura máxima description: 'Altura máxima da imagem. Padrão: 800.' default: 800 maxWidthPx: type: number label: Largura máxima description: 'Largura máxima da imagem. Padrão: 800.' default: 800 DatasetGooglePlacesTextSearchEnterpriseInputSchema: type: object required: - textQuery properties: textQuery: type: string label: Texto de Busca description: >- Texto para buscar lugares (ex: "Base39 Sao Paulo", "farmacia", "restaurante italiano Pinheiros"). locationBias: type: object label: Priorizacao por Localizacao description: >- Priorizar resultados proximos a uma localizacao especifica (opcional). properties: center: type: object label: Centro properties: lat: type: number label: Latitude lng: type: number label: Longitude radius: type: number label: Raio description: Raio em metros para priorizar resultados (maximo 50000). maxResultCount: type: number label: Quantidade de Resultados description: Numero maximo total de resultados a retornar (1-60). default: 5 matchContext: type: object properties: official: type: object additionalProperties: true location: type: object required: - lat - lng properties: lat: type: number lng: type: number DatasetGooglePlacesTextSearchEnterpriseAtmosphereInputSchema: type: object required: - textQuery properties: textQuery: type: string label: Texto de Busca description: >- Texto para buscar lugares (ex: "Base39 São Paulo", "farmácia", "restaurante italiano Pinheiros"). locationBias: type: object label: Priorização por Localização description: >- Priorizar resultados próximos a uma localização específica (opcional). properties: center: type: object label: Centro properties: lat: type: number label: Latitude lng: type: number label: Longitude radius: type: number label: Raio description: Raio em metros para priorizar resultados (máximo 50000). maxResultCount: type: number label: Quantidade de Resultados description: Número máximo total de resultados a retornar (1-60). default: 5 DatasetGooglePlacesTextSearchEssentialsIdOnlyInputSchema: type: object required: - textQuery properties: textQuery: type: string label: Texto de Busca description: >- Texto para buscar lugares (ex: "Base39 São Paulo", "farmácia", "restaurante italiano Pinheiros"). locationBias: type: object label: Priorização por Localização description: >- Priorizar resultados próximos a uma localização específica (opcional). properties: center: type: object label: Centro properties: lat: type: number label: Latitude lng: type: number label: Longitude radius: type: number label: Raio description: Raio em metros para priorizar resultados (máximo 50000). maxResultCount: type: number label: Quantidade de Resultados description: Número máximo total de resultados a retornar (1-60). default: 5 DatasetGooglePlacesTextSearchProInputSchema: type: object required: - textQuery properties: textQuery: type: string label: Texto de Busca description: >- Texto para buscar lugares (ex: "Base39 São Paulo", "farmácia", "restaurante italiano Pinheiros"). locationBias: type: object label: Priorização por Localização description: >- Priorizar resultados próximos a uma localização específica (opcional). properties: center: type: object label: Centro properties: lat: type: number label: Latitude lng: type: number label: Longitude radius: type: number label: Raio description: Raio em metros para priorizar resultados (máximo 50000). maxResultCount: type: number label: Quantidade de Resultados description: Número máximo total de resultados a retornar (1-60). default: 5 DatasetGovernmentDebtorsInputSchema: type: object properties: doc: type: string description: CNPJ da empresa pattern: >- ^([0-9A-Z]{12}[0-9]{2}|[0-9A-Z]{2}\.[0-9A-Z]{3}\.[0-9A-Z]{3}/[0-9A-Z]{4}-[0-9]{2})$ label: CNPJ referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetHistoricalBasicDataInputSchema: type: object properties: doc: type: string description: CPF da pessoa (apenas números) pattern: ^([0-9]{11}|[0-9]{3}\.[0-9]{3}\.[0-9]{3}-[0-9]{2})$ label: CPF name: type: string description: >- Possibilita a comparação do nome informado com o nome encontrado na base, com retorno do percentual de similaridade label: Nome mothername: type: string description: >- Possibilita a comparação do nome da mãe informado com o nome encontrado na base, com retorno do percentual de similaridade birthdate: type: string description: >- Possibilita a comparação da data de nascimento informada com a data encontrada na base pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ label: Data de Nascimento dateformat: type: string description: Define o formato da data informada no parâmetro birthdate label: Formato da Data referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetHistoricoDeVeiculosPfEPjInputSchema: type: object properties: doc: type: string label: Documento description: Documento a ser consultado. Pode ser enviado com ou sem formatação. required: - doc DatasetHistoryBasicDataInputSchema: type: object properties: doc: type: string description: CNPJ da empresa pattern: >- ^([0-9A-Z]{12}[0-9]{2}|[0-9A-Z]{2}\.[0-9A-Z]{3}\.[0-9A-Z]{3}/[0-9A-Z]{4}-[0-9]{2})$ label: CNPJ referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetIbamaCertidaoNegativaDeDebitosInputSchema: type: object properties: doc: type: string label: Documento description: Documento a ser consultado. Pode ser enviado com ou sem formatação. required: - doc DatasetIbamaCertidaoNegativaDeEmbargoInputSchema: type: object properties: doc: type: string label: Documento description: Documento a ser consultado. Pode ser enviado com ou sem formatação. required: - doc DatasetIbamaCertificadoDeRegularidadeInputSchema: type: object properties: doc: type: string label: Documento description: Documento a ser consultado. Pode ser enviado com ou sem formatação. required: - doc DatasetIbamaConsultaDeAutuacoesAmbientaisInputSchema: type: object properties: doc: type: string label: Documento description: Documento a ser consultado. Pode ser enviado com ou sem formatação. required: - doc DatasetImagesDataInputSchema: type: object properties: ean: type: string description: ean label: Código de Barras (EAN) isbn: type: string description: International Standard Book Number brand: type: string description: Marca do produto category: type: string description: Categoria do produto searchterms: type: string description: Termos de busca por palavras-chave referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite next: type: string description: >- Identificador da próxima página. Use o valor retornado em NextPageId com o modificador .next(x) no campo Datasets. label: Próxima página required: - ean DatasetIndebtednessQuestionInputSchema: type: object properties: doc: type: string description: CPF da pessoa (apenas números) pattern: ^([0-9]{11}|[0-9]{3}\.[0-9]{3}\.[0-9]{3}-[0-9]{2})$ label: CPF referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetIndigenousLandsDataInputSchema: type: object properties: indigenouslandcode: type: string description: indigenouslandcode polygon: type: string description: Polígono geográfico utilizado para delimitar a área de análise householdcode: type: string description: Identificador geográfico de residência buildingcode: type: string description: Identificador geográfico de edificação latitude: type: number description: Coordenadas do ponto de consulta (devem ser informadas em conjunto) longitude: type: number description: Coordenadas do ponto de consulta (devem ser informadas em conjunto) referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - indigenouslandcode DatasetIndustrialPropertyInputSchema: type: object properties: doc: type: string description: CNPJ da empresa pattern: >- ^([0-9A-Z]{12}[0-9]{2}|[0-9A-Z]{2}\.[0-9A-Z]{3}\.[0-9A-Z]{3}/[0-9A-Z]{4}-[0-9]{2})$ label: CNPJ referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetInfluenceDataInputSchema: type: object properties: doc: type: string description: CPF da pessoa (apenas números) pattern: ^([0-9]{11}|[0-9]{3}\.[0-9]{3}\.[0-9]{3}-[0-9]{2})$ label: CPF referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetInterestsAndBehaviorsInputSchema: type: object properties: doc: type: string description: Documento de identificação pattern: ^([0-9]{11}|[0-9]{3}\.[0-9]{3}\.[0-9]{3}-[0-9]{2})$ label: CPF birthdate: type: string description: Data de Nascimento pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ label: Data de Nascimento dateformat: type: string description: Formato da Data enum: - yyyy-MM-dd - dd/MM/yyyy label: Formato da Data referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetInterpolInputSchema: type: object properties: sobrenome: type: string description: O parâmetro SOBRENOME pode ser enviado em maiúsculo ou minúsculo. label: SOBRENOME nome: type: string description: O parâmetro NOME pode ser enviado em maiúsculo ou minúsculo. label: NOME required: - nome DatasetInvestmentFundDataInputSchema: type: object properties: doc: type: string description: CNPJ da empresa pattern: >- ^([0-9A-Z]{12}[0-9]{2}|[0-9A-Z]{2}\.[0-9A-Z]{3}\.[0-9A-Z]{3}/[0-9A-Z]{4}-[0-9]{2})$ label: CNPJ all: type: string description: >- Define se todas as movimentações capturadas para o CNPJ devem ser retornadas, podendo impactar diretamente o volume e a performance da resposta enum: - 'true' - 'false' referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: >- Quantidade máxima de registros retornados. Use o modificador .limit(x) no campo Datasets. label: Limite required: - doc DatasetKycInputSchema: type: object properties: doc: type: string description: CNPJ da empresa pattern: >- ^([0-9A-Z]{12}[0-9]{2}|[0-9A-Z]{2}\.[0-9A-Z]{3}\.[0-9A-Z]{3}/[0-9A-Z]{4}-[0-9]{2})$ label: CNPJ pep_level: type: string description: Nível de exposição política identificado. pep_job: type: string description: Cargo público associado à pessoa politicamente exposta. pep_motive: type: string description: Motivo da classificação como PEP. sanctions_source: type: string description: Fonte de origem da sanção ou restrição. sanctions_type: type: string description: Tipo de sanção ou restrição aplicada. minmatch: type: number minimum: 0 maximum: 100 description: >- Percentual mínimo de similaridade entre o nome da entidade consultada e o nome presente no registro de sanção a partir do qual o registro será considerado para determinar indicadores como IsCurrentlySanctioned, WasPreviouslySanctioned e contagens por período. Esta chave não restringe os registros retornados pelo dataset. name: type: string description: >- Permite realizar a consulta a partir do nome da entidade quando o documento não é informado, sendo especialmente útil em análises envolvendo empresas estrangeiras. label: Nome referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetLawsuitPartnerTelesignPhoneIdPortingHistoryPersonInputSchema: type: object properties: phone: type: string description: phone pattern: ^(\([0-9]{2}\))?[0-9]{4,5}-[0-9]{4}$ label: Telefone referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - phone DatasetLawsuitPartnerTelesignPhoneIdPortingStatusPersonInputSchema: type: object properties: phone: type: string description: Número de Telefone pattern: ^(\([0-9]{2}\))?[0-9]{4,5}-[0-9]{4}$ label: Telefone referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - phone DatasetLawsuitPartnerTelesignPhoneIdStandardPersonInputSchema: type: object properties: phone: type: string description: Número de Telefone pattern: ^(\([0-9]{2}\))?[0-9]{4,5}-[0-9]{4}$ label: Telefone referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - phone DatasetLawsuitPartnerTelesignPhoneIdSubscriberStatusPersonInputSchema: type: object properties: phone: type: string description: Número de Telefone pattern: ^(\([0-9]{2}\))?[0-9]{4,5}-[0-9]{4}$ label: Telefone referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - phone DatasetLawsuitPartnerTelesignPhoneScorePersonInputSchema: type: object properties: phone: type: string description: Número de Telefone pattern: ^(\([0-9]{2}\))?[0-9]{4,5}-[0-9]{4}$ label: Telefone account_lifecycle_event: type: string description: Evento do ciclo da conta example: event enum: - create - sign-in - transact - update - delete email: type: string description: Parâmetro opcional para auxiliar no cálculo do score pattern: ^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}$ label: E-mail ip: type: string description: Parâmetro opcional para auxiliar no cálculo do score referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - phone - account_lifecycle_event DatasetLawsuitsDistributionDataInputSchema: type: object properties: doc: type: string description: CNPJ da empresa pattern: >- ^([0-9A-Z]{12}[0-9]{2}|[0-9A-Z]{2}\.[0-9A-Z]{3}\.[0-9A-Z]{3}/[0-9A-Z]{4}-[0-9]{2})$ label: CNPJ capturedate: type: string description: Data de captura do processo pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ label: Data closedate: type: string description: Data de fechamento do processo pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ label: Data cnjsubject: type: string description: >- Número ou nome do assunto no CNJ. Quando usados valores númericos, este filtro abrange os campos InferredCNJSubjectNumber e InferredBroadCNJSubjectNumber. Em caso de valores de texto, aplica-se aos campos InferredCNJSubjectName e InferredBroadCNJSubjectName. cnjproceduretype: type: string description: >- Número ou nome do tipo do processo no CNJ. Quando forem informados números, o filtro é aplicado ao campo InferredCNJProcedureTypeNumber, e caso sejam textos, aplica-se ao campo InferredCNJProcedureTypeName. courtlevel: type: string description: Nivel do tribunal enum: - '1' - '2' - '3' x-fern-enum: '1': name: Value1 '2': name: Value2 '3': name: Value3 courtname: type: string description: Nome do Tribunal courttype: type: string description: Tipo do Tribunal enum: - CIVEL - CRIMINAL - TRIBUTARIA - PREVIDENCIARIA - TRABALHISTA - ESPECIAL CIVEL - ESPECIAL CRIMINAL - ADMINISTRATIVA - ELEITORAL - FAZENDA - ESPECIAL FAZENDA partypolarity: type: string description: Polaridade da parte enum: - ACTIVE - PASSIVE - NEUTRAL partytype: type: string description: Tipo da parte enum: - AUTHOR - DEFENDANT - CLAIMANT - CLAIMED - LAWYER - REPORTER - ATTORNEY - WITNESS - VICTIM - JUDGE - INMATE - OTHER noticedate: type: string description: Data de notificação do processo pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ label: Data state: type: string description: Estado status: type: string description: Status do processo enum: - ATIVO - DISTRIBUIDO - BAIXADO - APENSO - DECIDIDO - AUTUADO - EXECUCAO - FINALIZADO - ENCERRADO - EM GRAU DE RECURSO - REDISTRIBUIDO - TRANSITADO EM JULGADO - ARQUIVADO - JULGADO - INDEFINIDO resjudicatadate: type: string description: Data de Res Juldicata pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ label: Data value: type: string description: Valor disputado no processo alternativedistributionparameter: type: string description: >- Ao informar este parâmetro, será retornado um objeto adicional na saída do dataset, que se refere à agregação baseada nos valores do campo informado neste parâmetro enum: - PartyType referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetLegalAmazonInputSchema: type: object properties: zipcode: type: string description: zipcode pattern: ^[0-9]{5}-[0-9]{3}$ label: CEP polygon: type: string description: Polígono geográfico utilizado para delimitar a área de análise householdcode: type: string description: Identificador geográfico de residência buildingcode: type: string description: Identificador geográfico de edificação latitude: type: number description: Coordenadas do ponto de consulta (devem ser informadas em conjunto) longitude: type: number description: Coordenadas do ponto de consulta (devem ser informadas em conjunto) referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - zipcode DatasetLegalReserveInputSchema: type: object properties: zipcode: type: string description: zipcode pattern: ^[0-9]{5}-[0-9]{3}$ label: CEP polygon: type: string description: Polígono geográfico utilizado para delimitar a área de análise referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - zipcode DatasetLicensePlatesInputSchema: type: object properties: licenseplate: type: string description: licenseplate label: Placa referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - licenseplate DatasetLicensesAndAuthorizationsInputSchema: type: object properties: doc: type: string description: Documento de identificação pattern: >- ^([0-9A-Z]{12}[0-9]{2}|[0-9A-Z]{2}\.[0-9A-Z]{3}\.[0-9A-Z]{3}/[0-9A-Z]{4}-[0-9]{2})$ label: CNPJ licensetype: type: string description: Tipo da licença ou autorização enum: - ANP - ANVISA - ENVIRONMENT - ANTT - CADASTUR referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetLifeStagesInputSchema: type: object properties: doc: type: string description: Documento de identificação pattern: ^([0-9]{11}|[0-9]{3}\.[0-9]{3}\.[0-9]{3}-[0-9]{2})$ label: CPF birthdate: type: string description: Data de Nascimento pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ label: Data de Nascimento dateformat: type: string description: Formato da Data enum: - yyyy-MM-dd - dd/MM/yyyy label: Formato da Data referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetMarketplaceDataInputSchema: type: object properties: doc: type: string description: CNPJ da empresa pattern: >- ^([0-9A-Z]{12}[0-9]{2}|[0-9A-Z]{2}\.[0-9A-Z]{3}\.[0-9A-Z]{3}/[0-9A-Z]{4}-[0-9]{2})$ label: CNPJ marketplacename: type: string description: Nome do marketplace identificado productcategory: type: string description: Categoria dos produtos comercializados sellertotalproducts: type: string description: Quantidade total de produtos vendidos no marketplace sellerrating: type: string description: Nível de avaliação do vendedor no marketplace referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite next: type: string description: >- Identificador da próxima página. Use o valor retornado em NextPageId com o modificador .next(x) no campo Datasets. label: Próxima página required: - doc DatasetMediaProfileAndExposureInputSchema: type: object properties: doc: type: string description: CNPJ da empresa pattern: ^[0-9A-Z]{2}\.[0-9A-Z]{3}\.[0-9A-Z]{3}/[0-9A-Z]{4}-[0-9]{2}$ label: CNPJ title: type: string description: Título da notícia sourcename: type: string description: Nome da fonte responsável pela notícia categories: type: string description: Categoria da notícia label: type: string description: Classificação de sentimento atribuída à notícia enum: - NEGATIVE - POSITIVE - NEUTRAL - UNDEFINED - POLARIZED - SLIGHTLYPOSITIVE - SLIGHTLYNEGATIVE keywords: type: string description: >- Permite restringir os conteúdos retornados com base em palavras-chave específicas, separadas por vírgula. keywords_operator: type: string description: Define a lógica de combinação entre as palavras-chave informadas. enum: - OR - AND referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: >- Quantidade máxima de registros retornados. Use o modificador .limit(x) no campo Datasets. label: Limite next: type: string description: >- Identificador da próxima página. Use o valor retornado em NextPageId com o modificador .next(x) no campo Datasets. label: Próxima página required: - doc DatasetMerchantCategoryDataInputSchema: type: object properties: doc: type: string description: CNPJ da empresa pattern: >- ^([0-9A-Z]{12}[0-9]{2}|[0-9A-Z]{2}\.[0-9A-Z]{3}\.[0-9A-Z]{3}/[0-9A-Z]{4}-[0-9]{2})$ label: CNPJ referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetMinisterioDoTrabalhoEDoEmpregoMteInfracoesTrabalhistasInputSchema: type: object properties: doc: type: string label: Documento description: Documento a ser consultado. Pode ser enviado com ou sem formatação. required: - doc DatasetMinisterioDoTrabalhoPisInputSchema: type: object properties: doc: type: string label: Documento description: Documento a ser consultado. Pode ser enviado com ou sem formatação. required: - doc DatasetMinisterioPublicoDoEstadoDeMatoGrossoMpmtProcedimentosInvestigatoriosExtrajudiciaisInputSchema: type: object properties: doc: type: string label: Documento description: Documento a ser consultado. Pode ser enviado com ou sem formatação. required: [] DatasetMinisterioPublicoFederalCertidaoNegativaInputSchema: type: object properties: doc: type: string label: Documento description: Documento a ser consultado. Pode ser enviado com ou sem formatação. required: - doc DatasetMptMinisterioPublicoDoTrabalhoInputSchema: type: object properties: regiao: type: string enum: - '1' - '2' - '3' - '4' - '5' - '6' - '7' - '8' - '9' - '10' - '11' - '12' - '13' - '14' - '15' - '16' - '17' - '18' - '19' - '20' - '21' - '22' - '23' - '24' oneOf: - const: '1' title: Procuradoria Regional do Trabalho da 1ª Região description: Rio de Janeiro (RJ) - const: '2' title: Procuradoria Regional do Trabalho da 2ª Região description: São Paulo - capital (SP) - const: '3' title: Procuradoria Regional do Trabalho da 3ª Região description: Minas Gerais (MG) - const: '4' title: Procuradoria Regional do Trabalho da 4ª Região description: Rio Grande do Sul (RS) - const: '5' title: Procuradoria Regional do Trabalho da 5ª Região description: Bahia (BA) - const: '6' title: Procuradoria Regional do Trabalho da 6ª Região description: Pernambuco (PE) - const: '7' title: Procuradoria Regional do Trabalho da 7ª Região description: Ceará (CE) - const: '8' title: Procuradoria Regional do Trabalho da 8ª Região description: Amapá e Pará (AP e PA) - const: '9' title: Procuradoria Regional do Trabalho da 9ª Região description: Paraná (PR) - const: '10' title: Procuradoria Regional do Trabalho da 10ª Região description: Distrito Federal e Tocantins (DF e TO) - const: '11' title: Procuradoria Regional do Trabalho da 11ª Região description: Amazonas e Roraima (AM e RR) - const: '12' title: Procuradoria Regional do Trabalho da 12ª Região description: Santa Catarina (SC) - const: '13' title: Procuradoria Regional do Trabalho da 13ª Região description: Paraíba (PB) - const: '14' title: Procuradoria Regional do Trabalho da 14ª Região description: Acre e Rondônia (AC e RO) - const: '15' title: Procuradoria Regional do Trabalho da 15ª Região description: São Paulo - interior (SP) - const: '16' title: Procuradoria Regional do Trabalho da 16ª Região description: Maranhão (MA) - const: '17' title: Procuradoria Regional do Trabalho da 17ª Região description: Espírito Santo (ES) - const: '18' title: Procuradoria Regional do Trabalho da 18ª Região description: Goiás (GO) - const: '19' title: Procuradoria Regional do Trabalho da 19ª Região description: Alagoas (AL) - const: '20' title: Procuradoria Regional do Trabalho da 20ª Região description: Sergipe (SE) - const: '21' title: Procuradoria Regional do Trabalho da 21ª Região description: Rio Grande do Norte (RN) - const: '22' title: Procuradoria Regional do Trabalho da 22ª Região description: Piauí (PI) - const: '23' title: Procuradoria Regional do Trabalho da 23ª Região description: Mato Grosso (MT) - const: '24' title: Procuradoria Regional do Trabalho da 24ª Região description: Mato Grosso do Sul (MS) description: >- Selecione a Procuradoria Regional do Trabalho responsável pela localidade consultada. label: Região x-fern-enum: '1': name: Value1 '2': name: Value2 '3': name: Value3 '4': name: Value4 '5': name: Value5 '6': name: Value6 '7': name: Value7 '8': name: Value8 '9': name: Value9 '10': name: Value10 '11': name: Value11 '12': name: Value12 '13': name: Value13 '14': name: Value14 '15': name: Value15 '16': name: Value16 '17': name: Value17 '18': name: Value18 '19': name: Value19 '20': name: Value20 '21': name: Value21 '22': name: Value22 '23': name: Value23 '24': name: Value24 doc: type: string label: Documento description: Documento a ser consultado. Pode ser enviado com ou sem formatação. required: - regiao - doc DatasetNfeNotaFiscalEletronicaCompletaInputSchema: type: object properties: chave: type: string description: O parâmetro CHAVE pode ser enviado com qualquer outro. label: CHAVE required: - chave DatasetNfeNotaFiscalEletronicaInutilizacoesInputSchema: type: object properties: ano: type: string description: '' label: ANO doc: type: string label: Documento description: Documento a ser consultado. Pode ser enviado com ou sem formatação. required: - ano - doc DatasetNivelSocioeconomicoERendaEstimadaInputSchema: type: object properties: doc: type: string label: Documento description: Documento a ser consultado. Pode ser enviado com ou sem formatação. required: - doc DatasetObitoInputSchema: type: object properties: doc: type: string label: Documento description: Documento a ser consultado. Pode ser enviado com ou sem formatação. required: - doc DatasetOccupationDataInputSchema: type: object properties: doc: type: string description: CPF da pessoa (apenas números) pattern: ^([0-9]{11}|[0-9]{3}\.[0-9]{3}\.[0-9]{3}-[0-9]{2})$ label: CPF sector: type: string description: Setor da entidade empregadora enum: - PRIVATE - PUBLIC companyname: type: string description: Nome da empresa ou entidade area: type: string description: Área de atuação dentro da empresa level: type: string description: Cargo, função ou posição ocupada status: type: string description: Situação do vínculo profissional enum: - ACTIVE - INACTIVE referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetOfacSancoesInputSchema: type: object properties: sobrenome{1}: type: string description: '' label: SOBRENOME{1} nome{0}: type: string description: '' label: NOME{0} required: - nome{0} DatasetOndemandAdministrativeSanctionsPersonInputSchema: type: object properties: doc: type: string description: Documento de identificação pattern: ^([0-9]{11}|[0-9]{3}\.[0-9]{3}\.[0-9]{3}-[0-9]{2})$ label: CPF birthdate: type: string description: Data de Nascimento pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ label: Data de Nascimento dateformat: type: string description: Formato da Data enum: - yyyy-MM-dd - dd/MM/yyyy label: Formato da Data referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetOndemandAnttDataVehicleInputSchema: type: object properties: doc: type: string description: Documento de identificação label: Documento doctype: type: string description: >- Identificador do transportador, quando a consulta é realizada por documento. Obrigatória neste dataset. example: CNPJ querytype: type: string description: >- Define o tipo de identificador do transportador utilizado na consulta. Obrigatória neste dataset. example: docnumber enum: - docnumber - rntrc licenseplate: type: string description: licenseplate example: PLATE label: Placa rntrc: type: string description: >- Registro RNTRC do transportador, utilizado como alternativa à identificação por documento (acima). Obrigatória neste dataset. referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - querytype - licenseplate allOf: - if: properties: querytype: const: docnumber then: required: - doc - doctype - if: properties: querytype: const: rntrc then: required: - rntrc DatasetOndemandCartaosusPersonInputSchema: type: object properties: doc: type: string description: CPF da pessoa (apenas números) pattern: ^([0-9]{11}|[0-9]{3}\.[0-9]{3}\.[0-9]{3}-[0-9]{2})$ label: CPF source: type: string description: >- Unidade Federativa utilizada como fonte da consulta ao Cartão SUS. Atualmente, disponível somente para o estado da Bahia. Obrigatória neste dataset. example: estado enum: - BA referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc - source DatasetOndemandCdcitCompanyInputSchema: type: object properties: doc: type: string description: CNPJ da empresa pattern: >- ^([0-9A-Z]{12}[0-9]{2}|[0-9A-Z]{2}\.[0-9A-Z]{3}\.[0-9A-Z]{3}/[0-9A-Z]{4}-[0-9]{2})$ label: CNPJ referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetOndemandCertDebtAbsenceByStateCompanyInputSchema: type: object properties: doc: type: string description: CNPJ da empresa pattern: ^[0-9A-Z]{2}\.[0-9A-Z]{3}\.[0-9A-Z]{3}/[0-9A-Z]{4}-[0-9]{2}$ label: CNPJ uf: type: string description: Unidade federativa da consulta. Obrigatória neste dataset*. label: UF addresscore: type: string description: >- Núcleo do endereço da entidade, utilizado por algumas fontes estaduais para validação da certidão. Obrigatória neste dataset*. addressnumber: type: string description: Número do endereço da entidade. Obrigatória neste dataset*. addresstypology: type: string description: Tipologia do endereço informado. Obrigatória neste dataset*. neighborhood: type: string description: Bairro do endereço da entidade. Obrigatória neste dataset*. zipcode: type: string description: Código postal do endereço. Obrigatória neste dataset*. pattern: ^(?:[0-9]{8}|[0-9]{5}-[0-9]{3})$ label: CEP city: type: string description: Cidade do endereço informado. Obrigatória neste dataset*. state: type: string description: Estado do endereço informado. Obrigatória neste dataset*. stateregistration: type: string description: Número de Inscrição Estadual da entidade. Obrigatório quando uf{MA}. name: type: string description: Nome da entidade consultada. Obrigatória neste dataset*. label: Nome dividaativa: type: string description: >- Indica se a consulta deve considerar a base de Dívida Ativa. Válido apenas para o estado de SP. referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetOndemandCertDebtAbsenceByStatePersonInputSchema: type: object properties: doc: type: string description: CPF da pessoa (apenas números) pattern: ^([0-9]{11}|[0-9]{3}\.[0-9]{3}\.[0-9]{3}-[0-9]{2})$ label: CPF uf: type: string description: >- Unidade da federação utilizada como base da consulta. Obrigatória neste dataset*. enum: - AC - AL - AM - AP - BA - CE - DF - ES - GO - MA - MG - MS - MT - PA - PB - PE - PI - PR - RJ - RN - RO - RR - RS - SC - SE - SP - TO label: UF addresscore: type: string description: >- Núcleo do endereço utilizado para consultas que exigem validação adicional por fonte estadual. Obrigatória neste dataset*. addressnumber: type: string description: >- Número do endereço informado na consulta. Obrigatória neste dataset*. addresstypology: type: string description: Tipologia do endereço informado. Obrigatória neste dataset. * neighborhood: type: string description: Bairro associado ao endereço informado. zipcode: type: string description: Código postal associado ao endereço. Obrigatória neste dataset*. pattern: ^[0-9]{5}-[0-9]{3}$ label: CEP city: type: string description: >- Cidade utilizada como critério adicional de consulta. Obrigatória neste dataset*. state: type: string description: >- Estado informado como complemento de localização. Obrigatória neste dataset*. fillmotheraddress: type: string description: >- Indica se o UF pode ser inferido a partir do endereço associado à mãe quando não houver endereço direto disponível enum: - 'true' - 'false' fillworkaddress: type: string description: >- Indica se o UF pode ser inferido a partir do endereço associado ao trabalho quando não houver endereço direto disponível enum: - 'true' - 'false' name: type: string description: >- Nome informado para apoio à identificação da pessoa consultada. Obrigatória neste dataset*. label: Nome referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetOndemandCertLaborDebtAbsenceCompanyInputSchema: type: object properties: doc: type: string description: CNPJ da empresa pattern: >- ^([0-9A-Z]{12}[0-9]{2}|[0-9A-Z]{2}\.[0-9A-Z]{3}\.[0-9A-Z]{3}/[0-9A-Z]{4}-[0-9]{2})$ label: CNPJ referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetOndemandCertRaisPersonInputSchema: type: object properties: doc: type: string description: Documento de identificação pattern: ^([0-9]{11}|[0-9]{3}\.[0-9]{3}\.[0-9]{3}-[0-9]{2})$ label: CPF birthdate: type: string description: Data de Nascimento pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ label: Data de Nascimento dateformat: type: string description: Formato da Data enum: - yyyy-MM-dd - dd/MM/yyyy label: Formato da Data referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetOndemandComexCompanyInputSchema: type: object properties: doc: type: string description: CNPJ da empresa pattern: >- ^([0-9A-Z]{12}[0-9]{2}|[0-9A-Z]{2}\.[0-9A-Z]{3}\.[0-9A-Z]{3}/[0-9A-Z]{4}-[0-9]{2})$ label: CNPJ referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetOndemandComprotProcessesCompanyInputSchema: type: object properties: doc: type: string description: Documento de identificação pattern: >- ^([0-9A-Z]{12}[0-9]{2}|[0-9A-Z]{2}\.[0-9A-Z]{3}\.[0-9A-Z]{3}/[0-9A-Z]{4}-[0-9]{2})$ label: CNPJ startdate: type: string description: Data de início do período a ser consultado pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ label: Data enddate: type: string description: Data de término do período a ser consultado pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ label: Data dateformat: type: string description: Formato da data de referência informada label: Formato da Data referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetOndemandComprotProcessesPersonInputSchema: type: object properties: doc: type: string description: Documento de identificação pattern: ^([0-9]{11}|[0-9]{3}\.[0-9]{3}\.[0-9]{3}-[0-9]{2})$ label: CPF startdate: type: string description: Data de início do período a ser consultado pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ label: Data enddate: type: string description: Data de término do período a ser consultado pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ label: Data dateformat: type: string description: Formato da data de referência informada label: Formato da Data birthdate: type: string description: Data de Nascimento pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ label: Data de Nascimento referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetOndemandDataReceiptInputSchema: type: object properties: receiptnumber: type: string description: receiptnumber label: Número da Nota Fiscal referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - receiptnumber DatasetOndemandDetranDataVehicleInputSchema: type: object properties: licenseplate: type: string description: licenseplate label: Placa uf: type: string description: >- Unidade Federativa onde a consulta será realizada. Atualmente, disponível somente para o estado do Rio de Janeiro. Obrigatória neste dataset. example: STATE label: UF enum: - RJ referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - licenseplate - uf DatasetOndemandEcdCompanyInputSchema: type: object properties: doc: type: string description: CNPJ da empresa pattern: ^[0-9A-Z]{2}\.[0-9A-Z]{3}\.[0-9A-Z]{3}/[0-9A-Z]{4}-[0-9]{2}$ label: CNPJ reference_year: type: string description: >- Ano-calendário da escrituração contábil a ser consultada. Obrigatória neste dataset. example: yyyy referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc - reference_year DatasetOndemandEsocialCertificatePersonInputSchema: type: object properties: doc: type: string description: Documento de identificação pattern: ^([0-9]{11}|[0-9]{3}\.[0-9]{3}\.[0-9]{3}-[0-9]{2})$ label: CPF nit: type: string description: Número de Inscrição do Trabalhador birthdate: type: string description: Data de Nascimento pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ label: Data de Nascimento dateformat: type: string description: Formato da Data enum: - yyyy-MM-dd - dd/MM/yyyy label: Formato da Data referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetOndemandFreightServiceCertificateReceiptInputSchema: type: object properties: receiptnumber: type: string description: receiptnumber label: Número da Nota Fiscal referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - receiptnumber DatasetOndemandHealthInsurancePersonInputSchema: type: object properties: doc: type: string description: Documento de identificação pattern: ^([0-9]{11}|[0-9]{3}\.[0-9]{3}\.[0-9]{3}-[0-9]{2})$ label: CPF referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetOndemandLaborLawsuitsCertificateCompanyInputSchema: type: object properties: doc: type: string description: Documento de identificação pattern: >- ^([0-9A-Z]{12}[0-9]{2}|[0-9A-Z]{2}\.[0-9A-Z]{3}\.[0-9A-Z]{3}/[0-9A-Z]{4}-[0-9]{2})$ label: CNPJ source: type: string description: >- Fonte da consulta, sendo TRT2 para processos físicos ou TRT2PJe para processos eletrônicos (por padrão se não informado). example: TRT2PJe enum: - TRT2 - TRT2PJe referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc - source DatasetOndemandLaborLawsuitsCertificatePersonInputSchema: type: object properties: doc: type: string description: Documento de identificação pattern: ^([0-9]{11}|[0-9]{3}\.[0-9]{3}\.[0-9]{3}-[0-9]{2})$ label: CPF source: type: string description: >- Fonte da consulta, sendo TRT2 para processos físicos ou TRT2PJe para processos eletrônicos (por padrão se não informado). enum: - TRT2 - TRT2PJe birthdate: type: string description: Data de Nascimento pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ label: Data de Nascimento dateformat: type: string description: Formato da Data enum: - yyyy-MM-dd - dd/MM/yyyy label: Formato da Data referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc - source DatasetOndemandLegalRepresentativeCompanyInputSchema: type: object properties: doc: type: string description: CNPJ da empresa pattern: >- ^([0-9A-Z]{12}[0-9]{2}|[0-9A-Z]{2}\.[0-9A-Z]{3}\.[0-9A-Z]{3}/[0-9A-Z]{4}-[0-9]{2})$ label: CNPJ cpf: type: string description: Documento de identidade do representante legal. pattern: ^([0-9]{11}|[0-9]{3}\.[0-9]{3}\.[0-9]{3}-[0-9]{2})$ label: CPF referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetOndemandMunicipalRegistrationCompanyInputSchema: type: object properties: doc: type: string description: CNPJ da empresa pattern: >- ^([0-9A-Z]{12}[0-9]{2}|[0-9A-Z]{2}\.[0-9A-Z]{3}\.[0-9A-Z]{3}/[0-9A-Z]{4}-[0-9]{2})$ label: CNPJ referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetOndemandNadaConstaPersonInputSchema: type: object properties: doc: type: string description: Documento de identificação pattern: ^([0-9]{11}|[0-9]{3}\.[0-9]{3}\.[0-9]{3}-[0-9]{2})$ label: CPF court: type: string description: Tribunal label: Tribunal enum: - TRF1 - TRF2 - TRF3 - TRF4 - TRF5 - TRF6 - MPF oneOf: - const: TRF1 title: Tribunal Regional Federal da 1ª Região description: >- Acre, Amapá, Amazonas, Bahia, Distrito Federal, Goiás, Maranhão, Mato Grosso, Pará, Piauí, Rondônia, Roraima e Tocantins - const: TRF2 title: Tribunal Regional Federal da 2ª Região description: Espírito Santo e Rio de Janeiro - const: TRF3 title: Tribunal Regional Federal da 3ª Região description: Mato Grosso do Sul e São Paulo - const: TRF4 title: Tribunal Regional Federal da 4ª Região description: Paraná, Rio Grande do Sul e Santa Catarina - const: TRF5 title: Tribunal Regional Federal da 5ª Região description: >- Alagoas, Ceará, Paraíba, Pernambuco, Rio Grande do Norte e Sergipe - const: TRF6 title: Tribunal Regional Federal da 6ª Região description: Minas Gerais - const: MPF title: Ministério Público Federal description: Abrangência nacional state: type: string description: Estado pattern: ^[A-Z]{2}$ label: Estado (UF) op: type: string description: Esferas de pesquisa (válidas para todos os tribunais) label: Esfera enum: - CIVIL - CRIMINAL - PARA FINS ELEITORAIS birthdate: type: string description: Data de Nascimento pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ label: Data de Nascimento dateformat: type: string description: Formato da Data enum: - yyyy-MM-dd - dd/MM/yyyy label: Formato da Data referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetOndemandPcAntecedenteByStatePersonInputSchema: type: object properties: doc: type: string description: CPF da pessoa (apenas números) pattern: ^([0-9]{11}|[0-9]{3}\.[0-9]{3}\.[0-9]{3}-[0-9]{2})$ label: CPF rg: type: string description: >- Número do documento de identidade utilizado na consulta. Obrigatória neste dataset. example: RG uf: type: string description: >- Unidade Federativa consultada para emissão da certidão. Obrigatória neste dataset. example: UF label: UF enum: - BA - CE - ES - MG - MS - MT - PA - PE - RR - RS - SC - SP mothername: type: string description: Nome da mãe. Obrigatória neste dataset*. fathername: type: string description: Nome do pai. Obrigatória neste dataset*. rgissuingagency: type: string description: >- Agência emissora do documento de identidade. Obrigatória neste dataset para os estados MT, PE e MS. rgissuinguf: type: string description: >- Unidade Federativa da agência emissora do documento de identidade. Obrigatória neste dataset para os estados MT, PA, MS e ES. rgexpeditiondate: type: string description: >- Data de emissão do documento de identidade. Obrigatória neste dataset para o estado SP. pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ label: Data dateformat: type: string description: >- Formato da data de emissão do documento de identidade. Obrigatória neste dataset para o estado SP. label: Formato da Data placeofbirth: type: string description: >- Local de nascimento. Obrigatória neste dataset para os estados MT, PE, PA e SC. addresscore: type: string description: Endereço principal. Obrigatória neste dataset*. addressnumber: type: string description: Número do endereço. Obrigatória neste dataset*. neighborhood: type: string description: Bairro do endereço. Obrigatória neste dataset*. city: type: string description: Cidade do endereço. Obrigatória neste dataset*. addressstate: type: string description: Unidade Federativa (UF) do endereço. Obrigatória neste dataset*. zipcode: type: string description: Código postal do endereço. Obrigatória neste dataset*. pattern: ^[0-9]{5}-[0-9]{3}$ label: CEP referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc - uf - rg DatasetOndemandPesquisaProtestoByStateCompanyInputSchema: type: object properties: doc: type: string description: Documento de identificação pattern: >- ^([0-9A-Z]{12}[0-9]{2}|[0-9A-Z]{2}\.[0-9A-Z]{3}\.[0-9A-Z]{3}/[0-9A-Z]{4}-[0-9]{2})$ label: CNPJ uf: type: string description: Estado abreviado sob UF example: XX label: UF referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc - uf DatasetOndemandPesquisaProtestoByStatePersonInputSchema: type: object properties: doc: type: string description: Documento de identificação pattern: ^([0-9]{11}|[0-9]{3}\.[0-9]{3}\.[0-9]{3}-[0-9]{2})$ label: CPF uf: type: string description: Estado abreviado sob UF example: XX label: UF birthdate: type: string description: Data de Nascimento pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ label: Data de Nascimento dateformat: type: string description: Formato da Data enum: - yyyy-MM-dd - dd/MM/yyyy label: Formato da Data referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc - uf DatasetOndemandPfAntecedentePersonInputSchema: type: object properties: doc: type: string description: CPF da pessoa (apenas números) pattern: ^([0-9]{11}|[0-9]{3}\.[0-9]{3}\.[0-9]{3}-[0-9]{2})$ label: CPF mothername: type: string description: Nome da mãe. Obrigatória neste dataset*. referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetOndemandPgmeiCompanyInputSchema: type: object properties: doc: type: string description: Documento de identificação pattern: >- ^([0-9A-Z]{12}[0-9]{2}|[0-9A-Z]{2}\.[0-9A-Z]{3}\.[0-9A-Z]{3}/[0-9A-Z]{4}-[0-9]{2})$ label: CNPJ usefullhistory: type: string description: >- Define que deverão ser retornados todos os dados históricos disponíveis na fonte, e não apenas o ano mais recente. enum: - 'true' - 'false' referencedate: type: string description: >- Especifica a data limite para filtrar os resultados, considerando apenas entradas anteriores ou iguais a esta data. pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ label: Data limit: type: number description: Limite de resultados label: Limite required: - doc DatasetOndemandPisPersonInputSchema: type: object properties: doc: type: string description: Documento de identificação pattern: ^([0-9]{11}|[0-9]{3}\.[0-9]{3}\.[0-9]{3}-[0-9]{2})$ label: CPF birthdate: type: string description: Data de Nascimento pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ label: Data de Nascimento dateformat: type: string description: Formato da Data enum: - yyyy-MM-dd - dd/MM/yyyy label: Formato da Data referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetOndemandPoliceReportBoPersonInputSchema: type: object properties: doc: type: string description: CPF da pessoa (apenas números) pattern: ^([0-9]{11}|[0-9]{3}\.[0-9]{3}\.[0-9]{3}-[0-9]{2})$ label: CPF protocol: type: string description: >- Protocolo do boletim de ocorrência informado no registro. Obrigatória neste dataset. example: DRIVER_ID password: type: string description: >- Senha de acesso associada ao boletim de ocorrência. Obrigatória neste dataset. example: TEXTO uf: type: string description: >- Unidade Federativa onde o boletim foi registrado. Obrigatória neste dataset. example: STATE label: UF enum: - RJ referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc - protocol - password - uf DatasetOndemandPublicProjectsCompanyInputSchema: type: object properties: doc: type: string description: CNPJ da empresa pattern: >- ^([0-9A-Z]{12}[0-9]{2}|[0-9A-Z]{2}\.[0-9A-Z]{3}\.[0-9A-Z]{3}/[0-9A-Z]{4}-[0-9]{2})$ label: CNPJ referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetOndemandRaisConsultaCreaPersonInputSchema: type: object properties: doc: type: string description: CPF da pessoa (apenas números) pattern: ^([0-9]{11}|[0-9]{3}\.[0-9]{3}\.[0-9]{3}-[0-9]{2})$ label: CPF cnpj: type: string description: >- CNPJ da empresa específica associada à declaração RAIS da pessoa consultada.Obrigatória neste dataset. example: CNPJ pattern: ^[0-9A-Z]{2}\.[0-9A-Z]{3}\.[0-9A-Z]{3}/[0-9A-Z]{4}-[0-9]{2}$ label: CNPJ baseyear: type: string description: >- Define o ano-base da consulta RAIS, considerando a disponibilidade histórica da fonte.Obrigatória neste dataset. example: yyyy referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc - cnpj - baseyear DatasetOndemandRegularityCertificateIbamaCompanyInputSchema: type: object properties: doc: type: string description: CNPJ da empresa pattern: >- ^([0-9A-Z]{12}[0-9]{2}|[0-9A-Z]{2}\.[0-9A-Z]{3}\.[0-9A-Z]{3}/[0-9A-Z]{4}-[0-9]{2})$ label: CNPJ referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetOndemandRestituicaoPersonInputSchema: type: object properties: doc: type: string description: CPF da pessoa (apenas números) pattern: ^([0-9]{11}|[0-9]{3}\.[0-9]{3}\.[0-9]{3}-[0-9]{2})$ label: CPF birthdate: type: string description: Data de nascimento do indivíduo. Obrigatória neste dataset*. pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ label: Data dateformat: type: string description: >- Formato da data de nascimento do indivíduo. Obrigatória neste dataset*. label: Formato da Data year: type: string description: Ano de referência da restituição consultada referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetOndemandRfQsaCompanyInputSchema: type: object properties: doc: type: string description: CNPJ da empresa pattern: >- ^([0-9A-Z]{12}[0-9]{2}|[0-9A-Z]{2}\.[0-9A-Z]{3}\.[0-9A-Z]{3}/[0-9A-Z]{4}-[0-9]{2})$ label: CNPJ referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetOndemandRfStatusCompanyInputSchema: type: object properties: doc: type: string description: CNPJ da empresa pattern: >- ^([0-9A-Z]{12}[0-9]{2}|[0-9A-Z]{2}\.[0-9A-Z]{3}\.[0-9A-Z]{3}/[0-9A-Z]{4}-[0-9]{2})$ label: CNPJ referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetOndemandRfStatusPersonInputSchema: type: object properties: doc: type: string description: CPF da pessoa (apenas números) pattern: ^([0-9]{11}|[0-9]{3}\.[0-9]{3}\.[0-9]{3}-[0-9]{2})$ label: CPF birthdate: type: string description: Data de nascimento. Obrigatória neste dataset*. pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ label: Data dateformat: type: string description: Formato da data de nascimento. Obrigatória neste dataset*. label: Formato da Data referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetOndemandSanitaryLicenseCompanyInputSchema: type: object properties: doc: type: string description: CNPJ da empresa pattern: ^[0-9A-Z]{2}\.[0-9A-Z]{3}\.[0-9A-Z]{3}/[0-9A-Z]{4}-[0-9]{2}$ label: CNPJ city: type: string description: >- Município utilizado como base para a consulta da licença sanitária. Obrigatória neste dataset. example: CITY uf: type: string description: >- Unidade federativa do município informado. Atualmente, apenas consultas para o estado de São Paulo são suportadas. Obrigatória neste dataset. example: UF label: UF enum: - SP referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc - city - uf DatasetOndemandSanitaryLicensePersonInputSchema: type: object properties: doc: type: string description: CPF da pessoa (apenas números) pattern: ^([0-9]{11}|[0-9]{3}\.[0-9]{3}\.[0-9]{3}-[0-9]{2})$ label: CPF city: type: string description: >- Município utilizado para localizar a licença sanitária no cadastro municipal. Obrigatória neste dataset. example: CITY uf: type: string description: >- Unidade federativa da consulta. Atualmente suportado apenas o estado de São Paulo. Obrigatória neste dataset. example: UF label: UF enum: - SP referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc - city - uf DatasetOndemandSeguroDesempregoPersonInputSchema: type: object properties: doc: type: string description: Documento de identificação pattern: ^([0-9]{11}|[0-9]{3}\.[0-9]{3}\.[0-9]{3}-[0-9]{2})$ label: CPF nit: type: string description: Número de Inscrição do Trabalhador birthdate: type: string description: Data de Nascimento pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ label: Data de Nascimento dateformat: type: string description: Formato da Data enum: - yyyy-MM-dd - dd/MM/yyyy label: Formato da Data referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc - nit DatasetOndemandSicarStatementAddressInputSchema: type: object properties: carnumber: type: string description: carnumber referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - carnumber DatasetOndemandSigefInstallmentsCompanyInputSchema: type: object properties: doc: type: string description: Documento de identificação pattern: >- ^([0-9A-Z]{12}[0-9]{2}|[0-9A-Z]{2}\.[0-9A-Z]{3}\.[0-9A-Z]{3}/[0-9A-Z]{4}-[0-9]{2})$ label: CNPJ scnr: type: string description: Código de Imóvel Rural referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetOndemandSigefInstallmentsPersonInputSchema: type: object properties: doc: type: string description: Documento de identificação pattern: ^([0-9]{11}|[0-9]{3}\.[0-9]{3}\.[0-9]{3}-[0-9]{2})$ label: CPF scnr: type: string description: Código de Imóvel Rural birthdate: type: string description: Data de Nascimento pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ label: Data de Nascimento dateformat: type: string description: Formato da Data enum: - yyyy-MM-dd - dd/MM/yyyy label: Formato da Data referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetOndemandSimplesCompanyInputSchema: type: object properties: doc: type: string description: CNPJ da empresa pattern: >- ^([0-9A-Z]{12}[0-9]{2}|[0-9A-Z]{2}\.[0-9A-Z]{3}\.[0-9A-Z]{3}/[0-9A-Z]{4}-[0-9]{2})$ label: CNPJ referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetOndemandSintegraCompanyV2InputSchema: type: object properties: doc: type: string description: CNPJ da empresa pattern: >- ^([0-9A-Z]{12}[0-9]{2}|[0-9A-Z]{2}\.[0-9A-Z]{3}\.[0-9A-Z]{3}/[0-9A-Z]{4}-[0-9]{2})$ label: CNPJ uf: type: string description: >- Unidade Federativa onde a consulta ao SINTEGRA será realizada. Obrigatória neste dataset*. enum: - AC - BA - DF - GO - MA - MT - PA - PB - PR - RJ - RN - RO - SC - SE - TO label: UF referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc - uf DatasetOndemandSintegraCompanyInputSchema: type: object properties: doc: type: string description: Documento de identificação pattern: >- ^([0-9A-Z]{12}[0-9]{2}|[0-9A-Z]{2}\.[0-9A-Z]{3}\.[0-9A-Z]{3}/[0-9A-Z]{4}-[0-9]{2})$ label: CNPJ uf: type: string description: >- Trata-se da Unidade Federativa (UF) do Estado onde se realizará a consulta. Caso não seja informada, utilizaremos por padrão a que consta no endereço principal associado internamente ao CNPJ. label: UF referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc - uf DatasetOndemandSintegraPersonInputSchema: type: object properties: doc: type: string description: Documento de identificação pattern: ^([0-9]{11}|[0-9]{3}\.[0-9]{3}\.[0-9]{3}-[0-9]{2})$ label: CPF uf: type: string description: >- Trata-se da Unidade Federativa (UF) do Estado onde se realizará a consulta. Caso não seja informada, utilizaremos por padrão a que consta no endereço principal associado internamente ao CPF. label: UF fillmotheraddress: type: string description: >- Flag booleana para buscar o UF da entidade com base no endereço indireto da mãe, caso a entidade não tenha um endereço associado diretamente internamente. Esta flag por padrão é false, e serve como opt-in caso o UF não seja fornecido (e não exista um endereço diretamente associado), pois um endereço indireto dos pais não é 100% assertivo (se a pessoa se mudou morando bem longe dos pais, por exemplo). enum: - 'true' - 'false' fillworkaddress: type: string description: >- Flag booleana para buscar o UF da entidade com base no endereço indireto do trabalho, caso a entidade não tenha um endereço associado diretamente internamente. Esta flag por padrão é false, e serve como opt-in caso o UF não seja fornecido (e não exista um endereço diretamente associado), pois um endereço indireto do trabalho não é 100% assertivo (se a pessoa trabalhar remotamente, por exemplo). enum: - 'true' - 'false' birthdate: type: string description: Data de Nascimento pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ label: Data de Nascimento dateformat: type: string description: Formato da Data enum: - yyyy-MM-dd - dd/MM/yyyy label: Formato da Data referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc - uf DatasetOndemandTrafficTicketPersonInputSchema: type: object properties: doc: type: string description: CPF da pessoa (apenas números) pattern: ^([0-9]{11}|[0-9]{3}\.[0-9]{3}\.[0-9]{3}-[0-9]{2})$ label: CPF licensenumber: type: string description: >- Número da carteira de motorista da pessoa. Obrigatória neste dataset. example: DRIVER_ID uf: type: string description: >- Unidade Federativa responsável pela emissão da carteira de motorista. Obrigatória neste dataset. example: STATE label: UF referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc - licensenumber - uf DatasetOndemandTseElectoralDischargePersonInputSchema: type: object properties: doc: type: string description: CPF da pessoa (apenas números) pattern: ^([0-9]{11}|[0-9]{3}\.[0-9]{3}\.[0-9]{3}-[0-9]{2})$ label: CPF fathername: type: string description: fathername example: X mothername: type: string description: Nome completo da mãe. Obrigatória neste dataset*. referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetOndemandTsePollingPlacePersonInputSchema: type: object properties: doc: type: string description: CPF da pessoa (apenas números) pattern: ^([0-9]{11}|[0-9]{3}\.[0-9]{3}\.[0-9]{3}-[0-9]{2})$ label: CPF mothername: type: string description: Nome completo da mãe birthdate: type: string description: Data de nascimento pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ label: Data dateformat: type: string description: Formato da data de nascimento label: Formato da Data referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetOnlineAdsInputSchema: type: object properties: doc: type: string description: CPF da pessoa (apenas números) pattern: ^([0-9]{11}|[0-9]{3}\.[0-9]{3}\.[0-9]{3}-[0-9]{2})$ label: CPF activeads: type: string description: Quantidade de anúncios ativos totalads: type: string description: Total de anúncios postados admaxvalue: type: string description: Valor máximo entre os anúncios adminvalue: type: string description: Valor mínimo entre os anúncios portal: type: string description: Portal em que os anúncios foram publicados category: type: string description: Categoria dos anúncios publicados referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: >- Quantidade máxima de registros retornados. Use o modificador .limit(x) no campo Datasets. label: Limite required: - doc DatasetOnlineBettingComplianceInputSchema: type: object properties: doc: type: string description: Documento de identificação pattern: ^([0-9]{11}|[0-9]{3}\.[0-9]{3}\.[0-9]{3}-[0-9]{2})$ label: CPF birthdate: type: string description: Data de Nascimento pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ label: Data de Nascimento dateformat: type: string description: Formato da Data enum: - yyyy-MM-dd - dd/MM/yyyy label: Formato da Data referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetOnlineBettingPropensityInputSchema: type: object properties: doc: type: string description: CPF da pessoa (apenas números) pattern: ^([0-9]{11}|[0-9]{3}\.[0-9]{3}\.[0-9]{3}-[0-9]{2})$ label: CPF referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetOnlinePresenceInputSchema: type: object properties: doc: type: string description: CPF da pessoa (apenas números) pattern: ^([0-9]{11}|[0-9]{3}\.[0-9]{3}\.[0-9]{3}-[0-9]{2})$ label: CPF referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetOwnersElectoralDonorsInputSchema: type: object properties: doc: type: string description: CNPJ da empresa pattern: >- ^([0-9A-Z]{12}[0-9]{2}|[0-9A-Z]{2}\.[0-9A-Z]{3}\.[0-9A-Z]{3}/[0-9A-Z]{4}-[0-9]{2})$ label: CNPJ referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetOwnersIndustrialPropertyInputSchema: type: object properties: doc: type: string description: CNPJ da empresa pattern: >- ^([0-9A-Z]{12}[0-9]{2}|[0-9A-Z]{2}\.[0-9A-Z]{3}\.[0-9A-Z]{3}/[0-9A-Z]{4}-[0-9]{2})$ label: CNPJ referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: >- Quantidade máxima de registros retornados. Use o modificador .limit(x) no campo Datasets. label: Limite required: - doc DatasetOwnersInfluenceInputSchema: type: object properties: doc: type: string description: CNPJ da empresa pattern: >- ^([0-9A-Z]{12}[0-9]{2}|[0-9A-Z]{2}\.[0-9A-Z]{3}\.[0-9A-Z]{3}/[0-9A-Z]{4}-[0-9]{2})$ label: CNPJ referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetOwnersLawsuitsDistributionDataInputSchema: type: object properties: doc: type: string description: CNPJ da empresa pattern: >- ^([0-9A-Z]{12}[0-9]{2}|[0-9A-Z]{2}\.[0-9A-Z]{3}\.[0-9A-Z]{3}/[0-9A-Z]{4}-[0-9]{2})$ label: CNPJ capturedate: type: string description: Data de captura do processo pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ label: Data closedate: type: string description: Data de fechamento do processo pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ label: Data cnjsubject: type: string description: Número ou nome do assunto no CNJ inferido cnjproceduretype: type: string description: Número ou nome do tipo do processo no CNJ inferido courtlevel: type: string description: Nível do tribunal enum: - '1' - '2' - '3' x-fern-enum: '1': name: Value1 '2': name: Value2 '3': name: Value3 courtname: type: string description: Nome do tribunal courttype: type: string description: Tipo do tribunal enum: - CIVEL - CRIMINAL - TRIBUTARIA - PREVIDENCIARIA - TRABALHISTA - ESPECIAL CIVEL - ESPECIAL CRIMINAL - ADMINISTRATIVA - ELEITORAL - FAZENDA - ESPECIAL FAZENDA partypolarity: type: string description: Polaridade da parte enum: - ACTIVE - PASSIVE - NEUTRAL partytype: type: string description: Tipo da parte enum: - AUTHOR - DEFENDANT - CLAIMANT - CLAIMED - LAWYER - REPORTER - ATTORNEY - WITNESS - VICTIM - JUDGE - INMATE - OTHER noticedate: type: string description: Data de notificação do processo pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ label: Data state: type: string description: Estado status: type: string description: Status do processo enum: - ATIVO - DISTRIBUIDO - BAIXADO - APENSO - DECIDIDO - AUTUADO - EXECUCAO - FINALIZADO - ENCERRADO - EM GRAU DE RECURSO - REDISTRIBUIDO - TRANSITADO EM JULGADO - ARQUIVADO - JULGADO - INDEFINIDO resjudicatadate: type: string description: Data de Res Judicata pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ label: Data value: type: string description: Valor disputado no processo referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetOwnersLawsuitsInputSchema: type: object properties: doc: type: string description: CNPJ da empresa pattern: >- ^([0-9A-Z]{12}[0-9]{2}|[0-9A-Z]{2}\.[0-9A-Z]{3}\.[0-9A-Z]{3}/[0-9A-Z]{4}-[0-9]{2})$ label: CNPJ capturedate: type: string description: Data de captura do processo pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ label: Data closedate: type: string description: Data de finalização, baixa ou arquivamento do processo pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ label: Data cnjsubject: type: string description: >- Número ou nome do assunto do processo no CNJ, conforme tabela oficial disponível no site do CNJ cnjproceduretype: type: string description: Número ou nome do tipo do processo no CNJ courtlevel: type: string description: Instância do processo enum: - '1' - '2' - '3' x-fern-enum: '1': name: Value1 '2': name: Value2 '3': name: Value3 courtname: type: string description: Nome do tribunal courttype: type: string description: Tipo de vara ou competência do processo enum: - CIVEL - CRIMINAL - TRIBUTARIA - PREVIDENCIARIA - TRABALHISTA - ESPECIAL CIVEL - ESPECIAL CRIMINAL - ADMINISTRATIVA - ELEITORAL - FAZENDA - ESPECIAL FAZENDA partypolarity: type: string description: Polaridade da parte no processo enum: - ACTIVE - PASSIVE - NEUTRAL partytype: type: string description: Tipo da parte no processo enum: - AUTHOR - DEFENDANT - CLAIMANT - CLAIMED - LAWYER - REPORTER - ATTORNEY - WITNESS - VICTIM - JUDGE - INMATE - OTHER noticedate: type: string description: Data de abertura ou distribuição do processo pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ label: Data state: type: string description: Estado de tramitação do processo (UF) status: type: string description: Status do processo enum: - ATIVO - DISTRIBUIDO - BAIXADO - APENSO - DECIDIDO - AUTUADO - EXECUCAO - FINALIZADO - ENCERRADO - EM GRAU DE RECURSO - REDISTRIBUIDO - TRANSITADO EM JULGADO - ARQUIVADO - JULGADO - INDEFINIDO - SUSPENSO resjudicatadate: type: string description: Data de trânsito em julgado pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ label: Data value: type: string description: Valor disputado no processo returnupdates: type: string description: >- Define se as movimentações dos processos devem ser retornadas, impactando diretamente o volume da resposta enum: - 'true' - 'false' applyFiltersToStats: type: string description: >- Indica se as estatísticas agregadas devem considerar os filtros aplicados na consulta enum: - 'true' - 'false' returncvmprocesses: type: string description: >- Define se processos administrativos da CVM devem ser incluídos no retorno, quando existentes. Processos da CVM possuem numeração específica e não retornam alguns campos, como CourtLevel e CourtType enum: - 'true' - 'false' updateslimit: type: integer description: >- Limita a quantidade de movimentações retornadas por processo, priorizadas pela recência minimum: 0 referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: >- Quantidade máxima de registros retornados. Use o modificador .limit(x) no campo Datasets. label: Limite next: type: string description: >- Identificador da próxima página. Use o valor retornado em NextPageId com o modificador .next(x) no campo Datasets. label: Próxima página required: - doc DatasetPartnerB2eScorePersonInputSchema: type: object properties: doc: type: string description: Documento de identificação pattern: ^([0-9]{11}|[0-9]{3}\.[0-9]{3}\.[0-9]{3}-[0-9]{2})$ label: CPF name: type: string description: Nome Completo example: NOME COMPLETO label: Nome birthdate: type: string description: Data de nascimento example: 01/01/2001 pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ label: Data de Nascimento dateformat: type: string description: Formato da data de nascimento example: dd/MM/yyyy label: Formato da Data phone: type: string description: Número de Telefone com DDD example: TELEFONE COM DDD pattern: ^(?:[0-9]{10,11}|\([0-9]{2}\)[0-9]{4,5}-[0-9]{4})$ label: Telefone phonetype: type: string description: Tipo do número de telefone informado example: TIPO enum: - RESIDENCIAL - COMERCIAL - CELULAR address: type: string description: Logradouro example: LOGRADOURO addressnumber: type: string description: Número do endereço example: NUMERO complement: type: string description: Complemento do endereço, quando houver example: COMPLEMENTO-OPCIONAL city: type: string description: Cidade example: CIDADE uf: type: string description: Unidade da Federação - utilizado junto ao parâmetro city example: SIGLA DO ESTADO label: UF zipcode: type: string description: Código postal (CEP) do endereço informado example: '18000000' pattern: ^(?:[0-9]{8}|[0-9]{5}-[0-9]{3})$ label: CEP email: type: string description: Parâmetro opcional para auxiliar no cálculo do score example: EMAIL-OPCIONAL pattern: ^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}$ label: E-mail referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc - name - birthdate - dateformat - phone - phonetype - address - addressnumber - city - uf - zipcode DatasetPartnerB4bOptinContactPersonInputSchema: type: object properties: doc: type: string description: Documento de identificação pattern: ^([0-9]{11}|[0-9]{3}\.[0-9]{3}\.[0-9]{3}-[0-9]{2})$ label: CPF email: type: string description: Email de contato consultado pattern: ^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}$ label: E-mail phone: type: string description: Telefone de contato consultado pattern: ^(\([0-9]{2}\))?[0-9]{4,5}-[0-9]{4}$ label: Telefone referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetPartnerBlu365PhoneReportDataPersonInputSchema: type: object properties: doc: type: string description: CPF da pessoa (apenas números) pattern: ^([0-9]{11}|[0-9]{3}\.[0-9]{3}\.[0-9]{3}-[0-9]{2})$ label: CPF phone: type: string description: >- Número de telefone utilizado como alternativa ao CPF para consulta direta do status de entrega do SMS example: PHONE pattern: ^(?:[0-9]{10,11}|\([0-9]{2}\)[0-9]{4,5}-[0-9]{4})$ label: Telefone referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetPartnerBlu365PhoneScoreDataPersonInputSchema: type: object properties: doc: type: string description: CPF da pessoa (apenas números) pattern: ^([0-9]{11}|[0-9]{3}\.[0-9]{3}\.[0-9]{3}-[0-9]{2})$ label: CPF referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetPartnerFuellogFuelPricingDataAddressInputSchema: type: object properties: zipcode: type: string description: zipcode pattern: ^[0-9]{5}-[0-9]{3}$ label: CEP householdcode: type: string description: >- Identificador alternativo de localização residencial utilizado para associação geográfica dos preços. buildingcode: type: string description: >- Identificador alternativo de edificação utilizado para associação geográfica dos preços. latitude: type: number description: >- Coordenadas geográficas utilizadas para consulta espacial, devendo ser informadas em conjunto. longitude: type: number description: >- Coordenadas geográficas utilizadas para consulta espacial, devendo ser informadas em conjunto. dateformat: type: string description: >- Formato da data de referência utilizada para consulta histórica de preços. label: Formato da Data radius: type: number description: >- Raio, em quilômetros, utilizado para associação dos preços de combustível à localização consultada. referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - zipcode DatasetPartnerFuellogFuelPricingDataCompanyInputSchema: type: object properties: doc: type: string description: Documento de identificação pattern: >- ^([0-9A-Z]{12}[0-9]{2}|[0-9A-Z]{2}\.[0-9A-Z]{3}\.[0-9A-Z]{3}/[0-9A-Z]{4}-[0-9]{2})$ label: CNPJ referencedate: type: string description: Período a ser consultado pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ label: Data dateformat: type: string description: Formato da data de referência informada label: Formato da Data radius: type: number description: Raio de pesquisa minimum: 0 maximum: 2 limit: type: number description: Limite de resultados label: Limite required: - doc DatasetPartnerFuellogFuelPricingDataPersonInputSchema: type: object properties: doc: type: string description: Documento de identificação pattern: ^([0-9]{11}|[0-9]{3}\.[0-9]{3}\.[0-9]{3}-[0-9]{2})$ label: CPF referencedate: type: string description: Período a ser consultado pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ label: Data dateformat: type: string description: Formato da data de referência informada label: Formato da Data radius: type: number description: Raio de pesquisa minimum: 0 maximum: 2 limit: type: number description: Limite de resultados label: Limite required: - doc DatasetPartnerGeofusionIntraurbanSegmentationCompanyInputSchema: type: object properties: doc: type: string description: CNPJ da empresa pattern: >- ^([0-9A-Z]{12}[0-9]{2}|[0-9A-Z]{2}\.[0-9A-Z]{3}\.[0-9A-Z]{3}/[0-9A-Z]{4}-[0-9]{2})$ label: CNPJ referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetPartnerGeofusionSociodemographicAndEconomicDataCompanyInputSchema: type: object properties: doc: type: string description: CNPJ da empresa pattern: >- ^([0-9A-Z]{12}[0-9]{2}|[0-9A-Z]{2}\.[0-9A-Z]{3}\.[0-9A-Z]{3}/[0-9A-Z]{4}-[0-9]{2})$ label: CNPJ referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetPartnerMurabeiCreditScoreCompanyInputSchema: type: object properties: doc: type: string description: Documento de identificação pattern: >- ^([0-9A-Z]{12}[0-9]{2}|[0-9A-Z]{2}\.[0-9A-Z]{3}\.[0-9A-Z]{3}/[0-9A-Z]{4}-[0-9]{2})$ label: CNPJ referencedate: type: string description: Período a ser consultado pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ label: Data dateformat: type: string description: Formato da data de referência informada label: Formato da Data limit: type: number description: Limite de resultados label: Limite required: - doc DatasetPartnerNetworkDataInputSchema: type: object properties: networkaddress: type: string description: networkaddress referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - networkaddress DatasetPartnerPublicSafetyCompanyInputSchema: type: object properties: doc: type: string description: Documento de identificação pattern: >- ^([0-9A-Z]{12}[0-9]{2}|[0-9A-Z]{2}\.[0-9A-Z]{3}\.[0-9A-Z]{3}/[0-9A-Z]{4}-[0-9]{2})$ label: CNPJ referencedate: type: string description: Período a ser consultado pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ label: Data dateformat: type: string description: Formato da data de referência informada label: Formato da Data radius: type: number description: Raio de pesquisa minimum: 0 maximum: 2 limit: type: number description: Limite de resultados label: Limite required: - doc DatasetPartnerPublicSafetyPersonInputSchema: type: object properties: doc: type: string description: Documento de identificação pattern: ^([0-9]{11}|[0-9]{3}\.[0-9]{3}\.[0-9]{3}-[0-9]{2})$ label: CPF referencedate: type: string description: Período a ser consultado pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ label: Data dateformat: type: string description: Formato da data de referência informada label: Formato da Data radius: type: number description: Raio de pesquisa minimum: 0 maximum: 2 limit: type: number description: Limite de resultados label: Limite required: - doc DatasetPartnerQuantumCustomScoreCompanyInputSchema: type: object properties: doc: type: string description: CNPJ da empresa pattern: >- ^([0-9A-Z]{12}[0-9]{2}|[0-9A-Z]{2}\.[0-9A-Z]{3}\.[0-9A-Z]{3}/[0-9A-Z]{4}-[0-9]{2})$ label: CNPJ referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetPartnerQuantumScorePersonInputSchema: type: object properties: doc: type: string description: Documento de identificação pattern: ^([0-9]{11}|[0-9]{3}\.[0-9]{3}\.[0-9]{3}-[0-9]{2})$ label: CPF referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetPartnerQuodCreditRiskCompanyInputSchema: type: object properties: doc: type: string description: Documento de identificação pattern: >- ^([0-9A-Z]{12}[0-9]{2}|[0-9A-Z]{2}\.[0-9A-Z]{3}\.[0-9A-Z]{3}/[0-9A-Z]{4}-[0-9]{2})$ label: CNPJ referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetPartnerQuodCreditRiskDetailsCompanyInputSchema: type: object properties: doc: type: string description: Documento de identificação pattern: >- ^([0-9A-Z]{12}[0-9]{2}|[0-9A-Z]{2}\.[0-9A-Z]{3}\.[0-9A-Z]{3}/[0-9A-Z]{4}-[0-9]{2})$ label: CNPJ referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetPartnerQuodCreditRiskDetailsPersonInputSchema: type: object properties: doc: type: string description: Documento de identificação pattern: ^([0-9]{11}|[0-9]{3}\.[0-9]{3}\.[0-9]{3}-[0-9]{2})$ label: CPF referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetPartnerQuodCreditRiskPersonInputSchema: type: object properties: doc: type: string description: Documento de identificação pattern: ^([0-9]{11}|[0-9]{3}\.[0-9]{3}\.[0-9]{3}-[0-9]{2})$ label: CPF referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetPartnerQuodCreditScorePersonInputSchema: type: object properties: doc: type: string description: CPF da pessoa (apenas números) pattern: ^([0-9]{11}|[0-9]{3}\.[0-9]{3}\.[0-9]{3}-[0-9]{2})$ label: CPF referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetPartnerRedeVistoriasAddressInputSchema: type: object properties: zipcode: type: string description: zipcode pattern: ^[0-9]{5}-[0-9]{3}$ label: CEP addressnumber: type: string description: addressnumber example: NUMERO city: type: string description: Cidade associada ao endereço consultado. neighborhood: type: string description: Bairro associado ao endereço consultado. addresscore: type: string description: >- Núcleo do endereço utilizado para melhorar a correspondência da pesquisa. floor: type: string description: >- Andar do imóvel, quando aplicável, utilizado para refinar a correspondência do resultado. complement: type: string description: >- Complemento do endereço utilizado para melhorar a precisão da correspondência. referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - zipcode DatasetPartnerScorepositivoCompanyFinanceInputSchema: type: object properties: doc: type: string description: Documento de identificação pattern: >- ^([0-9A-Z]{12}[0-9]{2}|[0-9A-Z]{2}\.[0-9A-Z]{3}\.[0-9A-Z]{3}/[0-9A-Z]{4}-[0-9]{2})$ label: CNPJ referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetPartnerScorepositivoIndividualFinanceInputSchema: type: object properties: doc: type: string description: Documento de identificação pattern: ^([0-9]{11}|[0-9]{3}\.[0-9]{3}\.[0-9]{3}-[0-9]{2})$ label: CPF referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetPartnerUltimateBeneficialOwnersCompanyInputSchema: type: object properties: doc: type: string description: CNPJ da empresa pattern: >- ^([0-9A-Z]{12}[0-9]{2}|[0-9A-Z]{2}\.[0-9A-Z]{3}\.[0-9A-Z]{3}/[0-9A-Z]{4}-[0-9]{2})$ label: CNPJ minimum_percentage: type: string description: >- Define o percentual mínimo de participação societária para que um beneficiário seja considerado beneficiário final no cálculo agregado. referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetPartnerQuodCreditScoreCompanyInputSchema: type: object properties: doc: type: string description: CNPJ da empresa pattern: >- ^([0-9A-Z]{12}[0-9]{2}|[0-9A-Z]{2}\.[0-9A-Z]{3}\.[0-9A-Z]{3}/[0-9A-Z]{4}-[0-9]{2})$ label: CNPJ referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetPassagesInputSchema: type: object properties: doc: type: string description: CPF da pessoa (apenas números) pattern: ^([0-9]{11}|[0-9]{3}\.[0-9]{3}\.[0-9]{3}-[0-9]{2})$ label: CPF minpassagesthreshold: type: string description: >- Estabelece um threshold com o valor passado que determina a quantidade mínima de associações iguais que um documento deve ter para ser contada como passagem nos campos de agregação NumberOfEmails, NumberOfPhones, NumberOfAddresses, NumberOfIpAddresses e NumberOfDevices. referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetPepEstendidaPessoaExpostaPoliticamenteParentescosInputSchema: type: object properties: doc: type: string label: Documento description: Documento a ser consultado. Pode ser enviado com ou sem formatação. required: - doc DatasetPepPessoaExpostaPoliticamenteInputSchema: type: object properties: doc: type: string label: Documento description: Documento a ser consultado. Pode ser enviado com ou sem formatação. required: - doc DatasetPersonAddressesExtendedInputSchema: type: object properties: doc: type: string description: CPF da pessoa (apenas números) pattern: ^([0-9]{11}|[0-9]{3}\.[0-9]{3}\.[0-9]{3}-[0-9]{2})$ label: CPF type: type: string description: Tipo de endereço enum: - work - home isratified: type: string description: Se está ratificado enum: - 'true' - 'false' isactive: type: string description: Se esta ativo enum: - 'true' - 'false' isrecent: type: string description: Se é recente enum: - 'true' - 'false' ismain: type: string description: Se é principal enum: - 'true' - 'false' isindirect: type: string description: Se a associação é indireta enum: - 'true' - 'false' state: type: string description: Sigla do estado zipcode: type: string description: Número do CEP pattern: ^[0-9]{5}-[0-9]{3}$ label: CEP addressnumber: type: string description: >- Número do endereço consultado. Pode ser utilizado em conjunto com zipcode para melhorar a precisão da identificação do imóvel. address: type: string description: >- Endereço consultado (logradouro e complemento, sem número ou CEP). Pode ser utilizado com withmatchrate{true} para comparação com endereços associados ao indivíduo. returnonlydifferentaddresses: type: string description: >- Retorna apenas endereços diferentes dos informados (zipcode e addressnumber), desde que associados ao mesmo titular. enum: - 'true' - 'false' withmatchrate: type: string description: >- Indica se deve ser calculada a similaridade entre o endereço informado (zipcode + addressnumber + address) e os endereços retornados. O resultado é apresentado no campo MatchRate, onde 100 indica correspondência exata. enum: - 'true' - 'false' referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: >- Quantidade máxima de registros retornados. Use o modificador .limit(x) no campo Datasets. label: Limite required: - doc DatasetPersonAwardsAndCertificationsInputSchema: type: object properties: doc: type: string description: CPF da pessoa (apenas números) pattern: ^([0-9]{11}|[0-9]{3}\.[0-9]{3}\.[0-9]{3}-[0-9]{2})$ label: CPF awardname: type: string description: Nome do prêmio awardingorganizationname: type: string description: Nome da organização que concedeu o prêmio certificationname: type: string description: Nome da certificação certifyingentity: type: string description: Nome da entidade certificadora certificationstatus: type: string description: Status da certificação enum: - ACTIVE - INACTIVE referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: >- Quantidade máxima de registros retornados. Use o modificador .limit(x) no campo Datasets. label: Limite required: - doc DatasetPersonBasicDataInputSchema: type: object properties: doc: type: string description: CPF da pessoa (apenas números) pattern: ^([0-9]{11}|[0-9]{3}\.[0-9]{3}\.[0-9]{3}-[0-9]{2})$ label: CPF name: type: string description: Permite comparar o nome informado com o nome encontrado na base label: Nome mothername: type: string description: Permite comparar o nome da mãe informado com o encontrado na base fathername: type: string description: Permite comparar o nome do pai informado com o encontrado na base referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetPersonCguNegativeCertificateInputSchema: type: object properties: doc: type: string description: CPF da pessoa (apenas números) pattern: ^([0-9]{11}|[0-9]{3}\.[0-9]{3}\.[0-9]{3}-[0-9]{2})$ label: CPF referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetPersonCnjNegativeCertificateInputSchema: type: object properties: doc: type: string description: CPF da pessoa (apenas números) pattern: ^([0-9]{11}|[0-9]{3}\.[0-9]{3}\.[0-9]{3}-[0-9]{2})$ label: CPF referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetPersonDomainsExtendedInputSchema: type: object properties: doc: type: string description: CPF da pessoa (apenas números) pattern: ^([0-9]{11}|[0-9]{3}\.[0-9]{3}\.[0-9]{3}-[0-9]{2})$ label: CPF hasssl: type: string description: Indica se o site utiliza SSL enum: - 'true' - 'false' isactive: type: string description: Indica se o site está ativo enum: - 'true' - 'false' socialnetworks: type: string description: Redes sociais associadas ao site ispname: type: string description: Provedor de hospedagem paymentmethods: type: string description: Métodos de pagamento identificados paymentservices: type: string description: Serviços de pagamento utilizados framework: type: string description: Framework ou plataforma utilizada no site visitorrange: type: string description: Faixa estimada de visitantes mensais domainclass: type: string description: Classe do domínio enum: - PORTAL - BLOG - ECOMMERCE - CORPORATE - GOVERNMENT - NEWS - EDUCATIONAL isRegisteredInWhoIsData: type: string description: Indica se o site está registrado em nome da entidade enum: - 'true' - 'false' referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: >- Quantidade máxima de registros retornados. Use o modificador .limit(x) no campo Datasets. label: Limite required: - doc DatasetPersonElectoralDonorsInputSchema: type: object properties: doc: type: string description: CPF da pessoa (apenas números) pattern: ^([0-9]{11}|[0-9]{3}\.[0-9]{3}\.[0-9]{3}-[0-9]{2})$ label: CPF referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetPersonEmbargoedIbamaInputSchema: type: object properties: doc: type: string description: CPF da pessoa (apenas números) pattern: ^([0-9]{11}|[0-9]{3}\.[0-9]{3}\.[0-9]{3}-[0-9]{2})$ label: CPF referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetPersonGovernmentDebtorsInputSchema: type: object properties: doc: type: string description: CPF da pessoa (apenas números) pattern: ^([0-9]{11}|[0-9]{3}\.[0-9]{3}\.[0-9]{3}-[0-9]{2})$ label: CPF referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetPersonIndustrialPropertyInputSchema: type: object properties: doc: type: string description: CPF da pessoa (apenas números) pattern: ^([0-9]{11}|[0-9]{3}\.[0-9]{3}\.[0-9]{3}-[0-9]{2})$ label: CPF type: type: string description: Define o tipo de ativo consultado (marcas ou patentes) referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetPersonKycInputSchema: type: object properties: doc: type: string description: CPF da pessoa (apenas números) pattern: ^([0-9]{11}|[0-9]{3}\.[0-9]{3}\.[0-9]{3}-[0-9]{2})$ label: CPF pep_level: type: string description: Nível de Pessoa Politicamente Exposta (PEP) pep_job: type: string description: Cargo público que a pessoa ocupa pep_motive: type: string description: Motivo pelo qual a pessoa foi classificada como PEP sanctions_source: type: string description: Fonte da sanção enum: - interpol - fbi - ofac - uk - eu - unsc - CEAF - CNEP - MTE - United Nations Security Council - Conselho Nacional de Justiça - Tribunal de Contas da União - Bank Hindered Suppliers - Ibama - Tribunal de Contas do Estado de São Paulo - Banco Central do Brasil - Comissao de Valores Mobiliarios - seape-df - ca-sanctions - DDTC sanctions_type: type: string description: Tipo da sanção type: type: string description: Alias de sanction_type standardized_sanction_type: type: string description: Tipo padronizado da sanção enum: - arrest warrants - financial crimes - terrorism - financial infractions - environmental infractions - corruption - slavery crimes standardized_type: type: string description: Alias de standardizedsanctiontype enum: - arrest warrants - financial crimes - terrorism - financial infractions - environmental infractions - corruption - slavery crimes minmatch: type: number minimum: 0 maximum: 100 description: >- Percentual mínimo de similaridade entre o nome da entidade consultada e o nome presente no registro de sanção a partir do qual o registro será considerado para determinar indicadores como IsCurrentlySanctioned, WasPreviouslySanctioned e contagens por período. Esta chave não restringe os registros retornados pelo dataset. considerexpandedpep: type: string description: >- Indica se devem ser considerados como PEP indivíduos que exercem cargos como político suplente, promotor, defensor público ou juiz da esfera estadual. name: type: string description: >- Permite realizar a consulta a partir do nome da entidade quando o documento não é informado, sendo especialmente útil em análises envolvendo pessoas estrangeiras. label: Nome referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetPersonLawsuitsDistributionDataInputSchema: type: object properties: doc: type: string description: CPF da pessoa (apenas números) pattern: ^([0-9]{11}|[0-9]{3}\.[0-9]{3}\.[0-9]{3}-[0-9]{2})$ label: CPF capturedate: type: string description: Data de captura do processo pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ label: Data closedate: type: string description: Data de fechamento do processo pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ label: Data cnjsubject: type: string description: Número ou nome do assunto do processo no CNJ cnjproceduretype: type: string description: Número ou nome do tipo do processo no CNJ courtlevel: type: string description: Nível do tribunal enum: - '1' - '2' - '3' x-fern-enum: '1': name: Value1 '2': name: Value2 '3': name: Value3 courtname: type: string description: Nome do tribunal courttype: type: string description: Tipo do tribunal partypolarity: type: string description: Polaridade da parte no processo enum: - ACTIVE - PASSIVE - NEUTRAL partytype: type: string description: Tipo de participação da entidade no processo noticedate: type: string description: Data de notificação do processo pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ label: Data state: type: string description: Estado de tramitação do processo status: type: string description: Status do processo resjudicatadate: type: string description: Data de trânsito em julgado pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ label: Data value: type: string description: Valor discutido no processo alternativedistributionparameter: type: string description: >- Define um campo alternativo para geração de agregações adicionais no retorno do dataset enum: - PartyType referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetPersonLicensesAndAuthorizationsInputSchema: type: object properties: doc: type: string description: CPF da pessoa (apenas números) pattern: ^([0-9]{11}|[0-9]{3}\.[0-9]{3}\.[0-9]{3}-[0-9]{2})$ label: CPF licensetype: type: string description: Tipo da licença ou autorização enum: - ANTT - CADASTUR referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetPersonMediaProfileAndExposureInputSchema: type: object properties: doc: type: string description: CPF da pessoa (apenas números) pattern: ^([0-9]{11}|[0-9]{3}\.[0-9]{3}\.[0-9]{3}-[0-9]{2})$ label: CPF title: type: string description: Título da notícia sourcename: type: string description: Nome da fonte responsável pela notícia categories: type: string description: Categoria da notícia label: type: string description: Classificação de sentimento atribuída à notícia enum: - NEGATIVE - POSITIVE - NEUTRAL - UNDEFINED - POLARIZED - SLIGHTLYPOSITIVE - SLIGHTLYNEGATIVE keywords: type: string description: >- Permite restringir os conteúdos retornados com base em palavras-chave específicas, separadas por vírgula. keywords_operator: type: string description: Define a lógica de combinação entre as palavras-chave informadas enum: - OR - AND referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: >- Quantidade máxima de registros retornados. Use o modificador .limit(x) no campo Datasets. label: Limite next: type: string description: >- Identificador da próxima página. Use o valor retornado em NextPageId com o modificador .next(x) no campo Datasets. label: Próxima página required: - doc DatasetPersonOndemandCertLaborDebtAbsencePersonInputSchema: type: object properties: doc: type: string description: CPF da pessoa (apenas números) pattern: ^([0-9]{11}|[0-9]{3}\.[0-9]{3}\.[0-9]{3}-[0-9]{2})$ label: CPF referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetPersonOndemandIbamaCertNegativaPersonInputSchema: type: object properties: doc: type: string description: CPF da pessoa (apenas números) pattern: ^([0-9]{11}|[0-9]{3}\.[0-9]{3}\.[0-9]{3}-[0-9]{2})$ label: CPF name: type: string description: Nome completo da pessoa consultada label: Nome addresscore: type: string description: Logradouro do endereço residencial neighborhood: type: string description: Bairro do endereço residencial city: type: string description: Cidade do endereço residencial uf: type: string description: Unidade federativa do endereço residencial label: UF referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetPersonOndemandIrtCertificatePersonInputSchema: type: object properties: doc: type: string description: CPF da pessoa (apenas números) pattern: ^([0-9]{11}|[0-9]{3}\.[0-9]{3}\.[0-9]{3}-[0-9]{2})$ label: CPF nirf: type: string description: >- Número do Imóvel na Receita Federal, utilizado para identificar o imóvel rural vinculado à certidão. Obrigatória neste dataset. example: NIRF referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc - nirf DatasetPersonOndemandRegularityCertificateIbamaPersonInputSchema: type: object properties: doc: type: string description: CPF da pessoa (apenas números) pattern: ^([0-9]{11}|[0-9]{3}\.[0-9]{3}\.[0-9]{3}-[0-9]{2})$ label: CPF referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetPersonOndemandSintegraPersonV2InputSchema: type: object properties: doc: type: string description: CPF da pessoa (apenas números) pattern: ^([0-9]{11}|[0-9]{3}\.[0-9]{3}\.[0-9]{3}-[0-9]{2})$ label: CPF uf: type: string description: >- Unidade Federativa utilizada como base para a consulta ao SINTEGRA. Obrigatória neste dataset*. enum: - AC - BA - DF - GO - MA - MT - PA - PB - PR - RJ - RN - RO - SC - SE - TO label: UF fillmotheraddress: type: string description: >- Indica se o UF pode ser inferido a partir do endereço associado à mãe quando não houver endereço direto disponível enum: - 'true' - 'false' fillworkaddress: type: string description: >- Indica se o UF pode ser inferido a partir do endereço associado ao trabalho quando não houver endereço direto disponível enum: - 'true' - 'false' referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc - uf DatasetPersonPartnerQuantumCustomScorePersonInputSchema: type: object properties: doc: type: string description: CPF da pessoa (apenas números) pattern: ^([0-9]{11}|[0-9]{3}\.[0-9]{3}\.[0-9]{3}-[0-9]{2})$ label: CPF referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetPersonPgfnInputSchema: type: object properties: doc: type: string description: CPF da pessoa (apenas números) pattern: ^([0-9]{11}|[0-9]{3}\.[0-9]{3}\.[0-9]{3}-[0-9]{2})$ label: CPF type: type: string description: >- Tipo da consulta PGFN, onde list tem como fonte a Lista de Devedores e status a Receita Federal. Para obtenção do certificado em PDF, utilizar status. enum: - list - status referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetPersonPhonesExtendedInputSchema: type: object properties: doc: type: string description: CPF da pessoa (apenas números) pattern: ^([0-9]{11}|[0-9]{3}\.[0-9]{3}\.[0-9]{3}-[0-9]{2})$ label: CPF type: type: string description: Tipo do telefone enum: - mobile - work - home isactive: type: string description: Indica se o telefone está ativo enum: - 'true' - 'false' isrecent: type: string description: Indica se o telefone é recente enum: - 'true' - 'false' ismain: type: string description: Indica se o telefone é principal enum: - 'true' - 'false' isindonotcalllist: type: string description: Indica se o telefone consta em listas de bloqueio enum: - 'true' - 'false' areacode: type: string description: Código de área do telefone phone: type: string description: >- Telefone adicional utilizado para enriquecer ou refinar a consulta, independentemente da associação direta com o documento informado pattern: ^(\([0-9]{2}\))?[0-9]{4,5}-[0-9]{4}$ label: Telefone returnonlydifferentphones: type: string description: Retorna apenas telefones diferentes dos informados na consulta enum: - 'true' - 'false' withmatchrate: type: string description: >- Calcula o nível de similaridade entre o telefone informado e os telefones retornados enum: - 'true' - 'false' referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: >- Quantidade máxima de registros retornados. Use o modificador .limit(x) no campo Datasets. label: Limite required: - doc DatasetPersonProcessesInputSchema: type: object properties: doc: type: string description: CPF da pessoa (apenas números) pattern: ^([0-9]{11}|[0-9]{3}\.[0-9]{3}\.[0-9]{3}-[0-9]{2})$ label: CPF capturedate: type: string description: Data de captura do processo pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ label: Data closedate: type: string description: Data de finalização, baixa ou arquivamento do processo pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ label: Data cnjsubject: type: string description: >- Número ou nome do assunto do processo no CNJ, conforme tabela oficial disponível no site do CNJ cnjproceduretype: type: string description: Número ou nome do tipo do processo no CNJ courtlevel: type: string description: Instância do processo enum: - '1' - '2' - '3' x-fern-enum: '1': name: Value1 '2': name: Value2 '3': name: Value3 courtname: type: string description: Nome do tribunal courttype: type: string description: Tipo de vara ou competência do processo enum: - CIVEL - CRIMINAL - TRIBUTARIA - PREVIDENCIARIA - TRABALHISTA - ESPECIAL CIVEL - ESPECIAL CRIMINAL - ADMINISTRATIVA - ELEITORAL - FAZENDA - ESPECIAL FAZENDA partypolarity: type: string description: Polaridade da parte no processo enum: - ACTIVE - PASSIVE - NEUTRAL partytype: type: string description: Tipo da parte no processo enum: - AUTHOR - DEFENDANT - CLAIMANT - CLAIMED - LAWYER - REPORTER - ATTORNEY - WITNESS - VICTIM - JUDGE - INMATE - OTHER noticedate: type: string description: Data de abertura ou distribuição do processo pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ label: Data state: type: string description: Estado de tramitação do processo (UF) status: type: string description: Status do processo enum: - ATIVO - DISTRIBUIDO - BAIXADO - APENSO - DECIDIDO - AUTUADO - EXECUCAO - FINALIZADO - ENCERRADO - EM GRAU DE RECURSO - REDISTRIBUIDO - TRANSITADO EM JULGADO - ARQUIVADO - JULGADO - INDEFINIDO - SUSPENSO resjudicatadate: type: string description: Data de trânsito em julgado pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ label: Data value: type: string description: Valor disputado no processo returnupdates: type: string description: >- Define se as movimentações dos processos devem ser retornadas, impactando diretamente o volume e a performance da resposta enum: - 'true' - 'false' applyFiltersToStats: type: string description: >- Indica se as estatísticas agregadas (contagens) devem considerar os filtros aplicados na consulta enum: - 'true' - 'false' returncvmprocesses: type: string description: >- Define se processos administrativos da CVM devem ser incluídos no retorno, quando existentes enum: - 'true' - 'false' updateslimit: type: integer description: >- Limita a quantidade de movimentações retornadas por processo, priorizadas pela recência minimum: 0 extendednamematch: type: string description: >- Expande a associação de processos para incluir, além do documento, correspondências por nome completo que não possuam nenhum documento associado. Quando habilitado, o retorno inclui o campo NumberOfFullNameNamesakes, que indica a quantidade de nomes completos coincidentes com o da entidade do documento consultado enum: - 'true' - 'false' referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: >- Quantidade máxima de registros retornados. Use o modificador .limit(x) no campo Datasets. label: Limite next: type: string description: >- Identificador da próxima página. Use o valor retornado em NextPageId com o modificador .next(x) no campo Datasets. label: Próxima página required: - doc DatasetPersonRegistrationDataInputSchema: type: object properties: doc: type: string description: CPF da pessoa (apenas números) pattern: ^([0-9]{11}|[0-9]{3}\.[0-9]{3}\.[0-9]{3}-[0-9]{2})$ label: CPF referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetPersonRelatedPeoplePhonesInputSchema: type: object properties: doc: type: string description: Documento de identificação pattern: ^([0-9]{11}|[0-9]{3}\.[0-9]{3}\.[0-9]{3}-[0-9]{2})$ label: CPF birthdate: type: string description: Data de Nascimento pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ label: Data de Nascimento dateformat: type: string description: Formato da Data enum: - yyyy-MM-dd - dd/MM/yyyy label: Formato da Data relationshiptype: type: string description: >- Este dataset suporta um parâmetro opcional, chamado relationshiptype, que permite só recuperar contatos de pessoas que tenham o tipo de relacionamento especificado. type: type: string description: Tipo de telefone enum: - mobile - work - home isactive: type: string description: Se o telefone está ativo enum: - 'true' - 'false' isrecent: type: string description: Se o telefone é recente enum: - 'true' - 'false' ismain: type: string description: Se o telefone é principal enum: - 'true' - 'false' isindonotcalllist: type: string description: Se o telefone está na lista do PROCON enum: - 'true' - 'false' areacode: type: string description: Código de area referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: >- Quantidade máxima de registros retornados. Use o modificador .limit(x) no campo Datasets. label: Limite required: - doc DatasetPersonUnifiedModelingDataX10InputSchema: type: object properties: doc: type: string description: CPF da pessoa (apenas números) pattern: ^([0-9]{11}|[0-9]{3}\.[0-9]{3}\.[0-9]{3}-[0-9]{2})$ label: CPF referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetPersonUnifiedModelingDataX15InputSchema: type: object properties: doc: type: string description: CPF da pessoa (apenas números) pattern: ^([0-9]{11}|[0-9]{3}\.[0-9]{3}\.[0-9]{3}-[0-9]{2})$ label: CPF referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetPetiProgramaDeErradicacaoDoTrabalhoInfantilInputSchema: type: object properties: nis: type: string description: O parâmetro NIS pode ser enviado com ou sem formatação. label: NIS doc: type: string label: Documento description: Documento a ser consultado. Pode ser enviado com ou sem formatação. required: - nis - doc DatasetPgfnListaDeDevedoresDaUniaoConsultaDeDebitosEDividaAtivaInputSchema: type: object properties: doc: type: string label: Documento description: Documento a ser consultado. Pode ser enviado com ou sem formatação. required: - doc DatasetPhonesExtendedInputSchema: type: object properties: doc: type: string description: CNPJ da empresa pattern: >- ^([0-9A-Z]{12}[0-9]{2}|[0-9A-Z]{2}\.[0-9A-Z]{3}\.[0-9A-Z]{3}/[0-9A-Z]{4}-[0-9]{2})$ label: CNPJ type: type: string description: Tipo de endereço enum: - work - home isratified: type: string description: Indica se o endereço está ratificado enum: - 'true' - 'false' isactive: type: string description: Indica se o endereço está ativo enum: - 'true' - 'false' isrecent: type: string description: Indica se o endereço é recente enum: - 'true' - 'false' ismain: type: string description: Indica se o endereço é principal enum: - 'true' - 'false' state: type: string description: Sigla do estado zipcode: type: string description: CEP do endereço pattern: ^[0-9]{5}-[0-9]{3}$ label: CEP addressnumber: type: string description: >- Utilizado em conjunto com o CEP para auxiliar na construção do BuildCode e aumentar a qualidade do resultado useRawRFData: type: string description: >- Instrui o sistema a retornar o endereço exatamente como capturado na Receita Federal, sem correções ou padronizações enum: - 'true' - 'false' referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: >- Quantidade máxima de registros retornados. Use o modificador .limit(x) no campo Datasets. label: Limite next: type: string description: >- Identificador da próxima página. Use o valor retornado em NextPageId com o modificador .next(x) no campo Datasets. label: Próxima página required: - doc DatasetPoliciaCivilAntecedentesCriminaisInputSchema: type: object properties: datanascimento: type: string description: >- O parâmetro DATANASCIMENTO deve ser fornecido, com ou sem formatação. label: DATANASCIMENTO nomemae: type: string description: O parâmetro NOMEMAE pode ser enviado com qualquer outro. label: NOMEMAE nome: type: string description: O parâmetro NOME pode ser enviado com qualquer outro. label: NOME uf: type: string description: >- O(s) parâmetro(s) UF é(são) obrigatório(s) para esta consulta (CE,MG,MT,RS). label: UF rg: type: string description: O parâmetro RG pode ser enviado com ou sem formatação. label: RG doc: type: string label: Documento description: Documento a ser consultado. Pode ser enviado com ou sem formatação. required: - datanascimento - nomemae - nome - uf - rg DatasetPoliciaRodoviariaFederalInfracoesInputSchema: type: object properties: renavam: type: string description: >- O parâmetro RENAVAM deve ser informado juntamente com seus 11 dígitos numéricos. label: RENAVAM placa: type: string description: O parâmetro PLACA pode ser enviado com ou sem formatação. label: PLACA required: [] DatasetPoliticalInvolvementInputSchema: type: object properties: doc: type: string description: CPF da pessoa (apenas números) pattern: ^([0-9]{11}|[0-9]{3}\.[0-9]{3}\.[0-9]{3}-[0-9]{2})$ label: CPF referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetPoliticalRelationshipsInputSchema: type: object properties: doc: type: string description: Documento de identificação pattern: ^([0-9]{11}|[0-9]{3}\.[0-9]{3}\.[0-9]{3}-[0-9]{2})$ label: CPF onlyactivepoliticians: type: string description: >- Se usado o valor true, serão retornados apenas relacionamentos com políticos que ainda estão no cargo. (Padrão: false) enum: - 'true' - 'false' birthdate: type: string description: Data de Nascimento pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ label: Data de Nascimento dateformat: type: string description: Formato da Data enum: - yyyy-MM-dd - dd/MM/yyyy label: Formato da Data relationshiptype: type: string description: Tipo do relacionamento enum: - BROTHER - COUSIN - COWORKER - FATHER - GRANDPARENT - GRANDSON - HOUSEHOLD - LAWSUITSAUTHOR - LAWSUITSDEFENDANT - MOTHER - NEPHEW - NEIGHBOR - PARTNER - RELATIVE - RELATED - SON - SPOUSE - UNCLE creationdate: type: string description: >- Retorna apenas os relacionamentos cuja data de criação seja a partir da data especificada. pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ label: Data lastupdatedate: type: string description: >- Retorna apenas os relacionamentos cuja data de última atualização seja maior que a data especificada. pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ label: Data referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetPriceDataInputSchema: type: object properties: ean: type: string description: Número do código de barras label: Código de Barras (EAN) isbn: type: string description: International Standard Book Number brand: type: string description: Marca dos produtos category: type: string description: Categoria de produtos searchterms: type: string description: Pesquisa de palavras-chaves referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - ean DatasetProcessMovementsInputSchema: type: object required: - numero_cnj properties: numero_cnj: type: string label: Numero CNJ description: Numero CNJ do processo. DatasetProcessosJudiciaisAgrupadaBaseInputSchema: type: object properties: doc: type: string label: Documento description: Documento a ser consultado. Pode ser enviado com ou sem formatação. required: - doc DatasetProcessosJudiciaisCivelCriminalETrabalhistaNacionalCompletaInputSchema: type: object properties: doc: type: string label: Documento description: Documento a ser consultado. Pode ser enviado com ou sem formatação. required: - doc DatasetProcessosJudiciaisCivelCriminalETrabalhistaNacionalResumidaInputSchema: type: object properties: doc: type: string label: Documento description: Documento a ser consultado. Pode ser enviado com ou sem formatação. required: - doc DatasetProductBasicDataInputSchema: type: object properties: ean: type: string description: Número do código de barras label: Código de Barras (EAN) isbn: type: string description: International Standard Book Number brand: type: string description: Marca dos produtos category: type: string description: Categoria de produtos searchterms: type: string description: Pesquisa de palavras-chaves referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - ean DatasetProfessionDataInputSchema: type: object properties: doc: type: string description: CPF da pessoa (apenas números) pattern: ^([0-9]{11}|[0-9]{3}\.[0-9]{3}\.[0-9]{3}-[0-9]{2})$ label: CPF sector: type: string description: Setor do vínculo profissional enum: - PUBLIC companyname: type: string description: Nome do órgão ou entidade pública area: type: string description: Área de atuação do cargo level: type: string description: Cargo ou função exercida status: type: string description: Situação do vínculo enum: - ACTIVE - INACTIVE referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetProfessionalTurnoverInputSchema: type: object properties: doc: type: string description: CPF da pessoa (apenas números) pattern: ^([0-9]{11}|[0-9]{3}\.[0-9]{3}\.[0-9]{3}-[0-9]{2})$ label: CPF referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetPropertyBasicDataInputSchema: type: object properties: zipcode: type: string description: Código postal a consultar pattern: ^[0-9]{5}-[0-9]{3}$ label: CEP householdcode: type: string description: Código postal buildingcode: type: string description: Código postal addressnumber: type: string description: Número de porta do endereço referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - zipcode DatasetProtestosNacionalIeptbOnlineInputSchema: type: object properties: doc: type: string label: Documento description: Documento a ser consultado. Pode ser enviado com ou sem formatação. required: - doc DatasetProtestosSpConsultaDeProtestosNosCartoriosDeSaoPauloInputSchema: type: object properties: doc: type: string label: Documento description: Documento a ser consultado. Pode ser enviado com ou sem formatação. required: - doc DatasetQsaBetDataInputSchema: type: object properties: doc: type: string description: Documento de identificação pattern: ^([0-9]{11}|[0-9]{3}\.[0-9]{3}\.[0-9]{3}-[0-9]{2})$ label: CPF birthdate: type: string description: Data de Nascimento pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ label: Data de Nascimento dateformat: type: string description: Formato da Data enum: - yyyy-MM-dd - dd/MM/yyyy label: Formato da Data referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetQuodInputSchema: type: object properties: doc: type: string description: >- CPF ou CNPJ a ser consultado. Pode ser enviado com ou sem formatação. label: CPF/CNPJ pattern: >- ^([0-9]{11}|[0-9]{3}\.[0-9]{3}\.[0-9]{3}-[0-9]{2}|[0-9A-Z]{12}[0-9]{2}|[0-9A-Z]{2}\.[0-9A-Z]{3}\.[0-9A-Z]{3}/[0-9A-Z]{4}-[0-9]{2})$ required: - doc DatasetReceitaFederalPessoaFisicaConsultaCpfESituacaoCadastralInputSchema: type: object properties: datanascimento: type: string description: >- O parâmetro DATANASCIMENTO deve ser fornecido, com ou sem formatação. label: DATANASCIMENTO doc: type: string label: Documento description: Documento a ser consultado. Pode ser enviado com ou sem formatação. required: - doc DatasetReceitaFederalPessoaJuridicaConsultaCnpjESituacaoCadastralInputSchema: type: object properties: qsa: type: string description: >- O parâmetro QSA é utilizado para obter o Quadro de Sócios e Administradores (Desabilitar, Habilitar). label: QSA doc: type: string label: Documento description: Documento a ser consultado. Pode ser enviado com ou sem formatação. required: - doc DatasetReceitaFederalPessoaJuridicaQsaParticipacaoSocietariaInputSchema: type: object properties: doc: type: string label: Documento description: Documento a ser consultado. Pode ser enviado com ou sem formatação. required: - doc DatasetRegistrationDataArgentinaInputSchema: type: object properties: dni: type: string description: >- O parâmetro DNI pode ser enviado com ou sem formatação. Este parâmetro é obrigatório. label: DNI required: - dni DatasetRegistrationDataBrazilConsultaDeDadosCadastraisEEmpresariaisInputSchema: type: object properties: dob{3}: type: string description: '' label: DOB{3} surname: type: string description: '' label: SURNAME name: type: string description: '' label: NAME doc: type: string label: Documento description: Documento a ser consultado. Pode ser enviado com ou sem formatação. required: - doc DatasetRegistrationDataMexicoConsultaDeDadosCadastraisEEmpresariaisInputSchema: type: object properties: curp: type: string description: O parâmetro CURP pode ser enviado com ou sem formatação. label: CURP required: - curp DatasetRegistrationDataInputSchema: type: object properties: doc: type: string description: CNPJ da empresa pattern: >- ^([0-9A-Z]{12}[0-9]{2}|[0-9A-Z]{2}\.[0-9A-Z]{3}\.[0-9A-Z]{3}/[0-9A-Z]{4}-[0-9]{2})$ label: CNPJ referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetRegistroNacionalDePoblacionCurpMexicoInputSchema: type: object properties: curp: type: string description: O parâmetro CURP pode ser enviado com ou sem formatação. label: CURP required: - curp DatasetRelatedPeopleAddressesInputSchema: type: object properties: doc: type: string description: Documento de identificação pattern: ^([0-9]{11}|[0-9]{3}\.[0-9]{3}\.[0-9]{3}-[0-9]{2})$ label: CPF birthdate: type: string description: Data de Nascimento pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ label: Data de Nascimento dateformat: type: string description: Formato da Data enum: - yyyy-MM-dd - dd/MM/yyyy label: Formato da Data relationshiptype: type: string description: Tipo de relacionamento enum: - coworker - neighbor - brother - nephew - mother - son - household - grandson - spouse - relative - grandparent - uncle - cousin - father - partner - related type: type: string description: Tipo de endereço enum: - work - home isratified: type: string description: Se está ratificado enum: - 'true' - 'false' isactive: type: string description: Se está ativo enum: - 'true' - 'false' isrecent: type: string description: Se é recente enum: - 'true' - 'false' ismain: type: string description: Se é principal enum: - 'true' - 'false' state: type: string description: Sigla do estado zipcode: type: string description: Número do CEP pattern: ^[0-9]{5}-[0-9]{3}$ label: CEP referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: >- Quantidade máxima de registros retornados. Use o modificador .limit(x) no campo Datasets. label: Limite required: - doc DatasetRelatedPeopleEmailsInputSchema: type: object properties: doc: type: string description: CPF da pessoa (apenas números) pattern: ^([0-9]{11}|[0-9]{3}\.[0-9]{3}\.[0-9]{3}-[0-9]{2})$ label: CPF relationshiptype: type: string description: Tipo de relacionamento enum: - coworker - neighbor - brother - nephew - mother - son - household - grandson - spouse - relative - grandparent - uncle - cousin - father - partner - related type: type: string description: Tipo de e-mail enum: - corporate - personal isactive: type: string description: Se o email está ativo enum: - 'true' - 'false' isrecent: type: string description: Se o email é recente enum: - 'true' - 'false' ismain: type: string description: Se o email é principal enum: - 'true' - 'false' validationstatus: type: string description: Status de validação enum: - VALID - ACCEPTALL - UNKNOWN - POSSIBLESPAM_TRAP - INVALID - HARDBOUNCE - RISKY - ACCEPT domain: type: string description: Domínio do email referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: >- Quantidade máxima de registros retornados. Use o modificador .limit(x) no campo Datasets. label: Limite required: - doc DatasetRelatedPeoplePhonesInputSchema: type: object properties: doc: type: string description: Documento de identificação pattern: >- ^([0-9A-Z]{12}[0-9]{2}|[0-9A-Z]{2}\.[0-9A-Z]{3}\.[0-9A-Z]{3}/[0-9A-Z]{4}-[0-9]{2})$ label: CNPJ relationshiptype: type: string description: >- Permite recuperar somente os contatos de pessoas que tenham o tipo de relacionamento especificado enum: - QSA - Ownership - Employee - RepresentanteLegal type: type: string description: Tipo do telefone enum: - mobile - work - home isactive: type: string description: Se o telefone esta ativo enum: - 'true' - 'false' isrecent: type: string description: Se o telefone recente enum: - 'true' - 'false' ismain: type: string description: Se o telefone principal enum: - 'true' - 'false' isindonotcalllist: type: string description: Se o telefone está na lista do PROCON enum: - 'true' - 'false' areacode: type: string description: Código de area referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: >- Quantidade máxima de registros retornados. Use o modificador .limit(x) no campo Datasets. label: Limite required: - doc DatasetRelatedPeopleInputSchema: type: object properties: doc: type: string description: Documento de identificação pattern: ^([0-9]{11}|[0-9]{3}\.[0-9]{3}\.[0-9]{3}-[0-9]{2})$ label: CPF birthdate: type: string description: Data de Nascimento pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ label: Data de Nascimento dateformat: type: string description: Formato da Data enum: - yyyy-MM-dd - dd/MM/yyyy label: Formato da Data relatedentitytaxidtype: type: string description: Tipo do documento relacionado enum: - CPF - CNPJ relationshiplevel: type: string description: Nível do relacionamento relationshiptype: type: string description: Tipo do relacionamento enum: - coworker - neighbor - brother - nephew - mother - son - household - grandson - spouse - relative - grandparent - uncle - cousin - father - partner - related - collegeclass referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: >- Quantidade máxima de registros retornados. Use o modificador .limit(x) no campo Datasets. label: Limite next: type: string description: >- Identificador da próxima página. Use o valor retornado em NextPageId com o modificador .next(x) no campo Datasets. label: Próxima página required: - doc DatasetRelatedProductDataInputSchema: type: object properties: ean: type: string description: ean label: Código de Barras (EAN) isbn: type: string description: International Standard Book Number brand: type: string description: Marca do produto category: type: string description: Categoria do produto searchterms: type: string description: Termos de busca por palavras-chave referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite next: type: string description: >- Identificador da próxima página. Use o valor retornado em NextPageId com o modificador .next(x) no campo Datasets. label: Próxima página required: - ean DatasetRelationshipGraphInputSchema: type: object required: - doc properties: doc: type: string label: Documento description: CNPJ ou chave PF no formato "NOME|CPF_PARCIAL" expanded: type: array items: type: string default: [] description: IDs de nodes já conhecidos (filtrados do resultado). DatasetRelationshipsInputSchema: type: object properties: doc: type: string description: CNPJ da empresa pattern: >- ^([0-9A-Z]{12}[0-9]{2}|[0-9A-Z]{2}\.[0-9A-Z]{3}\.[0-9A-Z]{3}/[0-9A-Z]{4}-[0-9]{2})$ label: CNPJ relatedentitytaxidtype: type: string description: Tipo do documento da entidade relacionada enum: - CPF - CNPJ relationshiplevel: type: string description: Nível do relacionamento enum: - Direto - Indireto relationshiptype: type: string description: Tipo do relacionamento enum: - QSA - Ownership - Employee - RepresentanteLegal useHeadQuartersData: type: string description: >- Define se os relacionamentos devem ser construídos a partir dos dados da matriz da empresa consultada enum: - 'true' - 'false' referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: >- Quantidade máxima de registros retornados. Use o modificador .limit(x) no campo Datasets. label: Limite next: type: string description: >- Identificador da próxima página. Use o valor retornado em NextPageId com o modificador .next(x) no campo Datasets. label: Próxima página required: - doc DatasetReputationsAndReviewsInputSchema: type: object properties: doc: type: string description: CNPJ da empresa pattern: >- ^([0-9A-Z]{12}[0-9]{2}|[0-9A-Z]{2}\.[0-9A-Z]{3}\.[0-9A-Z]{3}/[0-9A-Z]{4}-[0-9]{2})$ label: CNPJ referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetRestituicaoImpostoDeRendaIrpfInputSchema: type: object properties: anoexercicio: type: string description: '' label: ANOEXERCICIO datanascimento: type: string description: >- O parâmetro DATANASCIMENTO deve ser fornecido, com ou sem formatação. label: DATANASCIMENTO doc: type: string label: Documento description: Documento a ser consultado. Pode ser enviado com ou sem formatação. required: - doc DatasetReviewDataInputSchema: type: object properties: ean: type: string description: ean label: Código de Barras (EAN) isbn: type: string description: International Standard Book Number brand: type: string description: Marca do produto category: type: string description: Categoria do produto searchterms: type: string description: Termos de busca por palavras-chave referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite next: type: string description: >- Identificador da próxima página. Use o valor retornado em NextPageId com o modificador .next(x) no campo Datasets. label: Próxima página required: - ean DatasetScoreDeCreditoQuodInputSchema: type: object properties: doc: type: string label: Documento description: Documento a ser consultado. Pode ser enviado com ou sem formatação. required: - doc DatasetScrAnaliticoResumoBacenInputSchema: type: object properties: doc: type: string label: Documento description: Documento a ser consultado. Pode ser enviado com ou sem formatação. required: - doc DatasetScrDetalhadaResumoBacenInputSchema: type: object properties: doc: type: string label: Documento description: Documento a ser consultado. Pode ser enviado com ou sem formatação. required: - doc DatasetScrInputSchema: type: object required: - doc properties: doc: type: string label: CPF/CNPJ pattern: >- ^[0-9]{11}$|^[0-9A-Z]{12}[0-9]{2}$|^([0-9]{11}|[0-9]{3}\.[0-9]{3}\.[0-9]{3}-[0-9]{2})$|^([0-9A-Z]{12}[0-9]{2}|[0-9A-Z]{2}\.[0-9A-Z]{3}\.[0-9A-Z]{3}/[0-9A-Z]{4}-[0-9]{2})$ description: CPF ou CNPJ (com ou sem formatação) DatasetSecurityDataInputSchema: type: object properties: doc: type: string description: Documento de identificação pattern: ^([0-9]{11}|[0-9]{3}\.[0-9]{3}\.[0-9]{3}-[0-9]{2})$ label: CPF birthdate: type: string description: Data de Nascimento pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ label: Data de Nascimento dateformat: type: string description: Formato da Data enum: - yyyy-MM-dd - dd/MM/yyyy label: Formato da Data referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetSeguroDefesoInputSchema: type: object properties: nis: type: string description: O parâmetro NIS pode ser enviado com ou sem formatação. label: NIS doc: type: string label: Documento description: Documento a ser consultado. Pode ser enviado com ou sem formatação. required: - nis - doc DatasetSerasaConcentreInputSchema: type: object required: - doc properties: doc: type: string label: CPF/CNPJ pattern: >- ^([0-9]{11}|[0-9]{3}\.[0-9]{3}\.[0-9]{3}-[0-9]{2}|[0-9A-Z]{12}[0-9]{2}|[0-9A-Z]{2}\.[0-9A-Z]{3}\.[0-9A-Z]{3}/[0-9A-Z]{4}-[0-9]{2})$ description: CPF ou CNPJ a ser consultado para análise de crédito e risco. DatasetSerasaCrednetInputSchema: type: object required: - doc - state properties: doc: type: string label: CPF/CNPJ pattern: >- ^([0-9]{11}|[0-9]{3}\.[0-9]{3}\.[0-9]{3}-[0-9]{2}|[0-9A-Z]{12}[0-9]{2}|[0-9A-Z]{2}\.[0-9A-Z]{3}\.[0-9A-Z]{3}/[0-9A-Z]{4}-[0-9]{2})$ description: CPF ou CNPJ a ser consultado para análise de crédito e risco. state: type: string label: UF pattern: ^[A-Z]{2}$ description: Estado para consulta em cartórios. DatasetSerasaRelatoInputSchema: type: object required: - doc properties: doc: type: string pattern: ^[0-9A-Z]{12}[0-9]{2}$ title: CPF ou CNPJ description: >- CPF ou CNPJ a ser consultado na Serasa Experian, informado somente com números. default: '00000000000191' state: type: string minLength: 2 maxLength: 2 title: Estado description: >- UF usada pela Serasa Experian como federalUnit para consultas estaduais do relatório, incluindo buscas em cartórios e protestos quando aplicável. additionalProperties: false DatasetSicarPropertyDataInputSchema: type: object properties: carnumber: type: string description: carnumber referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - carnumber DatasetSimilarityArgentinaInputSchema: type: object properties: phone: type: string description: O parâmetro PHONE pode ser enviado com ou sem formatação. label: PHONE postcode: type: string description: '' label: POSTCODE state: type: string description: '' label: STATE city: type: string description: '' label: CITY address: type: string description: '' label: ADDRESS dob: type: string description: '' label: DOB surname: type: string description: '' label: SURNAME name: type: string description: '' label: NAME dni: type: string description: '' label: DNI required: - dob - surname - name - dni DatasetSimilarityBrazilApiDeComparacaoEAnaliseDeDadosInputSchema: type: object properties: phone: type: string description: >- Caso haja mais de um telefone, use “|” (sem aspas) para separá-los. Ex: 11912345678 | 11987654321. label: PHONE postcode: type: string description: 'CEP - Ex: 12345-123.' label: POSTCODE state: type: string description: 'ESTADO - Ex: SP.' label: STATE city: type: string description: NOME DA CIDADE. label: CITY address: type: string description: 'ENDEREÇO - Ex: Rua Óbidos, 674.' label: ADDRESS dob: type: string description: 'DATA DE NASCIMENTO - Ex: yyyy/MM/dd.' label: DOB surname: type: string description: '' label: SURNAME name: type: string description: '' label: NAME doc: type: string label: Documento description: Documento a ser consultado. Pode ser enviado com ou sem formatação. required: - dob - surname - name - doc DatasetSimilarityMexicoValidacaoDeDadosCadastraisECurpInputSchema: type: object properties: phone: type: string description: >- Caso haja mais de um telefone, use “|” (sem aspas) para separá-los. Ex: 6641769451 | 4659554184. label: PHONE postcode: type: string description: 'CEP - Ex: 22206.' label: POSTCODE state: type: string description: 'ESTADO - Ex: CHI.' label: STATE city: type: string description: NOME DA CIDADE. label: CITY address: type: string description: 'ENDEREÇO - Ex: Calle Colinas Del Valle, 3150.' label: ADDRESS dob: type: string description: 'DATA DE NASCIMENTO - Ex: yyyy/MM/dd.' label: DOB surname: type: string description: '' label: SURNAME name: type: string description: '' label: NAME curp: type: string description: >- O parâmetro CURP pode ser enviado com ou sem formatação. Este parâmetro não é obrigatório, mas caso não utilizado, enviar os parâmetros 'NAME', 'SURNAME' e 'DOB'. label: CURP required: - dob - surname - name - curp DatasetSimplesNacionalInputSchema: type: object properties: doc: type: string label: Documento description: Documento a ser consultado. Pode ser enviado com ou sem formatação. required: - doc DatasetSintegraCadastroCentralizadoDeContribuinteCccInputSchema: type: object properties: uf: type: string description: >- O(s) parâmetro(s) UF é(são) obrigatório(s) para esta consulta (AC, AL, AM, AP, BA, CE, DF, ES, GO, MA, MG, MS, MT, PA, PB, PE, PI, PR, RJ, RN, RO, RR, RS, SC, SE, SP, TO). label: UF ie: type: string description: O parâmetro IE pode ser enviado com ou sem formatação. label: IE doc: type: string label: Documento description: Documento a ser consultado. Pode ser enviado com ou sem formatação. required: - uf - ie - doc DatasetSintegraCadastrosEstaduaisInputSchema: type: object properties: uf: type: string description: >- O(s) parâmetro(s) UF é(são) obrigatório(s) para esta consulta (AC, AL, AM, AP, BA, CE, DF, ES, GO, MA, MG, MS, MT, PA, PB, PE, PI, PR, RJ, RN, RO, RR, RS, SC, SE, SP, TO). label: UF ie: type: string description: O parâmetro IE pode ser enviado com ou sem formatação. label: IE doc: type: string label: Documento description: Documento a ser consultado. Pode ser enviado com ou sem formatação. required: - uf - ie - doc DatasetSocialAssistanceExtendedInputSchema: type: object properties: doc: type: string description: CPF da pessoa (apenas números) pattern: ^([0-9]{11}|[0-9]{3}\.[0-9]{3}\.[0-9]{3}-[0-9]{2})$ label: CPF programname: type: string description: Nome do programa social enum: - Bolsa Familia - Seguro Defeso - Auxilio Emergencial - Auxilio Brasil - Beneficio de Prestacao Continuada - Auxílio Reconstrução - Pé de meia programstate: type: string description: Unidade federativa associada ao programa referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetSocialConscienceInputSchema: type: object properties: doc: type: string description: CNPJ da empresa pattern: >- ^([0-9A-Z]{12}[0-9]{2}|[0-9A-Z]{2}\.[0-9A-Z]{3}\.[0-9A-Z]{3}/[0-9A-Z]{4}-[0-9]{2})$ label: CNPJ referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetSportsExposureInputSchema: type: object properties: doc: type: string description: CPF da pessoa (apenas números) pattern: ^([0-9]{11}|[0-9]{3}\.[0-9]{3}\.[0-9]{3}-[0-9]{2})$ label: CPF relationshiplevel: type: string description: Nível de relacionamento entre o indivíduo e a entidade esportiva enum: - DIRECT - INDIRECT 1ST LEVEL - INDIRECT 2ND LEVEL - INDIRECT 3RD LEVEL - INDIRECT 4TH LEVEL - BUSINESS PARTNER role: type: string description: Função exercida pelo indivíduo na entidade esportiva enum: - ASSISTANT COACH - COACH - COUNCIL MEMBER - DIRECTOR - EX-PRESIDENT - MANAGER - PLAYER - PRESIDENT - REFEREE - STAFF - VICE-PRESIDENT isactive: type: string description: Permite filtrar vínculos esportivos ativos ou inativos enum: - 'true' - 'false' referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetSuframaCnpjInputSchema: type: object properties: doc: type: string label: Documento description: Documento a ser consultado. Pode ser enviado com ou sem formatação. required: - doc DatasetSugarcaneAgroecologicalZoningInputSchema: type: object properties: zipcode: type: string description: zipcode pattern: ^[0-9]{5}-[0-9]{3}$ label: CEP householdcode: type: string description: Identificador geográfico de residência buildingcode: type: string description: Identificador geográfico de edificação state: type: string description: Unidade federativa utilizada como referência geográfica cities: type: string description: Lista de municípios utilizados na consulta city: type: string description: Município utilizado como referência geográfica geocode: type: string description: Código geográfico definido pelo IBGE polygon: type: string description: Polígono geográfico utilizado para delimitar a área de análise referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - zipcode DatasetSyndicateAgreementsInputSchema: type: object properties: doc: type: string description: CNPJ da empresa pattern: >- ^([0-9A-Z]{12}[0-9]{2}|[0-9A-Z]{2}\.[0-9A-Z]{3}\.[0-9A-Z]{3}/[0-9A-Z]{4}-[0-9]{2})$ label: CNPJ referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: Limite de resultados label: Limite required: - doc DatasetTcuCertidaoNegativaDeLicitanteInidoneoInputSchema: type: object properties: doc: type: string label: Documento description: Documento a ser consultado. Pode ser enviado com ou sem formatação. required: - doc DatasetTcuCertidaoNegativaDeProcessoInputSchema: type: object properties: doc: type: string label: Documento description: Documento a ser consultado. Pode ser enviado com ou sem formatação. required: [] DatasetTcuConsultaConsolidadaDePessoaJuridicaApfInputSchema: type: object properties: doc: type: string label: Documento description: Documento a ser consultado. Pode ser enviado com ou sem formatação. required: - doc DatasetTjCertidaoCivelCriminalEFiscalTribunalDeJusticaInputSchema: type: object properties: uf: type: string description: >- O(s) parâmetro(s) UF e TIPO é(são) obrigatório(s) para esta consulta (AC,AP,AM,BA,CE,DF,ES,GO,MT,PA,PB,PE,PI,RN,RR,RS,SE,SP,TO). label: UF tipo: type: string enum: - Cível - Criminal - Fiscal - FinsEleitorais - FalênciaRecuperação - Família - Militar description: >- O parâmetro TIPO deve ser enviado (Cível, Criminal, Fiscal, FinsEleitorais, FalênciaRecuperação, Família, Militar). label: Tipo genero: type: string description: '' label: GENERO rg: type: string description: O parâmetro RG pode ser enviado com ou sem formatação. label: RG nomepai: type: string description: O parâmetro NOMEPAI deve ser enviado de forma completa. label: NOMEPAI nomemae: type: string description: O parâmetro NOMEMAE deve ser enviado de forma completa. label: NOMEMAE datanascimento: type: string description: >- O parâmetro DATANASCIMENTO deve ser enviado nestes formatos: dd/mm/aaaa ou dd-mm-aaaa. label: DATANASCIMENTO nome: type: string description: O parâmetro NOME deve ser enviado de forma completa. label: NOME doc: type: string label: Documento description: Documento a ser consultado. Pode ser enviado com ou sem formatação. required: - uf - tipo - doc DatasetTjTribunalDeJusticaProcessosInputSchema: type: object properties: uf: type: string description: >- O(s) parâmetro(s) UF e GRAU é(são) obrigatório(s) para esta consulta (PE,PI,SC,SP). label: UF grau: type: string description: >- O(s) parâmetro(s) UF e GRAU é(são) obrigatório(s) para esta consulta (PE,PI,SC,SP). label: GRAU numeroprocesso: type: string description: O parâmetro NUMEROPROCESSO pode ser enviado com ou sem formatação. label: NUMEROPROCESSO nomeparte: type: string description: O parâmetro NOMEPARTE deve ser enviado de forma completa. label: NOMEPARTE doc: type: string label: Documento description: Documento a ser consultado. Pode ser enviado com ou sem formatação. required: - uf - grau - doc DatasetTrfTribunalRegionalFederalCertidaoCivelEleitoralOuCriminalInputSchema: type: object properties: regiao: type: string enum: - TRF1 - TRF2 - TRF3 - TRF4 - TRF5 - TRF6 oneOf: - const: TRF1 title: Tribunal Regional Federal da 1ª Região description: >- Acre, Amapá, Amazonas, Bahia, Distrito Federal, Goiás, Maranhão, Mato Grosso, Pará, Piauí, Rondônia, Roraima e Tocantins - const: TRF2 title: Tribunal Regional Federal da 2ª Região description: Espírito Santo e Rio de Janeiro - const: TRF3 title: Tribunal Regional Federal da 3ª Região description: Mato Grosso do Sul e São Paulo - const: TRF4 title: Tribunal Regional Federal da 4ª Região description: Paraná, Rio Grande do Sul e Santa Catarina - const: TRF5 title: Tribunal Regional Federal da 5ª Região description: >- Alagoas, Ceará, Paraíba, Pernambuco, Rio Grande do Norte e Sergipe - const: TRF6 title: Tribunal Regional Federal da 6ª Região description: Minas Gerais description: >- Selecione o Tribunal Regional Federal responsável pela localidade consultada. label: Região tipo: type: string enum: - Cível - Criminal - FinsEleitorais description: O parâmetro TIPO deve ser enviado (Cível, Criminal, FinsEleitorais). label: Tipo doc: type: string label: Documento description: Documento a ser consultado. Pode ser enviado com ou sem formatação. required: - regiao - tipo - doc DatasetTrtTribunalRegionalDoTrabalhoInputSchema: type: object properties: regiao: type: string enum: - '1' - '2' - '3' - '4' - '5' - '6' - '7' - '8' - '9' - '10' - '11' - '12' - '13' - '14' - '15' - '16' - '17' - '18' - '19' - '20' - '21' - '22' - '23' - '24' oneOf: - const: '1' title: Tribunal Regional do Trabalho da 1ª Região description: Rio de Janeiro (RJ) - const: '2' title: Tribunal Regional do Trabalho da 2ª Região description: São Paulo - capital (SP) - const: '3' title: Tribunal Regional do Trabalho da 3ª Região description: Minas Gerais (MG) - const: '4' title: Tribunal Regional do Trabalho da 4ª Região description: Rio Grande do Sul (RS) - const: '5' title: Tribunal Regional do Trabalho da 5ª Região description: Bahia (BA) - const: '6' title: Tribunal Regional do Trabalho da 6ª Região description: Pernambuco (PE) - const: '7' title: Tribunal Regional do Trabalho da 7ª Região description: Ceará (CE) - const: '8' title: Tribunal Regional do Trabalho da 8ª Região description: Amapá e Pará (AP e PA) - const: '9' title: Tribunal Regional do Trabalho da 9ª Região description: Paraná (PR) - const: '10' title: Tribunal Regional do Trabalho da 10ª Região description: Distrito Federal e Tocantins (DF e TO) - const: '11' title: Tribunal Regional do Trabalho da 11ª Região description: Amazonas e Roraima (AM e RR) - const: '12' title: Tribunal Regional do Trabalho da 12ª Região description: Santa Catarina (SC) - const: '13' title: Tribunal Regional do Trabalho da 13ª Região description: Paraíba (PB) - const: '14' title: Tribunal Regional do Trabalho da 14ª Região description: Acre e Rondônia (AC e RO) - const: '15' title: Tribunal Regional do Trabalho da 15ª Região description: São Paulo - interior (SP) - const: '16' title: Tribunal Regional do Trabalho da 16ª Região description: Maranhão (MA) - const: '17' title: Tribunal Regional do Trabalho da 17ª Região description: Espírito Santo (ES) - const: '18' title: Tribunal Regional do Trabalho da 18ª Região description: Goiás (GO) - const: '19' title: Tribunal Regional do Trabalho da 19ª Região description: Alagoas (AL) - const: '20' title: Tribunal Regional do Trabalho da 20ª Região description: Sergipe (SE) - const: '21' title: Tribunal Regional do Trabalho da 21ª Região description: Rio Grande do Norte (RN) - const: '22' title: Tribunal Regional do Trabalho da 22ª Região description: Piauí (PI) - const: '23' title: Tribunal Regional do Trabalho da 23ª Região description: Mato Grosso (MT) - const: '24' title: Tribunal Regional do Trabalho da 24ª Região description: Mato Grosso do Sul (MS) description: >- Selecione o Tribunal Regional do Trabalho responsável pela localidade consultada. label: Região x-fern-enum: '1': name: Value1 '2': name: Value2 '3': name: Value3 '4': name: Value4 '5': name: Value5 '6': name: Value6 '7': name: Value7 '8': name: Value8 '9': name: Value9 '10': name: Value10 '11': name: Value11 '12': name: Value12 '13': name: Value13 '14': name: Value14 '15': name: Value15 '16': name: Value16 '17': name: Value17 '18': name: Value18 '19': name: Value19 '20': name: Value20 '21': name: Value21 '22': name: Value22 '23': name: Value23 '24': name: Value24 doc: type: string label: Documento description: Documento a ser consultado. Pode ser enviado com ou sem formatação. required: - regiao - doc DatasetTseCertidaoDeQuitacaoEleitoralInputSchema: type: object properties: datanascimento: type: string description: >- O parâmetro DATANASCIMENTO deve ser fornecido, com ou sem formatação. label: DATANASCIMENTO numerotituloeleitoral: type: string description: >- O parâmetro NUMEROTITULOELEITORAL pode ser enviado com ou sem formatação. label: NUMEROTITULOELEITORAL nomepai: type: string description: O parâmetro NOMEPAI pode ser enviado com qualquer outro. label: NOMEPAI nomemae: type: string description: O parâmetro NOMEMAE pode ser enviado com qualquer outro. label: NOMEMAE nome: type: string description: O parâmetro NOMEPAI pode ser enviado com qualquer outro. label: NOME doc: type: string label: Documento description: Documento a ser consultado. Pode ser enviado com ou sem formatação. required: - datanascimento - numerotituloeleitoral - nomepai - nomemae - nome - doc DatasetTseSituacaoEleitoralInputSchema: type: object properties: numerotituloeleitoral: type: string description: >- O parâmetro NUMEROTITULOELEITORAL pode ser enviado com ou sem formatação. label: NUMEROTITULOELEITORAL datanascimento: type: string description: >- O parâmetro DATANASCIMENTO deve ser enviado nestes formatos: dd/mm/aaaa ou dd-mm-aaaa. Caso informado, enviar também NOME de forma completa. label: DATANASCIMENTO nome: type: string description: >- O parâmetro DATANASCIMENTO deve ser enviado nestes formatos: dd/mm/aaaa ou dd-mm-aaaa. Caso informado, enviar também NOME de forma completa. label: NOME doc: type: string label: Documento description: Documento a ser consultado. Pode ser enviado com ou sem formatação. required: - numerotituloeleitoral - datanascimento - nome - doc DatasetTseTituloELocalDeVotacaoInputSchema: type: object properties: nomemae: type: string description: O parâmetro NOMEMAE deve ser enviado de forma completa. label: NOMEMAE datanascimento: type: string description: >- O parâmetro DATANASCIMENTO deve ser enviado nestes formatos: dd/mm/aaaa ou dd-mm-aaaa. label: DATANASCIMENTO numerotituloeleitoral: type: string description: >- O parâmetro NUMEROTITULOELEITORAL pode ser enviado com ou sem formatação. label: NUMEROTITULOELEITORAL nome: type: string description: O parâmetro NOMEMAE deve ser enviado de forma completa. label: NOME doc: type: string label: Documento description: Documento a ser consultado. Pode ser enviado com ou sem formatação. required: - nomemae - datanascimento - numerotituloeleitoral - nome - doc DatasetTstCertidaoNegativaDeDebitosTrabalhistasInputSchema: type: object properties: doc: type: string label: Documento description: Documento a ser consultado. Pode ser enviado com ou sem formatação. required: - doc DatasetUkHmTreasuryFinancialSanctionsInputSchema: type: object properties: nome: type: string description: O parâmetro NOME pode ser enviado com qualquer outro. label: NOME required: - nome DatasetUniversityStudentDataInputSchema: type: object properties: doc: type: string description: CPF da pessoa (apenas números) pattern: ^([0-9]{11}|[0-9]{3}\.[0-9]{3}\.[0-9]{3}-[0-9]{2})$ label: CPF level: type: string description: Nível de formação acadêmica institution: type: string description: Nome da instituição de ensino specializationarea: type: string description: Área de especialização ou formação referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: >- Quantidade máxima de registros retornados. Use o modificador .limit(x) no campo Datasets. label: Limite required: - doc DatasetUnscclUnitedNationsSecurityCouncilConsolidatedListInputSchema: type: object properties: sobrenome: type: string description: '' label: SOBRENOME nome: type: string description: O parâmetro NOME pode ser enviado em maiúsculo ou minúsculo. label: NOME required: - nome DatasetVehiclesInputSchema: type: object properties: doc: type: string description: Documento de identificação pattern: ^([0-9]{11}|[0-9]{3}\.[0-9]{3}\.[0-9]{3}-[0-9]{2})$ label: CPF birthdate: type: string description: Data de Nascimento pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ label: Data de Nascimento dateformat: type: string description: Formato da Data enum: - yyyy-MM-dd - dd/MM/yyyy label: Formato da Data model: type: string description: Modelo do veículo category: type: string description: Categoria do veículo fuelType: type: string description: Tipo de combustível brand: type: string description: Marca do veículo fipeCode: type: string description: Código do veículo na tabela FIPE modelYear: type: string description: Ano do modelo do veículo referencedate: type: string description: Qualquer data válida label: Data pattern: ^[0-9]{2}/[0-9]{2}/[0-9]{4}$ limit: type: number description: >- Quantidade máxima de registros retornados. Use o modificador .limit(x) no campo Datasets. label: Limite required: - doc DatasetVeiculosFipeInputSchema: type: object properties: chassi: type: string description: O parâmetro CHASSI pode ser enviado com ou sem formatação. label: CHASSI placa: type: string description: O parâmetro PLACA pode ser enviado com ou sem formatação. label: PLACA required: - chassi - placa DatasetVerificacaoDeEmpregadorTrabalhoForcadoInputSchema: type: object properties: doc: type: string label: Documento description: Documento a ser consultado. Pode ser enviado com ou sem formatação. required: - doc DatasetVinculoEmpregaticioInputSchema: type: object properties: doc: type: string label: Documento description: Documento a ser consultado. Pode ser enviado com ou sem formatação. required: - doc DatasetVinculosSocietariosInputSchema: type: object properties: doc: type: string label: Documento description: Documento a ser consultado. Pode ser enviado com ou sem formatação. required: - doc QueryParentInput: type: object properties: type: type: string enum: - dataset_query_id dataset_query_id: type: string description: Parent dataset query ID example: qry_parent123 required: - type - dataset_query_id DatasetRef: type: object properties: object: type: string description: Object type identifier example: dataset enum: - dataset id: type: string description: Dataset ID slug: type: string description: Dataset slug name: type: string description: Dataset name description: type: string description: Dataset description nullable: true cost: type: number description: Query cost in cents upstreams: type: array items: $ref: '#/components/schemas/UpstreamOutput' required: - object - id ProviderRef: type: object properties: object: type: string description: Object type identifier example: provider enum: - provider id: type: string description: Provider ID slug: type: string description: Provider slug name: type: string description: Provider name required: - object - id QueryCanonicalInvalidationTargetOutput: type: object properties: type: type: string enum: - domain - certificate - sanction - endpoint domain: type: string description: Entity domain when type is domain example: serasa certificate: type: string description: Certificate key when type is certificate example: fgts sanction: type: string description: Sanction source key when type is sanction example: ceis endpoint: type: string description: Canonical entity endpoint key when type is endpoint example: entitiesGetScr required: - type QueryParentOutput: type: object properties: type: type: string enum: - dataset_query_id - company_id - person_id dataset_query_id: type: string description: Parent dataset query ID example: qry_parent123 company_id: type: string description: Parent company ID example: cmp_123 person_id: type: string description: Parent person ID example: '12345678909' required: - type QueryExportOutput: type: object properties: type: type: string description: Export reference type enum: - file_upload_id example: file_upload_id file_upload_id: type: string description: File upload ID for the generated PDF example: fl_abc123 downloadUrl: type: string description: Authenticated PDF download URL example: https://files.base39.cloud/uploads/org/fl/report.pdf required: - type - file_upload_id - downloadUrl UpstreamOutput: type: object properties: object: type: string example: page description: Object type title: Object x-locale-pt-br-title: Objeto id: type: string example: p_abc123 description: Unique identifier title: ID x-locale-pt-br-title: ID createdAt: format: date-time type: string example: '2024-01-15T10:30:00.000Z' description: Creation timestamp title: Created at x-locale-pt-br-title: Criado em updatedAt: format: date-time type: string example: '2024-01-15T14:45:00.000Z' description: Last update timestamp title: Updated at x-locale-pt-br-title: Atualizado em createdBy: type: object example: object: user id: u_abc123 apiKeyId: bsk_abc123 description: Principal who created this object properties: object: type: string enum: - user - service_account example: user id: type: string example: u_abc123 apiKeyId: type: string example: bsk_abc123 title: Created by x-locale-pt-br-title: Criado por updatedBy: type: object example: object: user id: u_abc123 apiKeyId: bsk_abc123 description: Principal who last updated this object properties: object: type: string enum: - user - service_account - webhook - stream example: user id: type: string example: u_abc123 apiKeyId: type: string example: bsk_abc123 title: Updated by x-locale-pt-br-title: Atualizado por name: type: string description: Upstream name example: Federal Revenue description: type: string description: Upstream description nullable: true logo: type: string description: Upstream logo URL nullable: true slug: type: string description: URL-friendly slug example: federal-revenue country: type: string description: Country code example: BR type: type: string description: Upstream type nullable: true url: type: string description: Upstream URL nullable: true featured: type: boolean description: Whether this is the featured upstream example: true required: - object - id - createdAt - updatedAt - name - description - logo - slug - country - type - url securitySchemes: OAuth2: type: oauth2 flows: authorizationCode: authorizationUrl: https://id.local.base39.cloud/oauth2/authorize tokenUrl: https://id.local.base39.cloud/oauth2/token scopes: profile: Read user profile email: Read user email openid: OpenID authentication description: OAuth2 Authorization Code flow ````