v1

latestOpenAPI 3.0.12026-07-26254581767.1 KB

Clientes

Cadastra um cliente no BS2.

post/pj/apibanking/forintegration/v1/onboarding/parceiros/clientes/cadastrar

Request body

cpfstring required

Descrição: CPF do Cliente

MaxLength: 14

Campo Obrigatório

apelidostring nullable

Descrição: Apelido do Cliente

MaxLength: 100

nomeCompletostring required

Descrição: Nome Completo do Cliente

MaxLength: 300

Campo Obrigatório

nomeMaestring required

Descrição: Nome da Mãe do Cliente

MaxLength: 300

Campo Obrigatório

dataNascimentostring date required

Descrição: Data de Nascimento do Cliente no formato: 'AAAA-MM-DD'

Campo Obrigatório

nacionalidadestring required

Descrição: Nacionalidade do Cliente

MaxLength: 100

Campo Obrigatório

naturalidadeUFstring nullable

Descrição: Estado referente a Nacionalidade do Cliente

MaxLength: 2

Campo Obrigatório se Nacionalidade for Brasileiro

naturalidadestring nullable

Descrição: Cidade referente a Nacionalidade do Cliente

MaxLength: 100

Campo Obrigatório se Nacionalidade for "Brasileiro"

usPersonboolean

Descrição: Para casos em que o cliente possua cidadania americana, informar "true"

emailstring required

Descrição: E-mail do Cliente

MaxLength: 300

Campo Obrigatório

tipDocumento'RG' | 'CNH'

Descrição: Tipo do documento do cliente

numeroDocumentostring nullable

Descrição: Número do documento CNH ou RG

MaxLength: 50

orgaoExpedidorstring required

Descrição: Orgao Expedidor se CNH ou RG

MaxLength: 30

Campo Obrigatório

dataExpedicaostring date required

Descrição: Data de emissão se RG ou CNH no formato: 'AAAA-MM-DD'

Campo Obrigatório

ufExpedicaostring required

Descrição: Estado de emissão se CNH ou RG

MaxLength: 2

Campo Obrigatório

cepstring required

Descrição: CEP do Cliente

MaxLength: 8

Campo Obrigatório

logradourostring required

Descrição: Endereço do Cliente

MaxLength: 300

Campo Obrigatório

numerointeger nullable

Descrição: Número do Endereço do Cliente

MaxLength: 300

Campo Obrigatório

complementostring nullable

Descrição: Complemento do Endereço do Cliente

MaxLength: 20

bairrostring required

Descrição: Bairro do Endereço do Cliente

MaxLength: 100

Campo obrigatório

cidadestring required

Descrição: Cidade do Endereço do Cliente

MaxLength: 100

Campo Obrigatório

ufstring required

Descrição: Estado do Endereço do Cliente

MaxLength: 2

Campo Obrigatório

ddistring required

Descrição: DDI do Telefone do Cliente

MaxLength: 4

Campo Obrigatório

dddstring required

Descrição: DDD do Telefone do Cliente

MaxLength: 3

Campo Obrigatório

telefoneinteger required

Descrição: Telefone Celular do Cliente

Campo Obrigatório

trabalhaboolean required

Descrição: Se trabalha true para sim ou false para não

Campo Obrigatório

profissaostring required

Descrição: Categoria profissional na qual o Cliente se enquadra, seguindo padrão de classificação

MaxLength: 300

Campo Obrigatório

renda'TresMil' | 'SeisMil' | 'DezMil' | 'VinteMil' | 'AcimaVinteMil' required

Faixa de renda do Cliente

Campo Obrigatório

Example request

{
  "cpf": "60656566769",
  "dataNascimento": "2024-10-08",
  "nacionalidade": "Brasil",
  "naturalidadeUF": "RJ",
  "naturalidade": "Rio de Janeiro",
  "email": "exemplo@exemplo.com",
  "tipDocumento": "RG, RNE ou CNH",
  "numeroDocumento": "451236781",
  "orgaoExpedidor": "DETRAN",
  "dataExpedicao": "2024-10-08",
  "ufExpedicao": "BA",
  "cep": "20900500",
  "bairro": "Barra",
  "cidade": "Salvador",
  "uf": "BA",
  "ddi": "55",
  "ddd": "71",
  "telefone": 989998999,
  "profissao": "Agente de Bolsa de Valores, câmbio e outros serviços financeiros",
  "renda": "TresMil = Entre R$ 0 e R$ 3 mil"
}

Response

idstring uuid nullable