API's
InstitucionalBlogService DeskStatus Page

Registro de pessoa física

put
https://api-mtls.sandbox.bankly.com.br/customers/

Registre um cliente pessoa física. Se os dados informados já existirem, eles serão sobrepostos.
Após o registro, as informações serão analisadas e você poderá obter o resultado dessa análise por meio do endpoint Consulta do registro do cliente.

stable scope: customer.write
[block:callout] { "type": "warning", "title": "Importante", "body": "Os possíveis status do cliente após essa análise são: PENDING_APPROVAL, APPROVED, IN_ANALYSIS, REPROVED e BLACKLISTED. Para mais informações, consulte a documentação [Onboarding de pessoa física](/docs/onboarding-completo)." } [/block]
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
length between 11 and 11

Número do documento CPF do cliente pessoa física ou representante legal da empresa. Informe somente números.

Body Params
string
required
length between 1 and 256

Nome completo conforme consta no documento de identificação (RG, CNH, RNE, DNI ou CRNM) do cliente. Sem abreviações.

string | null

Nome pelo qual a pessoa gostaria de ser chamada. Saiba mais consultando a Cartilha do nome social.

date-time
required
length between 10 and 10

Data de nascimento do cliente.

phone
object
required

Objeto onde devem ser informados os dados do telefone do cliente.

address
object
required

Objeto onde devem ser informados os dados do endereço do cliente.

string
enum

Faixa de renda declarada pelo cliente. Campo obsoleto em produção a partir do dia 27/11/2023. Deve ser substituído pelo objeto assertedIncome.

Allowed:
assertedIncome
object
required

Objeto que deverá conter os dados da renda do cliente.

string
enum
required

Código de ocupação do cliente. Para conhecer a descrição dos códigos das ocupações, consulte a documentação Código de ocupação do cliente.
Importante: deve-se enviar somente o código. Caso o cliente possua mais de uma ocupação, esse campo deve ser preenchido com a sua principal fonte de renda.

pep
object
required

Objeto onde deve ser informado o nível de exposição política do cliente.

string | null
required

Nome completo da mãe do cliente conforme consta no documento de identificação. Sem abreviações.

string
required
length between 1 and 256

Endereço de e-mail.

documentation
object
required

Objeto onde devem ser informadas as referências dos documentos enviados para análise.

Headers
string
required
Defaults to 1

Versão da API. Atualmente estamos na 1.0.

string
required

Token de autorização do tipo Bearer.

Responses

Updated 3 days ago

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

Updated 3 days ago

Copyright © 2021 Acesso Soluções de Pagamento S.A - Todos os direitos reservados