Registro de pessoa física (menor de idade)
beta
Este endpoint permite realizar o registro de clientes do tipo pessoa física menor de idade.
Pré-requisitos
Para que seja possível utilizar este endpoint, é necessário que:
- A selfie e as fotos (frente e verso) do documento tenham sido enviadas para análise por meio do endpoint Envio e análise de documentos pessoais;
- A selfie e as fotos (frente e verso) do documento tenham sido enviadas e aprovadas.
Requisição
Requisição HTTP
PUT https://api-mtls.sandbox.bankly.com.br/customers/{documentNumber}/underagecurl --request PUT \
--url 'https://api-mtls.sandbox.bankly.com.br/customers/{{documentNumber}}/underage' \
--header 'api-version: 1' \
--header 'Authorization: Bearer {{accessToken}}' \
--header 'Content-Type: application/json' \
--data-raw '{
"registerName": "Nísia Floresta",
"socialName": "Nísia Floresta",
"birthDate": "1810-10-12",
"address": {
"zipcode": "68060100",
"addressLine": "Rua 6 de Março",
"buildingNumber": "2500",
"neighborhood": "Alter do Chão",
"country": "BR",
"state": "PA",
"city": "Santarém",
"complement": ""
},
"pep": {
"level": "NONE"
},
"motherName": "Dionísia Gonçalves Pinto",
"hasBrazilianNationality": true,
"legalResponsible": {
"document": {
"value": "12346789000",
"type": "CPF""
},
"documentation": {
"selfie": "ce1849509a3f4625867ead5768d5b068",
"idCardFront": "9c1974193d96446e84833742aed1db62",
"idCardBack": "71bb6d35ee7644fe8ef2b8e81eb19f98"
}
}'Autorização
Para garantir a segurança nas requisições, todos os endpoints do Bankly utilizam scopes como parte do seu fluxo de autorização.
Esta requisição requer o scope descrito a seguir:
| Scope | Descrição |
|---|---|
customer.write | Concede acesso para criar ou atualizar o registro de um cliente pessoa física. |
Cabeçalhos (Headers)
| Nome | Descrição |
|---|---|
api-version | Obrigatório. Versão da API. Atualmente estamos na versão 1.0. |
Authorization | Obrigatório. Token de autorização do tipo Bearer. |
Parâmetros da rota (Path)
No path desta requisição envie o seguinte campo:
| Nome | Tipo | Descrição | Especificação |
|---|---|---|---|
documentNumber | path | Obrigatório. Número do documento CPF do cliente. | Informe somente números. |
Corpo da requisição (Body)
No body, envie os seguintes campos em formato JSON:
| Nome | Tipo | Descrição | Especificação |
|---|---|---|---|
registerName | string | Obrigatório. Nome conforme consta no documento de identificação (RG, CNH, RNE, DNI ou CRNM) do cliente. | Informe o nome completo, sem abreviações |
socialName | string | Nome pelo qual a pessoa gostaria de ser chamada. Saiba mais consultando a Cartilha do nome social. | — |
birthDate | string | Obrigatório. Data de nascimento do cliente. | Formato YYYY-MM-DD |
address | object | Objeto onde devem ser informados os dados do endereço do cliente. | — |
address.zipCode | string | Código postal do endereço. | — |
address.addressLine | string | Logradouro (Nome da rua, avenida etc.). | Máximo de 256 caracteres. |
address.buildingNumber | string | Número do imóvel com até dez caracteres. Se não possuir número, substitua por S/N. | — |
address.complement | string | Complemento do endereço. Exemplo: Apto 123, Casa B etc. | — |
address.neighborhood | string | Nome do bairro ou distrito. | Máximo de 256 caracteres. |
address.city | string | Nome da cidade. | Máximo de 256 caracteres. Devem-se evitar acentos e outros caracteres especiais. |
address.state | string | Sigla do estado brasileiro conforme a ISO 3166-2:BR. Exemplo: SP. | — |
address.country | string | Sigla do país (Brasil) conforme a ISO 3166-2. Exemplo: BR | — |
pep | object | Objeto onde deve ser informado o nível de exposição política do cliente, atendendo à Circular nº 3.978. | — |
pep.level | string | Nível de exposição política do cliente: "NONE" (o cliente não é e nem tem vínculo com pessoa exposta politicamente), "SELF"(o cliente é pessoa exposta politicamente) e "RELATED" (o cliente tem vínculo familiar, possui sociedade ou é estreito colaborador de pessoa exposta politicamente). | — |
motherName | string | Obrigatório. Nome da mãe do cliente como consta no documento de identidade. Também é possível incluir o nome que consta no campo "Filiação" dos documentos de identificação. | Informe o nome completo, sem abreviações |
hasBrazilianNationality | boolean | Obrigatório. Campo que informa se o cliente é brasileiro. | — |
legalResponsible | object | Obrigatório. Objeto que deve conter informações sobre o responsável legal do cliente. | — |
legalResponsible.document | object | Obrigatório. Objeto que deve conter informações sobre o documento do responsável legal. | — |
legalResponsible.document.value | string | Obrigatório. Número do documento. | — |
legalResponsible.document.type | string | Obrigatório. Tipo do documento. | — |
documentation | object | Obrigatório. Objeto onde devem ser informadas as referências dos documentos do cliente que foram enviados para análise. Essas referências são retornadas no endpoint de Envio e análise de documentos pessoais. | — |
documentation.selfie | string | Obrigatório. Token da análise da selfie. | — |
documentation.idCardFront | string | Obrigatório. Token da análise da frente do documento. | — |
documentation.idCardBack | string | Obrigatório. Token da análise do verso do documento. | — |
{
"registerName": "Nísia Floresta",
"socialName": "Nísia Floresta",
"birthDate": "1810-10-12",
"address": {
"zipcode": "68060100",
"addressLine": "Rua 6 de Março",
"buildingNumber": "2500",
"neighborhood": "Alter do Chão",
"country": "BR",
"state": "PA",
"city": "Santarém",
"complement": ""
},
"pep": {
"level": "NONE"
},
"motherName": "Dionísia Gonçalves Pinto",
"hasBrazilianNationality": true,
"legalResponsible": {
"document": {
"value": "12346789000",
"type": "CPF""
},
"documentation": {
"selfie": "ce1849509a3f4625867ead5768d5b068",
"idCardFront": "9c1974193d96446e84833742aed1db62",
"idCardBack": "71bb6d35ee7644fe8ef2b8e81eb19f98"
}
}Resposta (Response)
O status code 202 indicará que o registro do cliente foi realizado com sucesso.
Análise do registro é feita de maneira automática e pode levar até cinco minutos para ser concluída. Ao final desse processo, conheceremos o perfil do cliente e, se ele for aprovado, estará apto para ter uma conta de pagamentos Bankly.
DicaPara simular uma requisição nesse endpoint, acesse o API Reference.
Retorno em caso de reprovação
Se o registro do cliente for reprovado, será preciso realizar uma análise mais detalhada. Quando isso ocorrer, o parceiro poderá solicitar essa análise através do Service Desk do Bankly, o que poderá levar até sete dias úteis para conclusão.
O parceiro e o cliente devem aguardar o resultado dessa análise antes de tentar novamente. Veja quais podem ser os motivos de reprovação de uma análise.
É possível simular uma reprovação de registro, somente em ambiente sandbox, ao utilizar um dos seguintes documentos:
- 312.806.468-70
- 101.614.018-56
- 145.774.718-92
- 270.205.260-63
- 102.078.370-23
- 606.733.970-68
Erros
Este endpoint pode retornar erros específicos, conforme a tabela a seguir:
| Status code | Código | Mensagem | Descrição |
|---|---|---|---|
| 409 | CUSTOMER_AWAIT_EVALUATION | Customer await evaluation. | Cliente aguardando análise. |
Recordamos que esta API também poderá retornar erros comuns entre todos os endpoints. Portanto, recomendamos a consulta da documentação de erros, onde é possível encontrar as mensagens comuns em inglês que acompanham os erros 400 (se houver).
Eventos
Caso o parceiro deseje receber mensagens referentes aos eventos relacionados a esse endpoint, é preciso configurar o webhook. O evento é:
| Nome do Evento | Descrição |
|---|---|
| CUSTOMER_WAS_RECEIVED | Comunica que o cadastro foi recebido. |
| CUSTOMER_IN_ANALYSIS | Comunica que o cadastro está em análise de mesa. |
| CUSTOMER_WAS_APPROVED | Comunica que o cadastro foi aprovado. |
| CUSTOMER_WAS_REPROVED | Comunica que o cadastro foi reprovado. |
