Manual
Start typing to search…

Detalhes do onboarding

Esse endpoint serve para exibir os detalhes das informações de um onboarding

Pré-requisitos

Para que seja possível utilizar este endpoint, é necessario que:

Requisição (Request)

Requisição HTTP

GET https://sandbox.hiperbanco.com.br/dashboard/onboarding/{onboardingId}
--request GET 'https://sandbox.hiperbanco.com.br/dashboard/onboarding/{onboardingId}' \
--header 'version: cutting-edge' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{token}}'

Cabeçalhos (Headers)

NomePropriedadeDescrição
versioncutting-edgeEssa propriedade garante que o response da API seja retornado no formato JSON
AuthorizationBearer tokenObrigatório. Token de autorização do tipo Bearer.

Parâmetros da rota (Path)

NomeTipoDescrição
onboardingIdpathIdentificador do onboarding

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 das informações do onboarding.

Sendo bem-sucedido, o retorno irá trazer os seguintes campos em formato JSON:

Pessoa Fisica

CampoTipoDescrição
idstringIdentificador do usuário
birthDatestringData de nascimento
dateNumberDocumentPhotostringData da foto do documento numérico
documentNumberstringNúmero do documento
documentNumberPhotostringFoto do número do documento
emailstringE-mail do usuário
motherNamestringNome da mãe
registerNamestringNome de registro
socialNamestringNome social
statusstringStatus do onboarding
reasonsstringMotivo do status
hasBrazilianNationalitybooleanIndica nacionalidade brasileira
phonestringTelefone
isPoliticallyExposedPersonbooleanIndica se é PEP
type_accountstringTipo de conta
retry_onboardingnumberTentativas de onboarding
declaredAnnualBillingnumberFaturamento anual declarado
createdAtstringData de criação
updatedAtstringData de atualização
deletedAtstringData de exclusão
passwordUpdatedAtstringData da última troca de senha
isImportedbooleanIndica se foi importado
occupationstringOcupação
pepstringDeclaração de PEP
assertedIncomenumberRenda declarada
nationalitystringNacionalidade
genderstringGênero
relationshipStatusstringEstado civil
educationstringEscolaridade
documentTypestringTipo de documento
expirationDateForgotPasswordstringExpiração de recuperação de senha
issuerEntitystringÓrgão emissor
ccbPersonIdstringID no CCB
deviceFCMTokenstringToken FCM do dispositivo
mfaSecretstringSegredo MFA
deviceModelstringModelo do dispositivo
importStatusstringStatus de importação
token[]arrayLista de tokens do documento
token[].idstringID do token
token[].contentstringConteúdo do token
token[].fileNamestringNome do arquivo
token[].typestringTipo do token
token[].analysisRequestCountnumberContagem de análises
token[].statusstringStatus da análise
token[].createdAtstringData de criação
token[].updatedAtstringData de atualização
token[].deletedAtstringData de exclusão
addressobjectEndereço do usuário
address.idstringID do endereço
address.zipCodestringCEP
address.addressLinestringLogradouro
address.buildingNumberstringNúmero
address.complementstringComplemento
address.neighborhoodstringBairro
address.citystringCidade
address.statestringEstado
address.countrystringPaís
address.createdAtstringData de criação
address.updatedAtstringData de atualização
address.deletedAtstringData de exclusão
authBlocked[]arrayRegistros de bloqueio de autenticação
authBlocked[].idstringIdentificador do registro de bloqueio
authBlocked[].correlationIdstringIdentificador de correlação
authBlocked[].typestringTipo de bloqueio
authBlocked[].reasonstringMotivo do bloqueio
authBlocked[].createdAtstringData de criação do registro
authBlocked[].updatedAtstringData de atualização do registro
authBlocked[].deletedAtstringData de exclusão do registro
company[]arrayEmpresas vinculadas
pfOwnerobjectDono PF (se houver)
pjCounterparts[]arrayContrapartes PJ
isBlockedbooleanIndica se está bloqueado

Pessoa Juridica

CampoTipoDescrição
companyobjectDados da empresa
company.idstringID da empresa
company.documentNumberstringDocumento da empresa
company.businessNamestringRazão social
company.tradingNamestringNome fantasia
company.businessEmailstringE-mail comercial
company.businessTypestringTipo empresarial
company.businessSizestringPorte da empresa
company.cnaeCodestringCódigo CNAE
company.legalNaturestringNatureza jurídica
company.declaredAnnualBillingstringFaturamento anual declarado
company.openingDatestringData de abertura
company.phonestringTelefone
company.statusstringStatus
company.reasonsstringMotivos do status
company.addressobjectEndereço da empresa
company.address.zipCodestringCEP
company.address.addressLinestringLogradouro
company.address.buildingNumberstringNúmero
company.address.complementstringComplemento
company.address.neighborhoodstringBairro
company.address.citystringCidade
company.address.statestringEstado
company.address.countrystringPaís
legalRepresentatives[]arrayRepresentantes legais
legalRepresentatives[].idstringID do representante
legalRepresentatives[].documentNumberstringDocumento
legalRepresentatives[].registerNamestringNome civil
legalRepresentatives[].socialNamestringNome social
legalRepresentatives[].birthDatestringData de nascimento
legalRepresentatives[].motherNamestringNome da mãe
legalRepresentatives[].emailstringE-mail
legalRepresentatives[].phonestringTelefone
legalRepresentatives[].genderstringGênero
legalRepresentatives[].declaredIncomestringRenda declarada
legalRepresentatives[].occupationstringOcupação
legalRepresentatives[].addressobjectEndereço do representante
legalRepresentatives[].address.zipCodestringCEP
legalRepresentatives[].address.addressLinestringLogradouro
legalRepresentatives[].address.buildingNumberstringNúmero
legalRepresentatives[].address.complementstringComplemento
legalRepresentatives[].address.neighborhoodstringBairro
legalRepresentatives[].address.citystringCidade
legalRepresentatives[].address.statestringEstado
legalRepresentatives[].address.countrystringPaís
legalRepresentatives[].isPoliticallyExposedPersonbooleanIndica se é PEP
legalRepresentatives[].isAlsoOwnerbooleanIndica se também é sócio
owners[]arrayLista de sócios
owners[].idstringID do sócio
owners[].documentNumberstringDocumento
owners[].emailstringE-mail
owners[].participationPercentagestringPercentual societário
owners[].addressobjectEndereço do sócio
owners[].address.zipCodestringCEP
owners[].address.addressLinestringLogradouro
owners[].address.buildingNumberstringNúmero
owners[].address.complementstringComplemento
owners[].address.neighborhoodstringBairro
owners[].address.citystringCidade
owners[].address.statestringEstado
owners[].address.countrystringPaís
owners[].registerNamestringNome civil
owners[].socialNamestringNome social
owners[].birthDatestringData de nascimento
owners[].motherNamestringNome da mãe
owners[].declaredIncomestringRenda declarada
owners[].occupationstringOcupação
owners[].pepobjectDados de PEP
owners[].pep.levelbooleanIndica se é PEP
documentationobjectDocumentação da empresa
documentation.articlesOfIncorporationstringContrato social
documentation.lastContractChangestringÚltima alteração contratual
documentation.balanceSheetstringBalanço patrimonial
documentation.powerOfAttorneystringProcuração
isBlockedbooleanIndica se está bloqueado
{
   "id": "eb302cfa-58b3-4cb4-88b3-74b2d54ddd6f",
   "birthDate": "1997-09-04",
   "dateNumberDocumentPhoto": "2023-02-22T00:00:00.000Z",
   "documentNumber": "61354045041",
   "documentNumberPhoto": "659681516",
   "email": "[email protected]",
   "motherName": "Isabela Patrícia Santos",
   "registerName": "Patrícia Costa",
   "socialName": "Patrícia Costa",
   "status": "APPROVED",
   "reasons": null,
   "hasBrazilianNationality": true,
   "phone": "5581916942256",
   "isPoliticallyExposedPerson": false,
   "type_account": "PF",
   "retry_onboarding": 1,
   "declaredAnnualBilling": null,
   "createdAt": "2025-11-11T13:46:28.115Z",
   "updatedAt": "2025-11-11T13:52:47.000Z",
   "deletedAt": null,
   "passwordUpdatedAt": null,
   "isImported": false,
   "occupation": "Administrador Iniciativa Privada",
   "pep": "Não sou politicamente exposto.",
   "assertedIncome": 53481.32,
   "nationality": "Brasileiro",
   "gender": "Feminino",
   "relationshipStatus": "Solteiro",
   "education": "NAO_ALFABETIZADO",
   "documentType": "RG",
   "expirationDateForgotPassword": null,
   "issuerEntity": "SSP/BA",
   "ccbPersonId": null,
   "deviceFCMToken": null,
   "mfaSecret": null,
   "deviceModel": null,
   "importStatus": null,
   "token": [
      {
         "id": "2461192d-5563-4b9b-817c-cb8edb766e4e",
         "content": "Ri0iPTqgiepDwJnk0UuoM3uJbna5rnkS",
         "fileName": "212ba237-5906-4856-beb8-095edf2c3d14.jpg",
         "type": "SELFIE",
         "analysisRequestCount": 1,
         "status": "NO_LIVENESS",
         "createdAt": "2025-11-11T13:46:36.013Z",
         "updatedAt": "2025-11-11T13:46:43.000Z",
         "deletedAt": null
      },
      {
         "id": "90705cf6-b999-420a-b81b-6e961998ca1a",
         "content": "ZcNESnm30fVEcu8eeG01BgmecOM692CE",
         "fileName": "12020ece-1a58-45dc-a8a5-4176c770e3dd.jpg",
         "type": "FRONT",
         "analysisRequestCount": 1,
         "status": "UNMATCHED_DOCUMENT",
         "createdAt": "2025-11-11T13:46:40.255Z",
         "updatedAt": "2025-11-11T13:46:43.000Z",
         "deletedAt": null
      },
      {
         "id": "9d15b2ec-c4fe-4af3-b0bb-d9273a098269",
         "content": "OvG9QnEl3Iutp3XHnMZEZhQ0ZOMZxXLo",
         "fileName": "7561b2e8-be99-49b1-9cd8-666c8d3496bc.jpg",
         "type": "BACK",
         "analysisRequestCount": 1,
         "status": "NO_INFO_FOUND",
         "createdAt": "2025-11-11T13:46:43.832Z",
         "updatedAt": "2025-11-11T13:46:44.000Z",
         "deletedAt": null
      }
   ],
   "address": {
      "id": "9f581c21-a5aa-4529-ae85-a25f7ef4b3cc",
      "zipCode": "79002210",
      "addressLine": "Rua Maracaju",
      "buildingNumber": "877",
      "complement": "Sala 78",
      "neighborhood": "Centro",
      "city": "Campo Grande",
      "state": "MS",
      "country": "BR",
      "createdAt": "2025-11-11T13:46:28.098Z",
      "updatedAt": "2025-11-11T13:46:28.098Z",
      "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"
      }
   ],
   "company": [],
   "pfOwner": null,
   "pjCounterparts": [],
   "isBlocked": false
}
{
    "company": {
        "id": "c887cf3d-e4e1-4ba9-9ba9-8496b6ccadbc",
        "documentNumber": "27902520859660",
        "businessName": "Smart Group LTDA",
        "tradingName": "Smart Group",
        "businessEmail": "[email protected]",
        "businessType": "LTDA",
        "businessSize": "SMALL",
        "cnaeCode": "8711501",
        "legalNature": "328-0",
        "declaredAnnualBilling": "Mais de cinquenta mil, até cem mil reais",
        "openingDate": "2020-07-18T03:00:00.000Z",
        "phone": "5561985122032",
        "status": "APPROVED",
        "reasons": "",
        "address": {
            "zipCode": "76801180",
            "addressLine": "Rua Major Amarante",
            "buildingNumber": "11",
            "complement": "Sala 23",
            "neighborhood": "Arigolândia",
            "city": "Porto Velho",
            "state": "RO",
            "country": "BR"
        }
    },
    "legalRepresentatives": [
        {
            "id": "c5096507-193c-46c1-a646-4129c0eec421",
            "documentNumber": "18299469430",
            "registerName": "Mariana Oliveira Silva",
            "socialName": "Mariana Oliveira",
            "birthDate": "1997-05-25",
            "motherName": "Camila Mariana Silva Silva",
            "email": "[email protected]",
            "phone": "5561985122032",
            "gender": null,
            "declaredIncome": "Menos de mil reais por mês",
            "occupation": "Produtor Fonográfico",
            "address": {
                "zipCode": "76801180",
                "addressLine": "Rua Major Amarante",
                "buildingNumber": "11",
                "complement": "Sala 23",
                "neighborhood": "Arigolândia",
                "city": "Porto Velho",
                "state": "RO",
                "country": "BR"
            },
            "isPoliticallyExposedPerson": false,
            "isAlsoOwner": true
        }
    ],
    "owners": [
        {
            "id": "c5096507-193c-46c1-a646-4129c0eec421",
            "documentNumber": "18299469430",
            "email": "[email protected]",
            "participationPercentage": null,
            "address": {
                "zipCode": "76801180",
                "addressLine": "Rua Major Amarante",
                "buildingNumber": "11",
                "complement": "Sala 23",
                "neighborhood": "Arigolândia",
                "city": "Porto Velho",
                "state": "RO",
                "country": "BR"
            },
            "registerName": "Mariana Oliveira Silva",
            "socialName": "Mariana Oliveira",
            "birthDate": "1997-05-25",
            "motherName": "Camila Mariana Silva Silva",
            "declaredIncome": "Menos de mil reais por mês",
            "occupation": "Produtor Fonográfico",
            "pep": {
                "level": false
            }
        },
        {
            "id": "f3de375c-9e9f-41ac-b144-b9311260b23e",
            "documentNumber": "18299469430",
            "email": "[email protected]",
            "participationPercentage": "87.32",
            "address": {
                "zipCode": "76801180",
                "addressLine": "Rua Major Amarante",
                "buildingNumber": "11",
                "complement": "Sala 23",
                "neighborhood": "Arigolândia",
                "city": "Porto Velho",
                "state": "RO",
                "country": "BR"
            },
            "registerName": "Mariana Oliveira Silva",
            "socialName": "Mariana Oliveira",
            "birthDate": "1997-06-06",
            "motherName": "Camila Mariana Silva Silva",
            "declaredIncome": "Menos de mil reais por mês",
            "occupation": "Produtor Fonográfico",
            "pep": {
                "level": true
            }
        }
    ],
    "documentation": {
        "articlesOfIncorporation": "eDMnFa.OKXTdgqyOTUsH1EAxjWvEypRA",
        "lastContractChange": "yyNXKdiSyMNGL8z6a.CHF9Yq3UC_u9fA",
        "balanceSheet": "vCPe_I_kSJ70jnSlS.I2AcMEpfuBoheq",
        "powerOfAttorney": null
    },
    "isBlocked": false
}

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