> ## Documentation Index
> Fetch the complete documentation index at: https://docs.exact.ws/llms.txt
> Use this file to discover all available pages before exploring further.

# Enriquecer empresa (status)

> Obtém o status de um workflow de enriquecimento de empresas.



## OpenAPI

````yaml enrichments-openapi get /enrichments/company/{workflow_id}
openapi: 3.1.0
info:
  title: Searching API
  version: 0.1.0
servers:
  - url: https://exact.ws
security:
  - Bearer: []
paths:
  /enrichments/company/{workflow_id}:
    get:
      summary: Enriquecer empresa (status)
      description: Obtém o status de um workflow de enriquecimento de empresas.
      operationId: EnrichmentsCompanyWorkflowIdEnrichCompanyStatus
      parameters:
        - name: workflow_id
          in: path
          schema:
            type: string
          required: true
          deprecated: false
      responses:
        '200':
          description: Request fulfilled, document follows
          headers: {}
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: >-
                      #/components/schemas/CompletedWorkflow_EnrichCompanyOutput_
                  - $ref: '#/components/schemas/RunningWorkflow'
                  - $ref: '#/components/schemas/FailedWorkflow'
        '400':
          description: Bad request syntax or unsupported method
          content:
            application/json:
              schema:
                properties:
                  status_code:
                    type: integer
                  detail:
                    type: string
                  extra:
                    additionalProperties: {}
                    type:
                      - 'null'
                      - object
                      - array
                type: object
                required:
                  - detail
                  - status_code
                description: Validation Exception
                examples:
                  - status_code: 400
                    detail: Bad Request
                    extra: {}
      deprecated: false
components:
  schemas:
    CompletedWorkflow_EnrichCompanyOutput_:
      properties:
        id:
          type: string
        status:
          type: string
          const: COMPLETED
          description: Situação do workflow (completo)
          default: COMPLETED
        data:
          $ref: '#/components/schemas/EnrichCompanyOutput'
      type: object
      required:
        - data
        - id
      title: CompletedWorkflow[EnrichCompanyOutput]
    RunningWorkflow:
      properties:
        id:
          type: string
        status:
          type: string
          const: RUNNING
          description: Situação do workflow (em execução)
          default: RUNNING
      type: object
      required:
        - id
      title: RunningWorkflow
    FailedWorkflow:
      properties:
        id:
          type: string
        status:
          type: string
          const: FAILED
          description: Situação do workflow (falha)
          default: FAILED
      type: object
      required:
        - id
      title: FailedWorkflow
    EnrichCompanyOutput:
      properties:
        last_updated_at:
          oneOf:
            - type: string
              format: date-time
            - type: 'null'
          description: >-
            A data/hora em que estes dados foram obtidos, no formato
            especificado pela RFC 3339 (e.g. `2017-07-21T17:32:28Z`)
        id:
          type: string
          description: CNPJ da empresa
        company_name:
          type: string
          description: Razão social
        trade_name:
          oneOf:
            - type: string
            - type: 'null'
          description: Nome fantasia
        nick_name:
          oneOf:
            - type: string
            - type: 'null'
          description: Apelido
        about:
          oneOf:
            - type: string
            - type: 'null'
          description: Informações sobre a empresa
        started_at:
          type: string
          format: date
          description: Data de fundação da empresa
        main_activity:
          type: string
          description: Código da principal atividade econômica da empresa (CNAE)
        secondary_activities:
          items:
            type: string
          type: array
          description: Códigos de atividades econômicas secundárias da empresa (CNAE)
          default: []
        size:
          $ref: '#/components/schemas/CompanySize'
        street:
          oneOf:
            - type: string
            - type: 'null'
          description: Logradouro
        street_type:
          oneOf:
            - type: string
            - type: 'null'
          description: Tipo de logradouro
        number:
          oneOf:
            - type: string
            - type: 'null'
          description: Número
        district:
          oneOf:
            - type: string
            - type: 'null'
          description: Bairro
        city:
          oneOf:
            - type: string
            - type: 'null'
          description: Cidade
        state:
          oneOf:
            - type: string
            - type: 'null'
          description: Estado (UF)
        zipcode:
          oneOf:
            - type: string
            - type: 'null'
          description: CEP
        domain_name:
          oneOf:
            - type: string
            - type: 'null'
          description: Domínio principal da empresa na internet
        site:
          oneOf:
            - type: string
            - type: 'null'
          description: Site da empresa
        phones:
          items:
            type: string
          type: array
          description: Lista de telefones para contato
          default: []
        emails:
          items:
            type: string
          type: array
          description: Emails empresariais identificados
          default: []
        share_capital:
          type: number
          description: Capital social
          default: 0
        active:
          type: boolean
          description: Situação cadastral da empresa na Receita Federal
          default: true
        headquarters:
          type: boolean
          description: É estabelecimento matriz
          default: true
        simples:
          type: boolean
          description: É optante pelo simples
          default: false
        mei:
          type: boolean
          description: É microempreendedor individual
          default: false
        profiles:
          items:
            $ref: '#/components/schemas/Profile'
          type: array
          description: Perfis em redes sociais
          default: []
        domains:
          items:
            $ref: '#/components/schemas/Domain'
          type: array
          description: Informações sobre domínios associados a empresa
          default: []
        partners:
          items:
            $ref: '#/components/schemas/CompanyPartner'
          type: array
          description: Quadro societário
          default: []
      type: object
      required:
        - company_name
        - id
        - main_activity
        - started_at
      title: EnrichCompanyOutput
      description: Resultado da execução do workflow
    CompanySize:
      type: string
      enum:
        - UNKNOWN
        - MICRO
        - EPP
        - OTHER
      title: CompanySize
    Profile:
      properties:
        platform:
          $ref: '#/components/schemas/Platform'
        url:
          type: string
          description: Link para o perfil
      type: object
      required:
        - platform
        - url
      title: Profile
    Domain:
      properties:
        name:
          type: string
          description: Nome do domínio
        registrant_contact:
          oneOf:
            - $ref: '#/components/schemas/DomainContact'
            - type: 'null'
          description: Contato do registrante
        administrative_contact:
          oneOf:
            - $ref: '#/components/schemas/DomainContact'
            - type: 'null'
          description: Contato administrativo
        technical_contact:
          oneOf:
            - $ref: '#/components/schemas/DomainContact'
            - type: 'null'
          description: Contato técnico
        name_servers:
          items:
            type: string
          type: array
          description: Name servers
          default: []
        domain_status:
          items:
            type: string
          type: array
          description: Situação do domínio
          default: []
        mail_server:
          $ref: '#/components/schemas/DomainMailServer'
      type: object
      required:
        - mail_server
        - name
      title: Domain
    CompanyPartner:
      properties:
        name:
          type: string
          description: Nome do sócio
        type:
          $ref: '#/components/schemas/CompanyPartnerType'
      type: object
      required:
        - name
      title: CompanyPartner
    Platform:
      type: string
      enum:
        - FACEBOOK
        - INSTAGRAM
        - GITHUB
        - LINKEDIN
        - X
        - YOUTUBE
      title: Platform
    DomainContact:
      properties:
        full_name:
          oneOf:
            - type: string
            - type: 'null'
          description: Nome completo
        company:
          oneOf:
            - type: string
            - type: 'null'
          description: Razão social da empresa
        email_address:
          oneOf:
            - type: string
            - type: 'null'
          description: Endereço de email
        phone_number:
          oneOf:
            - type: string
            - type: 'null'
          description: Telefone para contato
        mailing_address:
          oneOf:
            - type: string
            - type: 'null'
          description: Endereço para correspondências
        city:
          oneOf:
            - type: string
            - type: 'null'
          description: Cidade
        state:
          oneOf:
            - type: string
            - type: 'null'
          description: Estado (UF)
        zip_code:
          oneOf:
            - type: string
            - type: 'null'
          description: CEP
        country_code:
          oneOf:
            - type: string
            - type: 'null'
          description: País
      type: object
      required: []
      title: DomainContact
    DomainMailServer:
      properties:
        mx_record:
          oneOf:
            - type: string
            - type: 'null'
          description: Endereço do servidor de emails
        is_smtp_enabled:
          type: boolean
          description: Se existe um servidor de emails ativo para o domínio
          default: false
        is_catch_all:
          type: boolean
          description: >-
            Se o servidor de emails aceita mensagens para endereços de email que
            não existem
          default: false
        is_free:
          type: boolean
          description: Se o servidor de emails é gratuito
          default: false
        is_disposable:
          type: boolean
          description: Se os endereços de email deste servidor são temporários
          default: false
      type: object
      required: []
      title: DomainMailServer
      description: Situação do servidor de emails
    CompanyPartnerType:
      type: string
      enum:
        - LEGAL_ENTITY
        - PERSON
        - FOREIGN_ENTITY
      title: CompanyPartnerType
  securitySchemes:
    Bearer:
      type: http
      scheme: bearer

````