Sign in

v1

latestOpenAPI 3.1.02026-07-24890394.2 KB

Atualizar onboarding

Atualiza uma solicitação de cadastro.

patch/clients/{onboarding_id}

Path parameters

onboarding_idstring required

Id da solicitação de cadastro.

Request body

namestring

Nome fantasia da empresa.

companyNamestring

Razão social da empresa.

legalNature'LTDA' | 'EIRELI' | 'ME' | 'Associação' | 'Cooperativa' | 'MEI' | 'SA' | 'Outros'

Natureza legal da empresa.

commercialPhonestring

Telefone comercial da empresa.

emailstring

E-Mail da empresa.

nirestring

Nire da empresa.

requiredSignersinteger

Quantidade de assinaturas necessárias para representação ativa e passiva da sociedade

Response

200

Example response

{
  "data": {
    "id": "1b6d7ed5-84a5-4a10-a5b3-de02b8cd7f2f",
    "type": "client",
    "attributes": {
      "status": "awaiting_onboarding",
      "documentNumber": "85632106000135",
      "legalNature": "LTDA",
      "nire": "11111111111",
      "name": "Dunder Mifflin",
      "companyName": "Dunder Mifflin Paper Company",
      "email": "corporate@dunder-mifflin.paper",
      "commercialPhone": "11988776655",
      "requiredSigners": 1,
      "createdAt": "2024-04-04T14:28:03.704-03:00",
      "updatedAt": "2024-04-04T14:28:04.352-03:00",
      "articleOfAssociation": {
        "data": {
          "id": "edc5328e-4eeb-44cb-a3c3-f61a135a1d60",
          "type": "file",
          "attributes": {
            "filename": "association.pdf",
            "content": "/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAMCAgICAgMCAgID"
          }
        }
      },
      "administrator": {
        "data": {
          "id": "12345679891",
          "type": "administrator",
          "attributes": {
            "documentNumber": "12345679891",
            "name": "Dwight Kurt Schrute",
            "email": "dwight.schrute@dunder-mifflin.paper",
            "phone": "11988776655",
            "identityDocument": {
              "data": {
                "id": "b9d6304e-2bcb-4dd1-a41a-1e6c9c7bf5b4",
                "type": "file",
                "attributes": {
                  "filename": "administrator.pdf",
                  "content": "/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAMCAgICAgMCAgID"
                }
              }
            }
          }
        }
      },
      "revenue": {
        "data": {
          "type": "revenue",
          "attributes": {
            "informed": true,
            "value": "9188338.54",
            "periodStartAt": "2021-10-01T00:00:00.000-03:00",
            "periodEndAt": "2022-09-30T00:00:00.000-03:00",
            "billingEvidence": {
              "data": {
                "id": "8ff69a93-f858-4a9c-9cd0-909782b39c0a",
                "type": "file",
                "attributes": {
                  "filename": "revenue.pdf",
                  "content": "/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAMCAgICAgMCAgID"
                }
              }
            }
          }
        }
      },
      "address": {
        "data": {
          "type": "address",
          "attributes": {
            "zipCode": "01230000",
            "street": "Rua Doutor Albuquerque Lins",
            "number": "111",
            "complement": "APT 222",
            "country": "BR",
            "state": "SP",
            "city": "SÃO PAULO",
            "neighborhood": "SANTA CECÍLIA"
          }
        }
      }
    }
  }
}