2.0info: 1.10.0 Dados description: Serviço responsável pela consulta do Marketing Intelligence x-senior-domain: Marketing Intelligence x-senior-domain-path: mktint x-senior-service-path: data contact: name: Senior X Platform url: https://dev.senior.com.br email: seniorx-dev@senior.com.brhost: platform.senior.com.br /t/senior.com.br/bridge/1.0/rest/mktintsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /data/queries/healthcheck: post: description: Health check tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status properties: status: type: string allOf: – #/definitions/upDownEnum description: Status geral do serviço 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Health check tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status properties: status: type: string allOf: – #/definitions/upDownEnum description: Status geral do serviço 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /data/queries/listCompanyLegalNature: post: description: Natureza Jurídica tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: search: type: string maxLength: 255 description: Natureza Jurídica page: type: integer format: int64 description: Página default: 0 size: type: integer format: int64 description: Quantidade de registros default: 10 useDataset: type: boolean description: Indica se a consulta deve ser feita no Dataset default: false responses: 200: description: Ok schema: type: object required: – contents – totalElements – totalPages properties: contents: type: array items: type: object allOf: – #/definitions/listCompanyLegalNatureRecord minimum: 1 description: Conteúdos totalElements: type: integer format: int64 description: Total de Registros totalPages: type: integer format: int64 description: Total de Páginas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Natureza Jurídica tags: – Queries x-senior-visibility: PUBLIC parameters: – name: search description: Natureza Jurídica in: query type: string maxLength: 255 – name: page description: Página in: query type: integer format: int64 – name: size description: Quantidade de registros in: query type: integer format: int64 – name: useDataset description: Indica se a consulta deve ser feita no Dataset in: query type: boolean responses: 200: description: Ok schema: type: object required: – contents – totalElements – totalPages properties: contents: type: array items: type: object allOf: – #/definitions/listCompanyLegalNatureRecord minimum: 1 description: Conteúdos totalElements: type: integer format: int64 description: Total de Registros totalPages: type: integer format: int64 description: Total de Páginas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /data/queries/listCompanyClassLegalNature: post: description: Classe da Natureza Jurídica tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: legalNatureId: type: integer format: int64 description: Id da Natureza Jurídica search: type: string maxLength: 255 description: Classe da Natureza Jurídica page: type: integer format: int64 description: Página default: 0 size: type: integer format: int64 description: Quantidade de registros default: 10 useDataset: type: boolean description: Indica se a consulta deve ser feita no Dataset default: false responses: 200: description: Ok schema: type: object required: – contents – totalElements – totalPages properties: contents: type: array items: type: object allOf: – #/definitions/listCompanyClassLegalNatureRecord minimum: 1 description: Conteúdos totalElements: type: integer format: int64 description: Total de Registros totalPages: type: integer format: int64 description: Total de Páginas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Classe da Natureza Jurídica tags: – Queries x-senior-visibility: PUBLIC parameters: – name: legalNatureId description: Id da Natureza Jurídica in: query type: integer format: int64 – name: search description: Classe da Natureza Jurídica in: query type: string maxLength: 255 – name: page description: Página in: query type: integer format: int64 – name: size description: Quantidade de registros in: query type: integer format: int64 – name: useDataset description: Indica se a consulta deve ser feita no Dataset in: query type: boolean responses: 200: description: Ok schema: type: object required: – contents – totalElements – totalPages properties: contents: type: array items: type: object allOf: – #/definitions/listCompanyClassLegalNatureRecord minimum: 1 description: Conteúdos totalElements: type: integer format: int64 description: Total de Registros totalPages: type: integer format: int64 description: Total de Páginas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /data/queries/listCompanySegment: post: description: Segmento tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: search: type: string maxLength: 255 description: Segmento page: type: integer format: int64 description: Página default: 0 size: type: integer format: int64 description: Quantidade de registros default: 10 useDataset: type: boolean description: Indica se a consulta deve ser feita no Dataset default: false responses: 200: description: Ok schema: type: object required: – contents – totalElements – totalPages properties: contents: type: array items: type: object allOf: – #/definitions/listCompanySegmentRecord minimum: 1 description: Conteúdos totalElements: type: integer format: int64 description: Total de Registros totalPages: type: integer format: int64 description: Total de Páginas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Segmento tags: – Queries x-senior-visibility: PUBLIC parameters: – name: search description: Segmento in: query type: string maxLength: 255 – name: page description: Página in: query type: integer format: int64 – name: size description: Quantidade de registros in: query type: integer format: int64 – name: useDataset description: Indica se a consulta deve ser feita no Dataset in: query type: boolean responses: 200: description: Ok schema: type: object required: – contents – totalElements – totalPages properties: contents: type: array items: type: object allOf: – #/definitions/listCompanySegmentRecord minimum: 1 description: Conteúdos totalElements: type: integer format: int64 description: Total de Registros totalPages: type: integer format: int64 description: Total de Páginas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /data/queries/listCompanySubsegment: post: description: SubSegmento tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: segmentIds: type: array items: type: string maxLength: 255 description: Id do Segmento search: type: string maxLength: 255 description: Sub segmento page: type: integer format: int64 description: Página default: 0 size: type: integer format: int64 description: Quantidade de registros default: 10 useDataset: type: boolean description: Indica se a consulta deve ser feita no Dataset default: false responses: 200: description: Ok schema: type: object required: – contents – totalElements – totalPages properties: contents: type: array items: type: object allOf: – #/definitions/listCompanySubsegmentRecord minimum: 1 description: Conteúdos totalElements: type: integer format: int64 description: Total de Registros totalPages: type: integer format: int64 description: Total de Páginas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /data/queries/listCompanyCnaeMainActivity: post: description: Atividade Principal tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: subsegmentIds: type: array items: type: string maxLength: 255 description: Id do SubSegmento search: type: string maxLength: 255 description: Atividade principal code: type: string maxLength: 255 description: Código da atividade page: type: integer format: int64 description: Página default: 0 size: type: integer format: int64 description: Quantidade de registros default: 10 useDataset: type: boolean description: Indica se a consulta deve ser feita no Dataset default: false responses: 200: description: Ok schema: type: object required: – contents – totalElements – totalPages properties: contents: type: array items: type: object allOf: – #/definitions/listCompanyCnaeMainActivityRecord minimum: 1 description: Conteúdos totalElements: type: integer format: int64 description: Total de Registros totalPages: type: integer format: int64 description: Total de Páginas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /data/queries/searchCompanies: post: description: Buscar Empresas com filtros tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – filter properties: filter: type: object allOf: – #/definitions/searchCompaniesFilterRecord description: Filtro page: type: integer format: int64 description: Página default: 0 size: type: integer format: int64 description: Quantidade de registros default: 10 previewMode: type: string allOf: – #/definitions/previewModeEnum description: Modo de Visualização useDataset: type: boolean description: Indica se a consulta deve ser feita no Dataset default: false responses: 200: description: Ok schema: type: object required: – contents – totalElements – totalPages properties: contents: type: array items: type: object allOf: – #/definitions/searchCompaniesRecord minimum: 1 description: Conteúdos totalElements: type: integer format: int64 description: Total de Registros totalPages: type: integer format: int64 description: Total de Páginas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /data/queries/listCompanyPartners: post: description: Listar Sócios da Empresa tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – cnpj properties: cnpj: type: string maxLength: 255 description: CNPJ page: type: integer format: int64 description: Página default: 0 size: type: integer format: int64 description: Quantidade de registros default: 10 useDataset: type: boolean description: Indica se a consulta deve ser feita no Dataset default: false responses: 200: description: Ok schema: type: object required: – contents – totalElements – totalPages properties: contents: type: array items: type: object allOf: – #/definitions/partnerRecord minimum: 1 description: Sócios totalElements: type: integer format: int64 description: Total de Registros totalPages: type: integer format: int64 description: Total de Páginas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Listar Sócios da Empresa tags: – Queries x-senior-visibility: PUBLIC parameters: – name: cnpj description: CNPJ in: query required: true type: string maxLength: 255 – name: page description: Página in: query type: integer format: int64 – name: size description: Quantidade de registros in: query type: integer format: int64 – name: useDataset description: Indica se a consulta deve ser feita no Dataset in: query type: boolean responses: 200: description: Ok schema: type: object required: – contents – totalElements – totalPages properties: contents: type: array items: type: object allOf: – #/definitions/partnerRecord minimum: 1 description: Sócios totalElements: type: integer format: int64 description: Total de Registros totalPages: type: integer format: int64 description: Total de Páginas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /data/queries/listCompanyCnae: post: description: Listar CNAEs secundários tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – cnpj properties: cnpj: type: string maxLength: 255 description: CNPJ page: type: integer format: int64 description: Página default: 0 size: type: integer format: int64 description: Quantidade de registros default: 10 useDataset: type: boolean description: Indica se a consulta deve ser feita no Dataset default: false responses: 200: description: Ok schema: type: object required: – contents – totalElements – totalPages properties: contents: type: array items: type: object allOf: – #/definitions/cnaeRecord minimum: 1 description: CNAEs secundários totalElements: type: integer format: int64 description: Total de Registros totalPages: type: integer format: int64 description: Total de Páginas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Listar CNAEs secundários tags: – Queries x-senior-visibility: PUBLIC parameters: – name: cnpj description: CNPJ in: query required: true type: string maxLength: 255 – name: page description: Página in: query type: integer format: int64 – name: size description: Quantidade de registros in: query type: integer format: int64 – name: useDataset description: Indica se a consulta deve ser feita no Dataset in: query type: boolean responses: 200: description: Ok schema: type: object required: – contents – totalElements – totalPages properties: contents: type: array items: type: object allOf: – #/definitions/cnaeRecord minimum: 1 description: CNAEs secundários totalElements: type: integer format: int64 description: Total de Registros totalPages: type: integer format: int64 description: Total de Páginas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /data/queries/listCompaniesCnae: post: description: Listar CNAEs secundários tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – cnpjs properties: cnpjs: type: array items: type: string maxLength: 255 minimum: 1 description: CNPJ page: type: integer format: int64 description: Página default: 0 size: type: integer format: int64 description: Quantidade de registros default: 10 useDataset: type: boolean description: Indica se a consulta deve ser feita no Dataset default: false responses: 200: description: Ok schema: type: object required: – contents – totalElements – totalPages properties: contents: type: array items: type: object allOf: – #/definitions/listCompaniesCnaeRecord minimum: 1 description: CNAEs secundários totalElements: type: integer format: int64 description: Total de Registros totalPages: type: integer format: int64 description: Total de Páginas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /data/queries/listCompanyRelation: post: description: Listar Empresas Relacionadas tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – cnpj – revenueBusinessId properties: cnpj: type: string maxLength: 255 description: CNPJ da Empresa revenueBusinessId: type: string maxLength: 255 description: Id da Receita Federal page: type: integer format: int64 description: Página default: 0 size: type: integer format: int64 description: Quantidade de registros default: 10 useDataset: type: boolean description: Indica se a consulta deve ser feita no Dataset default: false responses: 200: description: Ok schema: type: object required: – contents – totalElements – totalPages properties: contents: type: array items: type: object allOf: – #/definitions/companyRelationRecord minimum: 1 description: Empresa Relacionadas totalElements: type: integer format: int64 description: Total de Registros totalPages: type: integer format: int64 description: Total de Páginas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Listar Empresas Relacionadas tags: – Queries x-senior-visibility: PUBLIC parameters: – name: cnpj description: CNPJ da Empresa in: query required: true type: string maxLength: 255 – name: revenueBusinessId description: Id da Receita Federal in: query required: true type: string maxLength: 255 – name: page description: Página in: query type: integer format: int64 – name: size description: Quantidade de registros in: query type: integer format: int64 – name: useDataset description: Indica se a consulta deve ser feita no Dataset in: query type: boolean responses: 200: description: Ok schema: type: object required: – contents – totalElements – totalPages properties: contents: type: array items: type: object allOf: – #/definitions/companyRelationRecord minimum: 1 description: Empresa Relacionadas totalElements: type: integer format: int64 description: Total de Registros totalPages: type: integer format: int64 description: Total de Páginas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /data/queries/listCompanies: post: description: Litar Empresas tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – cnpjs properties: cnpjs: type: array items: type: string maxLength: 255 minimum: 1 description: CNPJs useDataset: type: boolean description: Indica se a consulta deve ser feita no Dataset default: false responses: 200: description: Ok schema: type: object required: – companies properties: companies: type: array items: type: object allOf: – #/definitions/getCompanyRecord minimum: 1 description: Empresas encontradas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /data/queries/getCompany: post: description: Pegar Empresa tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – cnpj properties: cnpj: type: string maxLength: 255 description: CNPJ useDataset: type: boolean description: Indica se a consulta deve ser feita no Dataset default: false responses: 200: description: Ok schema: type: object allOf: – #/definitions/getCompanyRecord 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Pegar Empresa tags: – Queries x-senior-visibility: PUBLIC parameters: – name: cnpj description: CNPJ in: query required: true type: string maxLength: 255 – name: useDataset description: Indica se a consulta deve ser feita no Dataset in: query type: boolean responses: 200: description: Ok schema: type: object allOf: – #/definitions/getCompanyRecord 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /data/queries/getSmartApproach: post: description: Gerar abordagem inteligente tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – cnpj – productName properties: cnpj: type: string maxLength: 255 description: CNPJ productName: type: string maxLength: 255 description: Nome do Produto useDataset: type: boolean description: Indica se a consulta deve ser feita no Dataset default: false responses: 200: description: Ok schema: type: object required: – generatedText properties: generatedText: type: string maxLength: 255 description: Texto gerado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Gerar abordagem inteligente tags: – Queries x-senior-visibility: PUBLIC parameters: – name: cnpj description: CNPJ in: query required: true type: string maxLength: 255 – name: productName description: Nome do Produto in: query required: true type: string maxLength: 255 – name: useDataset description: Indica se a consulta deve ser feita no Dataset in: query type: boolean responses: 200: description: Ok schema: type: object required: – generatedText properties: generatedText: type: string maxLength: 255 description: Texto gerado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /data/queries/getCompanySummary: post: description: Gerar resumo da empresa com IA tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – cnpj properties: cnpj: type: string maxLength: 255 description: CNPJ useDataset: type: boolean description: Indica se a consulta deve ser feita no Dataset default: false responses: 200: description: Ok schema: type: object required: – generatedText properties: generatedText: type: string maxLength: 255 description: Texto gerado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Gerar resumo da empresa com IA tags: – Queries x-senior-visibility: PUBLIC parameters: – name: cnpj description: CNPJ in: query required: true type: string maxLength: 255 – name: useDataset description: Indica se a consulta deve ser feita no Dataset in: query type: boolean responses: 200: description: Ok schema: type: object required: – generatedText properties: generatedText: type: string maxLength: 255 description: Texto gerado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /data/queries/getMetadata: post: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: metadataFormat: type: string maxLength: 255 description: responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: metadataFormat description: in: query type: string maxLength: 255 responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /data/queries/getDependencies: post: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericErrordefinitions: upDownEnum: description: UP ou DOWN type: string enum: – UP – DOWN companyNumberEmployeesEnum: description: Enum das Faixas de Número de Funcionários type: string enum: – UP_TO_ONE – FROM_ONE_TO_TREE – FROM_FOUR_TO_SEVEN – FROM_EIGHT_TO_TEN – FROM_ELEVEN_TO_FIFTEEN – FROM_SIXTEEN_TO_TWENTY – FROM_TWENTY_ONE_TO_THIRTY – FROM_THIRTY_ONE_TO_FORTY – FROM_FORTY_ONE_TO_FIFTY – FROM_FIFTY_ONE_TO_SEVENTY – FROM_SEVENTY_ONE_TO_HUNDRED – FROM_HUNDRED_ONE_TO_TWO_HUNDRED – FROM_TWO_HUNDRED_ONE_TO_THREE_HUNDRED – FROM_THREE_HUNDRED_ONE_TO_FOUR_HUNDRED – FROM_FOUR_HUNDRED_ONE_TO_FIVE_HUNDRED – FROM_FIVE_HUNDRED_ONE_TO_SIX_HUNDRED – FROM_SIX_HUNDRED_ONE_TO_SEVEN_HUNDRED – FROM_SEVEN_HUNDRED_ONE_TO_EIGHT_HUNDRED – FROM_EIGHT_HUNDRED_ONE_TO_NINE_HUNDRED – FROM_NINE_HUNDRED_ONE_TO_THOUSAND – OVER_THOUSAND_ONE companyShareCapitalRelationalOperatorEnum: description: Enum do Operador Relacional do Capital Social type: string enum: – EQUAL – GREATER_THAN – GREATER_THAN_OR_EQUAL – LESS_THAN companyEstimatedRevenueEnum: description: Enum do Faturamento Estimado da Empresa type: string enum: – LESS_THAN_OR_EQUAL_TO_EIGHTY_ONE_THOUSAND – LESS_THAN_OR_EQUAL_TO_THREE_HUNDRED_AND_SIXTY_THOUSAND – FROM_THREE_HUNDRED_AND_SIXTY_THOUSAND_TO_ONE_MILLION – FROM_THREE_HUNDRED_AND_SIXTY_THOUSAND_TO_FOUR_MILLION_AND_EIGHT_HUNDRED_THOUSAND – FROM_ONE_MILLION_TO_ONE_HUNDRED_MILLION – FROM_ONE_HUNDRED_MILLION_TO_THREE_HUNDRED_MILLION – FROM_THREE_HUNDRED_AND_SIX_HUNDRED_MILLION – FROM_SIX_HUNDRED_MILLION_TO_ONE_BILLION – FROM_ONE_BILLION_THIRTY_BILLION – FROM_THIRTY_BILLION_TO_ONE_HUNDRED_BILLION – BIGGER_THAN_A_HUNDRED_BILLION companySizeEnum: description: Enum do Porte da Empresa type: string enum: – NOT_INFORMED – MICRO_ENTERPRISE – SMALL_BUSINESS – MEDIUM_AND_LARGE companyTypeEnum: description: Enum do Tipo da Empresa type: string enum: – HEAD_OFFICE – BRANCH previewModeEnum: description: Modo de visualização type: string enum: – LIST – MAP externalSystemEnum: description: Sistema Externo type: string enum: – CRM userNotificationKind: description: User notification kind. type: string enum: – Operational – Management – News userNotificationPriority: description: User notification priority. type: string enum: – Error – Alert – None eventEmailFormat: description: Format of the email type: string enum: – HTML – PLAIN_TEXT listCompanyLegalNatureRecord: description: Record da Natureza Jurídica type: object required: – id – name properties: id: type: integer format: int64 description: Código name: type: string maxLength: 255 description: Nome listCompanyClassLegalNatureRecord: description: Classe da Natureza Jurídica type: object required: – id – name properties: id: type: integer format: int64 description: Código name: type: string maxLength: 255 description: Nome listCompanySegmentRecord: description: Record do Segmento type: object required: – id – name properties: id: type: string maxLength: 255 description: Código name: type: string maxLength: 255 description: Nome listCompanySubsegmentRecord: description: Record do Sub-segmento type: object required: – id – name properties: id: type: string maxLength: 255 description: Código name: type: string maxLength: 255 description: Nome searchCompaniesFilterRecord: description: Filtros utilizados no listCompanies type: object properties: companyName: type: string maxLength: 255 description: Nome da Empresa companyCnpj: type: string maxLength: 255 description: CNPJ da Empresa companySegment: type: array items: type: string maxLength: 255 description: Segmentos da Empresa companySubsegment: type: array items: type: string maxLength: 255 description: Sub-segmentos da Empresa companyCnaeMainActivity: type: array items: type: string maxLength: 255 description: CNAEs Principal localizationCep: type: string maxLength: 255 description: CEP localizationState: type: array items: type: string maxLength: 255 description: Sigla Estado localizationCity: type: array items: type: string maxLength: 255 description: Cidade localizationDistrict: type: string maxLength: 255 description: Bairro localizationAddress: type: string maxLength: 255 description: Endereço localizationAddressNumber: type: integer format: int64 description: Número do Endereço localizationCepStart: type: string maxLength: 255 description: Faixa inicial do CEP localizationCepEnd: type: string maxLength: 255 description: Faixa final do CEP companyType: type: string allOf: – #/definitions/companyTypeEnum description: Tipo da Empresa companySize: type: string allOf: – #/definitions/companySizeEnum description: Porte da Empresa companyLegalNature: type: integer format: int64 description: Natureza Jurídica companyClassLegalNature: type: integer format: int64 description: Classe da Natureza Jurídica companyShareCapitalOperator: type: string allOf: – #/definitions/companyShareCapitalRelationalOperatorEnum description: Operador relacional do Capital Social companyShareCapitalValue: type: string description: Capital Social companyNumberEmployees: type: array items: type: string allOf: – #/definitions/companyNumberEmployeesEnum description: Numero de Funcionários companyEstimatedRevenue: type: array items: type: string allOf: – #/definitions/companyEstimatedRevenueEnum description: Faturamento Estimado da Empresa snOption: type: boolean description: Optante do Simples Nacional meiOption: type: boolean description: É optante do MEI companyDateOpeningStart: type: string format: date description: Faixa inicial da Data de abertura companyDateOpeningEnd: type: string format: date description: Faixa final da Data de abertura hasDebts: type: boolean description: Possui Dívidas com a União hasSocialSecurityDebts: type: boolean description: Possui Dívidas Previdenciárias hasDebtsWithFgts: type: boolean description: Possui Dívidas com FGTS hasNonSocialSecurityDebts: type: boolean description: Possui Dívidas Não Previdenciárias listCompanyCnaeMainActivityRecord: description: Record do CNAE Principal type: object required: – id – name properties: id: type: string maxLength: 255 description: Código name: type: string maxLength: 255 description: Nome searchCompaniesRecord: description: Record da Empresa type: object required: – id – companyCnpj – companyName – companyType – localizationState – localizationCity – localizationLatitude – localizationLongitude – companyCnaeMainActivity – companyShareCapitalValue – totalDebtsValue – totalSocialSecurityDebtsValue – numberOfDebtsWithFgts – totalNonSocialSecurityDebtsValue – exportTo properties: id: type: string maxLength: 255 description: CNPJ da Empresa companyCnpj: type: string maxLength: 255 description: CNPJ da Empresa companyName: type: string maxLength: 255 description: Nome da Empresa companyType: type: string allOf: – #/definitions/companyTypeEnum description: Tipo da Empresa localizationState: type: string maxLength: 255 description: Sigla do Estado localizationCity: type: string maxLength: 255 description: Cidade localizationLatitude: type: number format: double description: Latitude localizationLongitude: type: number format: double description: Longitude companyCnaeMainActivity: type: string maxLength: 255 description: Id da Subclasse do CNAE companyShareCapitalValue: type: string description: Capital Social totalDebtsValue: type: string description: Valor Total de Dívidas com a União totalSocialSecurityDebtsValue: type: string description: Valor Total de Dívidas Previdenciárias numberOfDebtsWithFgts: type: integer format: int64 description: Número de Dívidas com FGTS totalNonSocialSecurityDebtsValue: type: string description: Valor Total de Dívidas Não Previdenciárias exportTo: type: array items: type: string allOf: – #/definitions/externalSystemEnum minimum: 1 description: Exportado para partnerRecord: description: Sócio da Empresa type: object required: – name – qualification properties: name: type: string maxLength: 255 description: Nome qualification: type: string maxLength: 255 description: Qualificação listCompaniesCnaeRecord: description: Record referente ao retorno da query listCompaniesCnae type: object required: – cnpj – cnaes properties: cnpj: type: string maxLength: 255 description: CNPJ cnaes: type: array items: type: object allOf: – #/definitions/cnaeRecord minimum: 1 description: Cnaes cnaeRecord: description: CNAE da Empresa type: object required: – main – id – name properties: main: type: boolean description: É primário id: type: integer format: int64 description: Id name: type: string maxLength: 255 description: Nome companyRelationRecord: description: Empresas Relacionadas type: object required: – cnpj – name – fantasyName – companyType – city – acronymState properties: cnpj: type: string maxLength: 255 description: CNPJ name: type: string maxLength: 255 description: Nome fantasyName: type: string maxLength: 255 description: Nome fantasia companyType: type: string allOf: – #/definitions/companyTypeEnum description: Tipo da Empresa city: type: string maxLength: 255 description: Cidade acronymState: type: string maxLength: 255 description: Sigla do Estado getCompanyRecord: description: Record Detalhado da Empresa Completa type: object required: – id – revenueBusinessId – cnpj – name – fantasyName – openingDate – shareCapitalValue – legalNature – classLegalNature – segment – subSegment – employeeNumber – estimatedRevenue – isSimpleNational – dateOptedSimpleNational – dateExcludedSimpleNational – isMei – dateOptedMei – dateExcludedMei – address – addressNumber – addressDistrict – addressComplement – addressZipCode – addressState – addressCity – addressLongitude – addressLatitude – phoneNumberOne – phoneNumberDdd – email – cnaeMainActivityId – cnaeMainActivityDescription – updateDateFederalRevenue – updateDateRais – totalDebtsValue – totalSocialSecurityDebtsValue – lastSocialSecurityDebtDate – numberOfDebtsWithFgts – lastDebtWithFgtsDate – totalNonSocialSecurityDebtsValue – lastNonSocialSecurityDebtDate properties: id: type: string maxLength: 255 description: CNPJ revenueBusinessId: type: string maxLength: 255 description: Id de negócio da receita cnpj: type: string maxLength: 255 description: CNPJ name: type: string maxLength: 255 description: Nome fantasyName: type: string maxLength: 255 description: Nome openingDate: type: string format: date description: Data de Abertura shareCapitalValue: type: string description: Capital Social legalNature: type: string maxLength: 255 description: Natureza Jurídica classLegalNature: type: string maxLength: 255 description: Classe da Natureza Jurídica segment: type: string maxLength: 255 description: Segmento subSegment: type: string maxLength: 255 description: Sub Segmento employeeNumber: type: string maxLength: 255 description: Numero de Funcionários estimatedRevenue: type: string maxLength: 255 description: Receita Estimada isSimpleNational: type: boolean description: É Simples Nacional dateOptedSimpleNational: type: string format: date description: Data que a Empresa optou por ser Simples Nacional dateExcludedSimpleNational: type: string format: date description: Data que a Empresa deixou de ser Simples Nacional isMei: type: boolean description: É Mei dateOptedMei: type: string format: date description: Data que a Empresa optou por ser Mei dateExcludedMei: type: string format: date description: Data que a Empresa deixou de ser Mei companySize: type: string allOf: – #/definitions/companySizeEnum description: Porte da Empresa address: type: string maxLength: 255 description: Endereço addressNumber: type: string maxLength: 255 description: Número do Endereço addressDistrict: type: string maxLength: 255 description: Bairro do Endereço addressComplement: type: string maxLength: 255 description: Complemento da Endereço addressZipCode: type: string maxLength: 255 description: CEP do Endereço addressState: type: string maxLength: 255 description: Estado do Endereço addressCity: type: string maxLength: 255 description: Cidade do Endereço addressLongitude: type: number format: double description: Longitude do Endereço addressLatitude: type: number format: double description: Latitude do Endereço phoneNumberOne: type: string maxLength: 255 description: Telefone(1) phoneNumberDdd: type: string maxLength: 255 description: DDD do Telefone email: type: string maxLength: 255 description: Email cnaeMainActivityId: type: string maxLength: 255 description: Id do Cnae da Atividade Principal cnaeMainActivityDescription: type: string maxLength: 255 description: Descrição do Cnae da Atividade Principal updateDateFederalRevenue: type: string format: date-time description: Data de Atualização na Receita Federal updateDateRais: type: string format: date-time description: Data de Atualização no RAIS totalDebtsValue: type: string description: Valor Total de Dívidas com a União totalSocialSecurityDebtsValue: type: string description: Valor Total de Dívidas Previdenciárias lastSocialSecurityDebtDate: type: string format: date description: Data de Inscrição da Última Dívida Previdenciária numberOfDebtsWithFgts: type: integer format: int64 description: Número de Dívidas com FGTS lastDebtWithFgtsDate: type: string format: date description: Data de Inscrição da Última Dívida com FGTS totalNonSocialSecurityDebtsValue: type: string description: Valor Total de Dívidas Não Previdenciárias lastNonSocialSecurityDebtDate: type: string format: date description: Data de Inscrição da Última Dívida Não Previdenciária notifyUserEventPayload: description: Represents a regular user event notification payload discriminator: _discriminator type: object required: – notificationKind – notificationPriority – notificationSubject – notificationContent – sourceDomain – sourceService – destinationUser – _discriminator properties: notificationClass: type: string maxLength: 255 description: Class of notification notificationOrigin: type: string maxLength: 255 description: Origin of notification. Free text. Optional. notificationKind: type: string allOf: – #/definitions/userNotificationKind description: Notification kind. notificationPriority: type: string allOf: – #/definitions/userNotificationPriority description: Notification priority. notificationSubject: type: string maxLength: 255 description: Notification subject. notificationContent: type: string maxLength: 255 description: Notification content. sourceDomain: type: string maxLength: 255 description: Domain that generates the notification. sourceService: type: string maxLength: 255 description: Service that generates the notification. destinationUser: type: string maxLength: 255 description: Username of the destination user. link: type: string maxLength: 255 description: Notification link _discriminator: type: string maxLength: 255 description: emailNotifyUserEventPayload: description: Represents an email notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – from properties: from: type: string maxLength: 255 description: Email sender address sendTo: type: array items: type: string maxLength: 255 description: Additional recipients to send the email to format: type: string allOf: – #/definitions/eventEmailFormat description: Email format pushNotifyUserEventPayload: description: Represents a push notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – applicationId properties: applicationId: type: string maxLength: 255 description: Apple/Google application id blobReference: description: Default blob reference type. Every service defines its own. type: object required: – targetObjectId properties: domainName: type: string maxLength: 255 description: The domain the blob belongs to. serviceName: type: string maxLength: 255 description: The service the blob belongs to. targetObjectId: type: string maxLength: 255 description: The basic id of the blob. targetCopyId: type: string maxLength: 255 description: The id of the blob copy. basicErrorPayload: description: Default error payload type. Every service defines its own. type: object properties: message: type: string maxLength: 255 description: The user-facing error message, if any. errorCode: type: string maxLength: 255 description: The program-accessible (and service-specific) error code. dependency: description: Represents a service dependency type: object required: – domain – service – version properties: domain: type: string maxLength: 255 description: Domain of the dependency service service: type: string maxLength: 255 description: Name of the dependency service type: string maxLength: 255 description: Version of the dependency service genericError: properties: message: type: string description: Messaging describing the error. reason: type: string description: A symbolic code identifying the category of the reason of the error. enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE