Sign in

v1

latestOpenAPI 3.0.12026-07-245303882.5 MB
NaturalPerson

Cria uma nova proposta de criação de conta Pessoa Física.

post/onboarding-proposal/natural-person

Request body

clientCodestring required

Identificador único fornecido pelo cliente. Esse valor não pode ser repetido.

documentNumberstring required

Número do CPF da conta.

phoneNumberstring required

Número telefone contato do titular da conta.

emailstring required

E-mail do titular da conta.

motherNamestring required

Nome mãe do titular da conta.

fullNamestring required

Nome completo do titular da conta.

socialNamestring nullable

Nome social do titular da conta.

birthDatestring required

Data de nascimento do titular da conta.

isPoliticallyExposedPersonboolean

Campo que identifica se o titular da conta é pessoa politicamente exposta.

onboardingTypestring required

Tipo de Onboarding:

  • Se BAAS: Sera criada uma proposta de pessoa física para criar conta no BAAS

Example request

{
  "clientCode": "123456",
  "documentNumber": "33333333333",
  "phoneNumber": "+5512981175554",
  "email": "email@email.com",
  "motherName": "Nome Sobrenome",
  "fullName": "Nome Sobrenome",
  "socialName": "Carlos",
  "birthDate": "31-12-1984",
  "address": {
    "postalCode": "12211400",
    "street": "Rua da Liberdade",
    "number": "313",
    "addressComplement": "Em frente ao parque.",
    "neighborhood": "Casa Verde",
    "city": "São Paulo",
    "state": "SP"
  },
  "onboardingType": "BAAS"
}

Response

OK

versionstring nullable

Versão da api.

statusstring nullable

Status da solicitação.

Example response

{
  "version": "1.0.0",
  "status": "SUCCESS",
  "body": {
    "proposalId": "12334dfb-4c4e-43fb-ad93-fa28e3123473",
    "clientCode": "1234ab7c-2855-436b-9d19-8abcdc198e984",
    "documentNumber": "12345678900"
  }
}