Autenticação - Usuario

Esse endpoint realiza a autenticação do usuário

Pré-requisitos

Para utilizar este endpoint, é necessário que o usuário possua uma conta de pagamentos ativa

Requisição (Request)

Requisição HTTP

POST https://sandbox.hiperbanco.com.br/Users/login/api-bank

--request POST 'https://sandbox.hiperbanco.com.br/Users/login/api-bank' \
--header 'version: cutting-edge' \
--header 'Content-Type: application/json' \
--data-raw '{
	"document": "52365478526",
	"password": "Senhatest123@",
	"clientId": "0a50a787-5ec5-4120-a34e-3485f7d98c8b"
}'

Parâmetros da rota (Path)

Não é necessário enviar parâmetros no path desta requisição.

Corpo da requisição (Body)

No body, envie o seguinte campo em formato JSON:

Nome	Tipo	Descrição
`document`	string	Obrigatório. CPF ou CNPJ do usuário
`password`	string	Obrigatório. Senha de acesso
`clientId`	string	Obrigatório. Identificador único do cliente (UUID)
`accountNumber`	string	Numero da conta do usuário (Utilizar apenas se o mesmo usuário tiver mais de 1 conta no mesmo documento)

{
	"document": "52365478526",
	"password": "Senhatest123@",
	"clientId": "0a50a787-5ec5-4120-a34e-3485f7d98c8b"
}

{
	"document": "52365478526",
  "password": "Senhatest123@",
	"accountNumber": "123564785",
	"clientId": "0a50a787-5ec5-4120-a34e-3485f7d98c8b"
}

Resposta (Response)

O status code 201 indicará sucesso na requisição.

Sendo bem-sucedido, o retorno irá trazer o seguinte campo em formato JSON:

Campo	Tipo	Descrição
`status`	number	Código de status da resposta
`access_token`	string	Token de acesso JWT
`userData`	object	Dados do usuário autenticado
`userData.missingData`	boolean	Indica se há dados faltando
`userData.id`	string	ID do usuário
`userData.userId`	string	ID do usuário
`userData.birthDate`	string	Data de nascimento (YYYY-MM-DD)
`userData.dateNumberDocumentPhoto`	string	Data da foto do documento
`userData.documentNumber`	string	Número do documento
`userData.documentNumberPhoto`	string	Número da foto do documento
`userData.email`	string	Email do usuário
`userData.motherName`	string	Nome da mãe
`userData.registerName`	string	Nome civil do usuário
`userData.socialName`	string	Nome social do usuário
`userData.isPoliticallyExposedPerson`	boolean	Indica se o usuário é PEP
`userData.typeAccount`	string	Tipo de conta (ex: `PF`)
`userData.accounts[]`	array	Lista de contas associadas
`userData.accounts[].id`	string	ID da conta
`userData.accounts[].status`	string	Status da conta
`userData.accounts[].branch`	string	Agência da conta
`userData.accounts[].number`	string	Número da conta
`userData.accounts[].type`	string	Tipo da conta
`userData.address`	object	Endereço do usuário
`userData.address.id`	string	ID do endereço
`userData.address.zipCode`	string	CEP
`userData.address.addressLine`	string	Logradouro
`userData.address.buildingNumber`	string	Número do imóvel
`userData.address.complement`	string	Complemento
`userData.address.neighborhood`	string	Bairro
`userData.address.city`	string	Cidade
`userData.address.state`	string	Estado
`userData.address.country`	string	País
`userData.address.createdAt`	string	Data de criação do endereço
`userData.address.updatedAt`	string	Data de atualização do endereço
`userData.address.deletedAt`	string	Data de exclusão (se houver)
`userData.hasPinCode`	boolean	Indica se o usuário possui PIN cadastrado
`userData.inAnalysis`	boolean	Indica se o cadastro está em análise
`userData.isReproved`	boolean	Indica se o cadastro foi reprovado
`userData.phone`	string	Telefone
`userData.pep`	string	Situação como PEP
`userData.gender`	string	Gênero
`userData.relationshipStatus`	string	Estado civil
`userData.occupation`	string	Ocupação (código)
`userData.nationality`	string	Nacionalidade
`userData.declaredIncome`	string	Renda declarada
`userData.assertedIncome`	number	Renda comprovada
`userData.issuerEntity`	string	Órgão emissor do documento
`userData.documentType`	string	Tipo de documento
`userData.education`	string	Nível de escolaridade
`ticketId`	string	ID do ticket, se aplicável

{
  "status": 200,
  "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjbGllbnRJZCI6IjY3ODkwYjIxLTY1NzAtNDI2NS1hZTczLWI5Y2JkODk0YzA3YSIsImRvY3VtZW50IjoiNDcyMTEzNzMxODIiLCJkb2N1bWVudE51bWJlciI6IjQ3MjExMzczMTgyIiwiaWQiOiJiMzQ2ZTc3My1mNWI2LTRhNjEtYmIwYi0xMjQ2NmQ1ZTUzZTYiLCJ1c2VySWQiOiJiMzQ2ZTc3My1mNWI2LTRhNjEtYmIwYi0xMjQ2NmQ1ZTUzZTYiLCJpbnN0YW5jZUlkIjoiYjEwYjY4ZDUtZDg3YS00ODlhLTg2NDktZTIxNzA1NDY3NDZhIiwiZnJvbnRfdHlwZSI6Ik1PQklMRSIsInN0YXR1cyI6IkFQUFJPVkVEIiwibmFtZSI6IkxpdmllIFZpZWlyYSBNYXJxdWVzIiwiYWNjb3VudCI6W3siaWQiOiIzNzU4NzY2NC1jNTExLTRlZTUtYWUwMy1mMjY3Y2Y1NDJlNzYiLCJzdGF0dXMiOiJBQ1RJVkUiLCJicmFuY2giOiIwMDAxIiwibnVtYmVyIjoiMTEwNDgwMjI5MSIsInR5cGUiOiJNQUlOIn1dLCJhY2NvdW50cyI6W3siaWQiOiIzNzU4NzY2NC1jNTExLTRlZTUtYWUwMy1mMjY3Y2Y1NDJlNzYiLCJzdGF0dXMiOiJBQ1RJVkUiLCJicmFuY2giOiIwMDAxIiwibnVtYmVyIjoiMTEwNDgwMjI5MSIsInR5cGUiOiJNQUlOIn1dLCJpYXQiOjE3NTM5Mjk5NTAsImV4cCI6MTc1MzkzMTc1MH0.yOAGM5R8n6IYHfCGTYYghU7N0tEG4v3RQK1IGgkhpAE",
  "userData": {
    "missingData": false,
    "id": "b346e773-f5b6-4a61-bb0b-12466d5e53e6",
    "userId": "b346e773-f5b6-4a61-bb0b-12466d5e53e6",
    "birthDate": "1995-03-15",
    "dateNumberDocumentPhoto": "2024-02-10T03:00:00.000Z",
    "documentNumber": "47211373182",
    "documentNumberPhoto": "812349650",
    "email": "[email protected]",
    "motherName": "Maria Tereza Vieira",
    "registerName": "Lívia Vieira Marques",
    "socialName": "Lívia Marques",
    "isPoliticallyExposedPerson": false,
    "typeAccount": "PF",
    "accounts": [
      {
        "id": "37587664-c511-4ee5-ae03-f267cf542e76",
        "status": "ACTIVE",
        "branch": "0001",
        "number": "1104802291",
        "type": "MAIN"
      }
    ],
    "address": {
      "id": "85e3a4df-6e9d-4c53-b99a-f2067ed2a54d",
      "zipCode": "22775900",
      "addressLine": "Rua das Acácias",
      "buildingNumber": "512",
      "complement": "Bloco B, Apto 302",
      "neighborhood": "Barra da Tijuca",
      "city": "Rio de Janeiro",
      "state": "RJ",
      "country": "BR",
      "createdAt": "2025-06-13T13:36:31.070Z",
      "updatedAt": "2025-06-13T13:36:31.070Z",
      "deletedAt": null
    },
    "hasPinCode": true,
    "inAnalysis": false,
    "isReproved": false,
    "phone": "21988997766",
    "pep": "NONE",
    "gender": "FEMININO",
    "relationshipStatus": "SOLTEIRA",
    "occupation": "OCP0012",
    "nationality": "BRASILEIRA",
    "declaredIncome": null,
    "assertedIncome": 4200,
    "issuerEntity": "SSP/RJ",
    "documentType": "RG",
    "education": "ENSINO_MEDIO_COMPLETO"
  },
  "ticketId": null
}

Erros

Em caso de falha na autenticação, a resposta trará o seguinte campo no corpo da requisição, em formato JSON:

{
    "status": "error",
    "statusCode": 403,
    "errorCode": "FORBIDDEN_CLIENT_TYPE",
    "message": "Access denied: client type is not authorized to perform this operation."
}

{
    "status": "error",
    "statusCode": 401,
    "errorCode": "UNAUTHORIZED_ACCESS",
    "message": "Wrong document value and password combination."
}