v1

latestOpenAPI 3.1.02026-07-24890394.2 KB

Atualizar sócio - PF

Permite a atualização de dados do sócio PF de determinado onboarding.

patch/clients/{onboarding_id}/partners/people/{id}

Path parameters

onboarding_idstring required

Id da solicitação de cadastro.

partner_idstring required

Id do sócio PF.

Request body

namestring

Nome completo

emailstring

E-Mail.

phonestring

Telefone

birthDatestring

Data de nascimento

maritalStatusstring

Estado civil

nationalitystring

Código alpha-2 do país de origem

identityDocumentNumberstring

Número do RG ou RNE

identityDocumentIssuingAgencystring

Órgão expedidor do RG ou RNE

parentCompanyIdstring

ID da empresa mãe. Se for preenchido com "0", a empresa principal será considerada como a empresa pai deste sócio PF.

sharePercentstring

Percentual de participação na empresa.

shareCapitalnumber double

Total de quotas de participação na empresa.

Response

200

Example response

{
  "data": {
    "id": "28295044-5d47-419b-a8ab-bb904bc7ce41",
    "type": "person",
    "attributes": {
      "name": "Dwight K Schrute",
      "parentCompanyId": "0",
      "birthDate": "1999-09-09",
      "nationality": "BR",
      "identityDocumentNumber": "123456789012",
      "identityDocumentIssuingAgency": "ssp",
      "maritalStatus": "single",
      "email": "dwight.schrute@gmail.com",
      "phone": "11988776655",
      "shareCapital": "95.5",
      "sharePercent": "100.0",
      "createdAt": "2024-04-09T18:19:18.626-03:00",
      "updatedAt": "2024-04-09T18:50:48.518-03:00",
      "identityDocument": {
        "data": {
          "id": "2db1a731-3456-4fc1-9a2d-3e5eebbe05ce",
          "type": "file",
          "attributes": {
            "filename": "identity-document.pdf",
            "content": "/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAMCAgICAgMCAgID"
          }
        }
      },
      "pep": {
        "data": {
          "type": "shared",
          "attributes": {
            "kind": "none"
          }
        }
      },
      "address": {
        "data": {
          "type": "address",
          "attributes": {
            "zipCode": "01452002",
            "street": "AV BRIG FARIA LIMA",
            "number": "1355",
            "complement": "ANDAR 15 SALA 5",
            "country": "BR",
            "state": "SP",
            "city": "SÃO PAULO",
            "neighborhood": "JARDIM PAULISTANO"
          }
        }
      }
    }
  }
}