---
title: "Atualizar onboarding"
method: PATCH
path: "/clients/{onboarding_id}"
---

# Atualizar onboarding

`PATCH /clients/{onboarding_id}`

Atualiza uma solicitação de cadastro.

## Path parameters

- `onboarding_id` string, required

## Request body

- object
  - `name` string — Nome fantasia da empresa.
  - `companyName` string — Razão social da empresa.
  - `legalNature` 'LTDA' | 'EIRELI' | 'ME' | 'Associação' | 'Cooperativa' | 'MEI' | 'SA' | 'Outros' — Natureza legal da empresa.
  - `commercialPhone` string — Telefone comercial da empresa.
  - `email` string — E-Mail da empresa.
  - `nire` string — Nire da empresa.
  - `address` object — Endereço da empresa.
    - `street` string, required — Rua do endereço da empresa.
    - `number` string, required — Número do endereço da empresa.
    - `complement` string — Complemento do endereço da empresa.
    - `neighborhood` string, required — Bairro do endereço da empresa.
    - `city` string, required — Cidade do endereço da empresa.
    - `state` string, required — Estado do endereço da empresa.
    - `country` string, required — País do endereço da empresa. (código ALPHA-02).
    - `zipCode` string, required — CEP do endereço da empresa.
    - `proof` object — Comprovante de endereço.
      - `filename` string, required — Nome do arquivo (com extensão).
      - `content` string, required — Conteúdo do arquivo em Base64.
  - `administrator` object — Informações do administrador.
    - `name` string, required
    - `email` string, required
    - `phone` string, required
    - `documentNumber` string, required
    - `identityDocument` object — Documento de identificação.
      - `filename` string, required — Nome do arquivo (com extensão),
      - `content` string, required — Conteúdo do arquivo em Base64.
  - `articleOfAssociation` object — Contrato social ou estatuto social.
    - `filename` string, required — Nome do arquivo.
    - `content` string, required — Conteúdo do arquivo em Base64.
  - `corporateStructureEvidence` object — Comprovante de estrutura societária (Obrigatório para empresas do tipo S.A.).
    - `filename` string, required — Nome do arquivo (com extensão)
    - `content` string, required — Conteúdo do arquivo em Base64.
  - `boardOfDirectorsElectionDocument` object — Ata de eleição da diretoria (Obrigatório para empresas do tipo S.A.).
    - `filename` string, required — Nome do arquivo (com extensão).
    - `content` string, required — Conteúdo do arquivo em Base64
  - `simplifiedCommercialCertificate` object — Certidão da junta comercial
    - `filename` string, required — Nome do arquivo (com extensão)
    - `content` string, required — Conteúdo do arquivo em Base64
  - `revenue` object — Informações sobre o faturamento
    - `informed` boolean, required — Indica se o faturamento foi informado. (true ou false).
    - `value` string, required — Valor do faturamento.
    - `periodStartAt` string, date, required — Data inicial do período de faturamento.
    - `periodEndAt` string, required — Data final do período de faturamento.
    - `billingEvidence` object — Comprovante de faturamento.
      - `filename` string, required — Nome do arquivo (com extensão).
      - `content` string, required — Conteúdo do arquivo em Base64.
    - `taxRegime` 'national_simple' | 'presumed_profit' | 'real_profit' — Regime tributário da empresa.
  - `extraAttachments` object[] — Documentos comprobatórios extras.
    - `filename` string, required — Nome do arquivo (com extensão).
    - `content` string, required — Conteúdo do arquivo em Base64.
  - `requiredSigners` integer — Quantidade de assinaturas necessárias para representação ativa e passiva da sociedade

## Response `200`

200

- object
  - `data` object
    - `id` string
    - `type` string
    - `attributes` object
      - `status` string
      - `documentNumber` string
      - `legalNature` string
      - `nire` string
      - `name` string
      - `companyName` string
      - `email` string
      - `commercialPhone` string
      - `requiredSigners` integer
      - `createdAt` string
      - `updatedAt` string
      - `articleOfAssociation` object
        - `data` object
          - `id` string
          - `type` string
          - `attributes` object
            - `filename` string
            - `content` string
      - `corporateStructureEvidence` unknown
      - `boardOfDirectorsElectionDocument` unknown
      - `simplifiedCommercialCertificate` unknown
      - `extraAttachments` unknown
      - `administrator` object
        - `data` object
          - `id` string
          - `type` string
          - `attributes` object
            - `documentNumber` string
            - `name` string
            - `email` string
            - `phone` string
            - `identityDocument` object
              - …
      - `revenue` object
        - `data` object
          - `id` unknown
          - `type` string
          - `attributes` object
            - `informed` boolean
            - `value` string
            - `periodStartAt` string
            - `periodEndAt` string
            - `billingEvidence` object
              - …
      - `address` object
        - `data` object
          - `id` unknown
          - `type` string
          - `attributes` object
            - `zipCode` string
            - `street` string
            - `number` string
            - `complement` string
            - `country` string
            - `state` string
            - `city` string
            - `neighborhood` string

## Other responses

- `422` — 422

---

[API](https://skmtc.net/grafeno/apis/api-v2-grafeno.md) · [All operations](https://skmtc.net/grafeno/apis/api-v2-grafeno/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/grafeno/api-v2-grafeno/versions/20f928f6933f/schema)