API Reference

Cadastra um cliente no BS2.

post
https://example.com/pj/apibanking/forintegration/v1/onboarding/parceiros/clientes/cadastrar
Body Params

Body

string
required
length ≥ 1

Descrição: CPF do Cliente

MaxLength: 14

Campo Obrigatório

string | null

Descrição: Apelido do Cliente

MaxLength: 100

string
required
length ≥ 1

Descrição: Nome Completo do Cliente

MaxLength: 300

Campo Obrigatório

string
required
length ≥ 1

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

MaxLength: 300

Campo Obrigatório

date
required

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

Campo Obrigatório

string
required
length ≥ 1

Descrição: Nacionalidade do Cliente

MaxLength: 100

Campo Obrigatório

string | null

Descrição: Estado referente a Nacionalidade do Cliente

MaxLength: 2

Campo Obrigatório se Nacionalidade for Brasileiro

string | null

Descrição: Cidade referente a Nacionalidade do Cliente

MaxLength: 100

Campo Obrigatório se Nacionalidade for "Brasileiro"

boolean

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

string
required
length ≥ 1

Descrição: E-mail do Cliente

MaxLength: 300

Campo Obrigatório

string
enum

Descrição: Tipo do documento do cliente

Allowed:
string | null

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

MaxLength: 50

string
required
length ≥ 1

Descrição: Orgao Expedidor se CNH ou RG

MaxLength: 30

Campo Obrigatório

date
required

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

Campo Obrigatório

string
required
length ≥ 1

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

MaxLength: 2

Campo Obrigatório

string
required
length ≥ 1

Descrição: CEP do Cliente

MaxLength: 8

Campo Obrigatório

string
required
length ≥ 1

Descrição: Endereço do Cliente

MaxLength: 300

Campo Obrigatório

int32 | null

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

MaxLength: 300

Campo Obrigatório

string | null

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

MaxLength: 20

string
required
length ≥ 1

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

MaxLength: 100

Campo obrigatório

string
required
length ≥ 1

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

MaxLength: 100

Campo Obrigatório

string
required
length ≥ 1

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

MaxLength: 2

Campo Obrigatório

string
required
length ≥ 1

Descrição: DDI do Telefone do Cliente

MaxLength: 4

Campo Obrigatório

string
required
length ≥ 1

Descrição: DDD do Telefone do Cliente

MaxLength: 3

Campo Obrigatório

int32
required

Descrição: Telefone Celular do Cliente

Campo Obrigatório

boolean
required

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

Campo Obrigatório

string
required
length ≥ 1

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

MaxLength: 300

Campo Obrigatório

string
enum
required

Faixa de renda do Cliente

Campo Obrigatório

Allowed:
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Responses

201

O dado foi criado.

Updated about 1 month ago

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json

Updated about 1 month ago