Consultar todas as tentativas de onboarding criadas
Este endpoint permite realizar a consulta de todas as contas criadas no banco
Pré-requisitos
Para que seja possível utilizar este endpoint, é necessario que:
- O usuário esteja utilizando a Autenticação Gestão do Banco
Requisição (Request)
Requisição HTTP
GET https://sandbox.hiperbanco.com.br/dashboard/onboarding--request GET 'https://sandbox.hiperbanco.com.br/dashboard/onboarding' \
--header 'version: cutting-edge' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{token}}' Cabeçalhos (Headers)
| Nome | Propriedade | Descrição |
|---|---|---|
version | cutting-edge | Essa propriedade garante que o response da API seja retornado no formato JSON |
Authorization | Bearer token | Obrigatório. Token de autorização do tipo Bearer. |
Parâmetros da rota (Path / Query)
É possível enviar os seguintes Query Params nesta requisição:
| Nome | Tipo | Descrição |
|---|---|---|
startDate | query | Data inicial da busca. ISO Date Format (YYYY-MM-DD). |
endDate | query | Data final da busca. ISO Date Format (YYYY-MM-DD). |
page | query | Página do resultado da busca |
perPage | query | Itens por página |
search | query | Query de pesquisa - É possivel pesquisar pelo documentNumber, registerName |
orderColumn | query | Coluna para ordenação - Valores possiveis: createdAt e registerName |
orderDirection | query | Sentido da ordenação, pode ser ASC (ascendente) ou DESC (descendente). Funciona apenas se orderColumn tiver sido especificado |
type_user | query | Tipo do usuario: PF ou PJ |
status | query | Buscar por status da conta - APPROVED, PRE_REGISTER, PENDING_APPROVAL, BLACKLISTED e REPROVED |
Corpo da requisição (Body)
Não é necessário enviar parâmetros no body desta requisição.
Resposta (Response)
O status code 200 indicará que a requisição foi feita com sucesso e trará um objeto contendo as informações dos onboardings criados.
Sendo bem-sucedido, o retorno irá trazer os seguintes campos em formato JSON:
| Campo | Tipo | Descrição |
|---|---|---|
data[] | object | Lista de registros retornados |
data.id | string | Identificador do registro |
data.birthDate | string | Data de nascimento |
data.dateNumberDocumentPhoto | string | Data da foto do documento |
data.documentNumber | string | Número do documento |
data.documentNumberPhoto | string | Identificador da foto do documento |
data.email | string | E-mail do titular |
data.motherName | string | Nome da mãe |
data.registerName | string | Nome cadastrado |
data.socialName | string | Nome social |
data.status | string | Status do cadastro |
data.reasons | string | Motivo ou justificativa (pode ser nulo) |
data.phone | string | Telefone de contato |
data.isPoliticallyExposedPerson | boolean | Indica se é pessoa politicamente exposta |
data.type_account | string | Tipo de conta (PF ou PJ) |
data.retry_onboarding | number | Quantidade de tentativas de onboarding |
data.createdAt | string | Data de criação do registro |
data.updatedAt | string | Data de atualização do registro |
data.deletedAt | string | Data de exclusão (se aplicável) |
data.company[] | object | Lista de empresas vinculadas |
data.company.id | string | Identificador da empresa |
data.company.businessName | string | Razão social da empresa |
data.company.tradingName | string | Nome fantasia da empresa |
data.company.businessEmail | string | E-mail comercial |
data.company.businessType | string | Tipo de empresa |
data.company.legalNature | string | Natureza jurídica |
data.company.businessSize | string | Porte da empresa |
data.company.documentNumber | string | CNPJ da empresa |
data.company.cnaeCode | string | Código CNAE |
data.company.legalrepresentativeId | string | ID do representante legal |
data.company.openingDate | string | Data de abertura da empresa |
data.company.createdAt | string | Data de criação do registro da empresa |
data.company.updatedAt | string | Data de atualização da empresa |
data.company.deletedAt | string | Data de exclusão da empresa |
data.token[] | object | Lista de tokens de verificação |
data.token.id | string | Identificador do token |
data.token.content | string | Conteúdo codificado do token |
data.token.fileName | string | Nome do arquivo vinculado |
data.token.type | string | Tipo do token (FRONT, BACK, SELFIE) |
data.token.analysisRequestCount | number | Contagem de solicitações de análise |
data.token.status | string | Status do token |
data.token.createdAt | string | Data de criação do token |
data.token.updatedAt | string | Data de atualização do token |
data.token.deletedAt | string | Data de exclusão do token |
data.authBlocked[] | object | Lista de bloqueios de autenticação |
data.authBlocked.id | string | Identificador do registro de bloqueio |
data.authBlocked.correlationId | string | Identificador de correlação |
data.authBlocked.type | string | Tipo de bloqueio |
data.authBlocked.reason | string | Motivo do bloqueio |
data.authBlocked.createdAt | string | Data de criação do registro |
data.authBlocked.updatedAt | string | Data de atualização do registro |
data.authBlocked.deletedAt | string | Data de exclusão do registro |
data.isBlocked | boolean | Indica se o usuário está bloqueado |
total | number | Total de registros retornados |
totalPages | number | Total de páginas disponíveis |
{
"data": [
{
"id": "476a8b8e-9a15-4397-90cb-ff9b8957d919",
"birthDate": "1997-07-19",
"dateNumberDocumentPhoto": "2023-07-25T00:00:00.000Z",
"documentNumber": "47325442238",
"documentNumberPhoto": "750415562",
"email": "[email protected]",
"motherName": "Fernanda Patrícia Nascimento",
"registerName": "Daniel Carlos Oliveira",
"socialName": "Daniel Oliveira",
"status": "APPROVED",
"reasons": null,
"phone": "5561967889843",
"isPoliticallyExposedPerson": false,
"type_account": "PF",
"retry_onboarding": 1,
"createdAt": "23/10/2025",
"updatedAt": "2025-10-23T12:08:28.000Z",
"deletedAt": null,
"company": [],
"token": [
{
"id": "8b1ccd4b-b6d4-4d3b-ba5e-50cc82bfa874",
"content": "kvkey2YD0mvolC2n3vBah.pSp24FGslz",
"fileName": "4782436c-a875-4c37-aeda-cd1faee66f47.jpg",
"type": "FRONT",
"analysisRequestCount": 1,
"status": null,
"createdAt": "2025-10-23T12:02:15.192Z",
"updatedAt": "2025-10-23T12:02:15.192Z",
"deletedAt": null
},
{
"id": "b65927aa-adfe-42a4-9ef7-ab72859b0d28",
"content": "gcvvBPWiioP9wJfbIb_Ey.pJF7fFT0zF",
"fileName": "2965e0c5-c54d-4c58-ad73-d87a44058a85.jpg",
"type": "BACK",
"analysisRequestCount": 1,
"status": null,
"createdAt": "2025-10-23T12:02:21.475Z",
"updatedAt": "2025-10-23T12:02:21.475Z",
"deletedAt": null
},
{
"id": "df3a3208-5c23-42df-9e7a-9bce6fdb547d",
"content": "VEn3FEk6.NUZkogHspWmteiiWWZAV8As",
"fileName": "8b18a3c9-7db8-4275-8338-a62b1478ec26.jpg",
"type": "SELFIE",
"analysisRequestCount": 1,
"status": null,
"createdAt": "2025-10-23T12:02:08.100Z",
"updatedAt": "2025-10-23T12:02:08.100Z",
"deletedAt": null
}
],
"authBlocked": [
{
"id": "a7c3c35a-9816-4adc-b410-494859bc57c0",
"correlationId": "e08610bd-70fe-430c-a07e-4bd7899d0eb7",
"type": "FAILED_LOGIN_ATTEMPTS",
"reason": "Account blocked due to invalid login attempts.",
"createdAt": "2025-08-22T16:17:20.000Z",
"updatedAt": "2025-09-09T17:46:16.000Z",
"deletedAt": "2025-09-09T17:46:16.000Z"
},
{
"id": "a1edecda-b75e-4e0a-9d78-776ff2582eca",
"correlationId": "d2572241-9099-43d7-8a76-b88dfdefe82c",
"type": "FAILED_LOGIN_ATTEMPTS",
"reason": "Account blocked due to invalid login attempts.",
"createdAt": "2025-10-28T01:21:27.000Z",
"updatedAt": "2025-10-28T12:46:56.000Z",
"deletedAt": "2025-10-28T12:46:56.000Z"
}
],
"isBlocked": false
},
{
"id": "89712526-5efc-4f38-acec-152e387a3190",
"birthDate": "1996-07-21T03:00:00.000Z",
"dateNumberDocumentPhoto": "2024-01-24T00:00:00.000Z",
"documentNumber": "29141512093492",
"documentNumberPhoto": "n/a",
"email": "[email protected]",
"motherName": "n/a",
"registerName": "Teste de Webhook MEI",
"socialName": "Teste de Webhook",
"status": "PENDING_APPROVAL",
"reasons": null,
"phone": "5571993605522",
"isPoliticallyExposedPerson": false,
"type_account": "PJ",
"retry_onboarding": 0,
"createdAt": "23/10/2025",
"updatedAt": "2025-10-23T12:01:50.361Z",
"deletedAt": null,
"company": [
{
"id": "35fa9e5f-83b4-4b1a-b60b-8081870e2292",
"businessName": "Teste de Webhook MEI",
"tradingName": "Teste de Webhook",
"businessEmail": "[email protected]",
"businessType": "MEI",
"legalNature": "MEI",
"businessSize": "MEI",
"documentNumber": "29141512093492",
"cnaeCode": null,
"legalrepresentativeId": "6c9facab-f3e1-4a79-8612-10dcc4a2a44c",
"openingDate": "2003-01-01T00:00:00.000Z",
"createdAt": "2025-10-23T12:01:50.385Z",
"updatedAt": "2025-10-23T12:01:50.385Z",
"deletedAt": null
}
],
"token": [
{
"id": "8b1ccd4b-b6d4-4d3b-ba5e-50cc82bfa874",
"content": "kvkey2YD0mvolC2n3vBah.pSp24FGslz",
"fileName": "4782436c-a875-4c37-aeda-cd1faee66f47.jpg",
"type": "FRONT",
"analysisRequestCount": 1,
"status": null,
"createdAt": "2025-10-23T12:02:15.192Z",
"updatedAt": "2025-10-23T12:02:15.192Z",
"deletedAt": null
},
{
"id": "b65927aa-adfe-42a4-9ef7-ab72859b0d28",
"content": "gcvvBPWiioP9wJfbIb_Ey.pJF7fFT0zF",
"fileName": "2965e0c5-c54d-4c58-ad73-d87a44058a85.jpg",
"type": "BACK",
"analysisRequestCount": 1,
"status": null,
"createdAt": "2025-10-23T12:02:21.475Z",
"updatedAt": "2025-10-23T12:02:21.475Z",
"deletedAt": null
},
{
"id": "df3a3208-5c23-42df-9e7a-9bce6fdb547d",
"content": "VEn3FEk6.NUZkogHspWmteiiWWZAV8As",
"fileName": "8b18a3c9-7db8-4275-8338-a62b1478ec26.jpg",
"type": "SELFIE",
"analysisRequestCount": 1,
"status": null,
"createdAt": "2025-10-23T12:02:08.100Z",
"updatedAt": "2025-10-23T12:02:08.100Z",
"deletedAt": null
}
],
"authBlocked": [
{
"id": "a7c3c35a-9816-4adc-b410-494859bc57c0",
"correlationId": "e08610bd-70fe-430c-a07e-4bd7899d0eb7",
"type": "FAILED_LOGIN_ATTEMPTS",
"reason": "Account blocked due to invalid login attempts.",
"createdAt": "2025-08-22T16:17:20.000Z",
"updatedAt": "2025-09-09T17:46:16.000Z",
"deletedAt": "2025-09-09T17:46:16.000Z"
},
{
"id": "a1edecda-b75e-4e0a-9d78-776ff2582eca",
"correlationId": "d2572241-9099-43d7-8a76-b88dfdefe82c",
"type": "FAILED_LOGIN_ATTEMPTS",
"reason": "Account blocked due to invalid login attempts.",
"createdAt": "2025-10-28T01:21:27.000Z",
"updatedAt": "2025-10-28T12:46:56.000Z",
"deletedAt": "2025-10-28T12:46:56.000Z"
}
],
"isBlocked": false
}
],
"total": 2,
"totalPages": 1
}Erros
Este endpoint não retorna erros específicos. Porém, ele poderá retornar alguns erros comuns entre todos os endpoints.
Eventos
Este endpoint não possui eventos relacionados a ele.
Updated about 1 month ago