Registro de pessoa física

Este endpoint permite realizar o registro de clientes do tipo pessoa física.

Pré-requisito

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 aprovadas.

Requisição

Requisição HTTP

PUT https://api-mtls.sandbox.bankly.com.br/customers/{documentNumber}

curl --request PUT \
--url 'https://api-mtls.sandbox.bankly.com.br/customers/47742663023' \
--header 'api-version: 1' \
--header 'Authorization: Bearer {{accessToken}}' \
--header 'Content-Type: application/json' \
--header 'x-bkly-license: 24ac71da-4309-4348-9cc0-a0c88f867993' \
--data-raw '{
    "registerName": "Nísia Floresta",
    "socialName": "Nísia Floresta",
    "birthDate": "1810-10-12",
    "phone": {
        "countryCode": "55",
        "number": "23415162342"
    },
    "address": {
        "zipcode": "68060100",
        "addressLine": "Rua 6 de Março",
        "buildingNumber": "2500",
        "neighborhood": "Alter do Chão",
        "country": "BR",
        "state": "PA",
        "city": "Santarém",
        "complement": ""
    },
    "declaredIncome": "LESS_THAN_ONE_THOUSAND",
    "assertedIncome": {
        "currency": "BRL",
        "value": 500000
  	},
    "occupation": "OCP0082",
    "pep": {
        "level": "NONE" 
    },
    "motherName": "Dionísia Gonçalves Pinto",
    "email": "[email protected]",
    "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:

Cabeçalhos (Headers)

Parâmetros da rota (Path)

No path desta requisição envie o seguinte campo:

Corpo da requisição (Body)

No body, envie os seguintes campos em formato JSON:

{
  "registerName": "Nísia Floresta",
  "socialName": "Nísia Floresta",
  "birthDate": "1810-10-12",
  "phone": {
    "countryCode": "55",
    "number": "23415162342"
  },
  "address": {
    "zipcode": "68060100",
    "addressLine": "Rua 6 de Março",
    "buildingNumber": "2500",
    "neighborhood": "Alter do Chão",
    "country": "BR",
    "state": "PA",
    "city": "Santarém",
    "complement": ""
  },
  "assertedIncome": {
    "currency": "BRL",
    "value": 500000
  },
  "occupation": "OCP0082",
  "pep": {
    "level": "NONE" 
  },
  "motherName": "Dionísia Gonçalves Pinto",
  "email": "[email protected]",
  "documentation": {
    "selfie": "ce1849509a3f4625867ead5768d5b068",
    "idCardFront": "9c1974193d96446e84833742aed1db62",
    "idCardBack": "71bb6d35ee7644fe8ef2b8e81eb19f98"
  }
}

Países bloqueados para Onboarding

Reafirmando o compromisso do Bankly com a segurança, prevenção à lavagem de dinheiro e combate ao terrorismo, vetamos o registro de clientes cujos DDIs sejam provenientes dos países listados abaixo:

\

Faixa de renda declarada

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.

👍

Dica

Para 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:

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. Os eventos são: