Registro de pessoa física

Pré-requisitos

Para que seja possível utilizar este endpoint, é necessário que:

Possuir um CPF valido na Receita Federal

Requisição (Request)

Requisição HTTP

POST https://sandbox.hiperbanco.com.br/Onboarding/user/{{clientId}}

--request POST 'https://sandbox.hiperbanco.com.br/Onboarding/user/{{clientId}}' \
--header 'version: cutting-edge' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{token}}' \
--data-raw '{
  "registerName": "Juliana Costa",
  "socialName": "Juliana Costa",
  "password": "TesteFicticio123@",
  "documentNumber": "08541256325",
  "documentNumberPhoto": "987654321",
  "email": "[email protected]",
  "documentType": "RG",
  "issuerEntity": "SSP",
  "birthDate": "1995-08-15",
  "motherName": "Márcia Costa",
  "dateNumberDocumentPhoto": "2024-03-12",
  "phone": {
    "countryCode": "55",
    "number": "11985412567"
  },
  "address": {
    "zipCode": "01001-000",
    "addressLine": "Rua das Palmeiras",
    "buildingNumber": "123",
    "complement": "apto 45",
    "neighborhood": "Centro",
    "city": "São Paulo",
    "state": "SP",
    "country": "BR"
  },
  "occupation": "OCP0001",
  "pep": "NONE",
  "assertedIncome": 3500,
  "gender": "FEMININO",
  "nationality": "BRASILEIRO",
  "relationshipStatus": "SOLTEIRO",
  "education": "NAO_ALFABETIZADO",
  "agency": "0001"
}'

Cabeçalhos (Headers)

Nome	Propriedade	Descrição
version	cutting-edge	Essa propriedade garante que o response da API seja retornado no formato JSON

Parâmetros da rota (Path)

Nome	Tipo	Descrição
clientId	path	Id do cliente. (Esse ID é fornecido junto com as credenciais do cliente)

Corpo da requisição (Body)

Campo	Tipo	Descrição	Especificação
`registerName`	string	Obrigatório. Nome conforme consta no documento de identificação (RG, CNH) do cliente.	Informe o nome completo, sem abreviações. Máximo de 255 caracteres.
`socialName`	string	Nome pelo qual a pessoa gostaria de ser chamada. Saiba mais consultando a Cartilha do nome social.	Máximo de 255 caracteres.
`documentNumber`	string	Obrigatório. Número do documento do cliente (CPF).
`email`	string	Endereço de e-mail
`password`	string	Senha do usuário	Deverá conter no mínimo 8 caracteres sendo composto por letras maiúsculas, letras minúsculas, números e caractere especial
`documentNumberPhoto`	string	Número do documento que será enviado para analise (RG, CNH)
`documentType`	string	Tipo do documento (RG, CNH)
`dateNumberDocumentPhoto`	string	Data de emissão do documento com foto (yyyy-MM-dd)
`issuerEntity`	string	Órgão emissor do documento que será enviado para analise
`birthDate`	string	Obrigatório. Data de nascimento do cliente. O cliente deve ter, no mínimo, 18 anos.	Formato YYYY-MM-DD.
`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. Máximo de 255 caracteres.
`phone`	object	Obrigatório. Objeto que deverá conter informações sobre o telefone do cliente.
`phone.countryCode`	string	Obrigatório. Código DDI do país. Atente-se à lista de países bloqueados para Onboarding.
`phone.number`	string	Obrigatório. Número de telefone (celular) do cliente com DDD (deve ser um número capaz de receber SMS).
`address`	object	Obrigatório. Objeto que deverá conter informações sobre o endereço do cliente.
`address.zipCode`	string	Obrigatório. Código postal do endereço.
`address.addressLine`	string	Obrigatório. Logradouro (nome da rua, avenida etc.).	Máximo de 255 caracteres.
`address.buildingNumber`	string	Obrigatório. 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.	Máximo de 255 caracteres.
`address.neighborhood`	string	Obrigatório. Nome do bairro ou distrito.	Máximo de 255 caracteres.
`address.city`	string	Obrigatório. Nome da cidade.	Máximo de 255 caracteres. Devem-se evitar acentos e outros caracteres especiais.
`address.state`	string	Obrigatório. Sigla do estado brasileiro.	Formato ISO 3166-2:BR.
`address.country`	string	Obrigatório. Sigla do país (Brasil).	Formato ISO 3166-2:BR.
`occupation`	string	Obrigatório. Código de ocupação do cliente. Observação: caso o cliente possua mais de uma ocupação, esse campo deve ser preenchido com a sua principal fonte de renda.
`pep`	string	Obrigatório. Nível de exposição política do cliente, que pode ser "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).
`assertedIncome`	number	Obrigatório. Valor em Reais da renda declarada pelo cliente.	O valor mínimo para esse campo é de: 0.00, e o valor máximo: 99999999999999.99 (até 14 caracteres antes do ponto e até dois caracteres após o ponto).
`gender`	string	Gênero
`nationality`	string	Nacionalidade
`relationshipStatus`	string	Estado civil
`education`	string	Grau de escolaridade
`agency`	string	Código da agência	Utilizar padrão 0001

{
  "registerName": "Juliana Costa",
  "socialName": "Juliana Costa",
  "password": "TesteFicticio123@",
  "documentNumber": "08541256325",
  "documentNumberPhoto": "987654321",
  "email": "[email protected]",
  "documentType": "RG",
  "issuerEntity": "SSP/SP",
  "birthDate": "1995-08-15",
  "motherName": "Márcia Costa",
  "dateNumberDocumentPhoto": "2024-03-12",
  "phone": {
    "countryCode": "55",
    "number": "11985412567"
  },
  "address": {
    "zipCode": "01001-000",
    "addressLine": "Rua das Palmeiras",
    "buildingNumber": "123",
    "complement": "apto 45",
    "neighborhood": "Centro",
    "city": "São Paulo",
    "state": "SP",
    "country": "BR"
  },
  "occupation": "OCP0001",
  "pep": "NONE",
  "assertedIncome": 3500,
  "gender": "FEMININO",
  "nationality": "BRASILEIRO",
  "relationshipStatus": "SOLTEIRO",
  "education": "NAO_ALFABETIZADO",
  "agency": "0001"
}

Envio dos documentos pessoais

📘
Importante
Após registro do cliente, o usuário deverá realizar o envio dos documentos pessoais para que seja feita a analise com o ID One

Países bloqueados para Onboarding

Reafirmando o compromisso do Hiperbanco 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 a seguir. Clique na seta para expandir a lista:

Países bloqueados

Código DDI	País
355	Albânia
375	Bielorrússia
387	Bósnia e Herzegovina
359	Bulgária
257	Burundi
850	Coréia do Norte
385	Croácia
53	Cuba
386	Eslovênia
967	Iémen
98	Irã
964	Iraque
961	Líbano
218	Líbia
389	Macedônia do Norte
382	Montenegro
236	República Centro-Africana
242	República do Congo
243	República Democrática do Congo
40	Romênia
7	Rússia
381	Sérvia
963	Síria
252	Somália
249	Sudão
211	Sudão do Sul
58	Venezuela
263	Zimbábue

Resposta (Response)

O status code 200 indicará que o registro do cliente foi realizado com sucesso.

[
    {
        "code": "REGISTRATION_DONE",
        "messages": [
            "Registration done successfully"
        ]
    }
]

📘
Nota
Após o registro do cliente, o usuário deve ser submetido ao processo de Prova de vida, no qual consiste na analise de sua selfie e foto do documento.

Status da análise KYC

Status	Descrição	O que fazer?
PENDING_APPROVAL	O registro do cliente está em análise, aguardando aprovação.	Pedimos que aguarde até a confirmação do resultado da análise.
APPROVED	O registro do cliente foi aprovado. Agora estamos criando a sua conta.	Agora você já pode criar a conta de pagamentos do cliente.
IN_ANALYSIS	O registro do cliente foi direcionado para análise manual (exclusivo para parceiros com derivação).	Pedimos que aguarde até a confirmação do resultado da análise.
REPROVED	O registro do cliente foi reprovado. Junto com esse status deve ser retornado o campo `reasons`.	Pedimos que verifique os motivos de reprovação antes de realizar uma nova tentativa.
BLACKLISTED	Junto com esse status deve ser retornado o campo `reasons` com o valor `NOT_RETRY`.	Interrompa as tentativas de cadastro desse CPF.
CANCELED	O cadastro do cliente foi cancelado.	Há possibilidade de solicitação de novo registro.
REVOKED	O cadastro do cliente foi revogado.	Solicite complemento ou ajuste no registro de seu cliente.

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 Hiperbanco, 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.

Simular Reprovação

É 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.
422	INVALID_OCCUPATION	Occupation provided is invalid.	Código de ocupação do cliente inválido.

Recordamos que esta API também poderá retornar erros comuns entre todos os endpoints que acompanham os erros 400 (se houver).

Eventos

Este endpoint não possui eventos relacionados a ele.