v1

latestOpenAPI 3.1.02026-07-24890394.2 KB

Criar sócio - PF

Cria um novo sócio do tipo de Pessoa Física (PF) para o processo de onboarding.

post/clients/{onboarding_id}/partners/people

Path parameters

onboarding_idstring required

Id da solicitação de cadastro.

Request body

namestring required

Nome completo do sócio.

emailstring required

E-mail do sócio.

birthDatestring required

Data de nascimento.

maritalStatusstring required

Estado civil.

phonestring required

Telefone.

documentNumberstring required

CPF.

identityDocumentNumberstring required

Número do RG ou RNE.

identityDocumentIssuingAgencystring

Órgão expedidor do RG ou RNE.

nationalitystring required

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

parentCompanyIdstring

ID da empresa-mãe. Se preenchido com "0", a empresa principal será considerada como a empresa-mãe deste sócio pessoa física.

shareCapitalnumber double

Quotas.

sharePercentnumber double required

Percentual de participação.

administrator'True' | 'False'

Representante legal.

representation'in_isolation' | 'together'

Representação.

subscriberKind'Required' | 'Participate' | 'Dont_subscribe'

Tipo de assinatura.

Response

200

Example response

{
  "data": {
    "id": "28295044-5d47-419b-a8ab-bb904bc7ce41",
    "type": "person",
    "attributes": {
      "documentNumber": "12345679891",
      "parentCompanyId": "0",
      "name": "Dwight Kurt Schrute",
      "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",
      "administrator": true,
      "representation": "in_isolation",
      "subscriberKind": "required",
      "createdAt": "2024-04-09T18:19:18.626-03:00",
      "updatedAt": "2024-04-09T18:19:18.886-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"
          }
        }
      }
    }
  }
}