# Docs Unnotech ## Docs - [Visão geral da API](https://docs.unnotech.com.br/vis%C3%A3o-geral-da-api-2271187m0.md): - [Guia: Originação FGTS](https://docs.unnotech.com.br/guia-origina%C3%A7%C3%A3o-fgts-2271188m0.md): ## API Docs - Usuários [Lista usuários com filtros e paginação](https://docs.unnotech.com.br/lista-usu%C3%A1rios-com-filtros-e-pagina%C3%A7%C3%A3o-40775555e0.md): Lista paginada de usuários cujos parceiros estão na hierarquia do caller. - Usuários [Cadastra um novo usuário](https://docs.unnotech.com.br/cadastra-um-novo-usu%C3%A1rio-40775556e0.md): Cria um usuário e o vincula a um parceiro com o grupo informado. - Usuários [Detalha um usuário pelo UUID](https://docs.unnotech.com.br/detalha-um-usu%C3%A1rio-pelo-uuid-40775557e0.md): - Usuários [Remove um usuário](https://docs.unnotech.com.br/remove-um-usu%C3%A1rio-40775558e0.md): - Usuários [Atualiza um usuário (parcial)](https://docs.unnotech.com.br/atualiza-um-usu%C3%A1rio-parcial-40775559e0.md): Atualiza apenas `name`, `phone`. `email`/`cpf` são imutáveis. Atualização de `group_id` está fora do escopo dessa versão. - Parceiros [Lista parceiros com filtros e paginação](https://docs.unnotech.com.br/lista-parceiros-com-filtros-e-pagina%C3%A7%C3%A3o-40775560e0.md): Lista paginada de parceiros aos quais o caller tem acesso (filtragem por hierarquia). - Parceiros [Cadastra um novo parceiro](https://docs.unnotech.com.br/cadastra-um-novo-parceiro-40775561e0.md): Cria um parceiro com dados pessoais/empresariais. `bank_account`, `pix` e `address` - Parceiros [Detalha um parceiro pelo UUID](https://docs.unnotech.com.br/detalha-um-parceiro-pelo-uuid-40775562e0.md): Retorna parceiro completo com bank_account (incluindo bank_code em compe), pix, address e parent_id. - Parceiros [Remove um parceiro](https://docs.unnotech.com.br/remove-um-parceiro-40775563e0.md): Soft delete (status passa a `inactive`). Não permite remover parceiros com filhos ativos. - Parceiros [Atualiza um parceiro (parcial)](https://docs.unnotech.com.br/atualiza-um-parceiro-parcial-40775564e0.md): Atualiza apenas os campos enviados no body. Todos os campos são opcionais. - Originação FGTS [Busca applications pelo id externo do consumidor](https://docs.unnotech.com.br/busca-applications-pelo-id-externo-do-consumidor-40775565e0.md): Recupera solicitações pelo identificador que **você** atribuiu no `X-Api-External-Id`. Use quando perdeu o `application_id` (timeout na criação, por exemplo) e precisa saber se a solicitação chegou a existir. - Originação FGTS [Cria uma solicitação (application) e dispara a cotação](https://docs.unnotech.com.br/cria-uma-solicita%C3%A7%C3%A3o-application-e-dispara-a-cota%C3%A7%C3%A3o-40775566e0.md): Abre a solicitação e dispara a cotação nas bancarizadoras elegíveis. Responde `202` imediatamente, normalmente em `QUOTING` e com `offers` vazio — as ofertas chegam depois. - Originação FGTS [Re-cota uma application (ofertas antigas invalidadas)](https://docs.unnotech.com.br/re-cota-uma-application-ofertas-antigas-invalidadas-40775567e0.md): Dispara uma nova rodada de cotação na mesma solicitação, sem abrir outra. É o caminho quando as ofertas expiraram (`OFFER_EXPIRED`) ou o menu veio vazio e vale nova tentativa. - Originação FGTS [Aceita uma oferta e inicia a contratação](https://docs.unnotech.com.br/aceita-uma-oferta-e-inicia-a-contrata%C3%A7%C3%A3o-40775568e0.md): Seleciona uma oferta do menu e inicia a contratação. Responde `202`: assinatura, averbação e desembolso seguem em background. - Originação FGTS [Lê o KYC (pré-preenchido quando disponível na plataforma)](https://docs.unnotech.com.br/l%C3%AA-o-kyc-pr%C3%A9-preenchido-quando-dispon%C3%ADvel-na-plataforma-40775569e0.md): Devolve o KYC já submetido ou, quando ainda não houve submissão, um rascunho pré-preenchido com o que a plataforma já conhece do CPF. - Originação FGTS [Submete o KYC (cadastro completo) exigido antes do aceite](https://docs.unnotech.com.br/submete-o-kyc-cadastro-completo-exigido-antes-do-aceite-40775570e0.md): Registra o cadastro completo do cliente. Obrigatório antes do aceite: aceitar sem KYC responde `409 KYC_REQUIRED`. - Originação FGTS [Detalha uma application pelo id](https://docs.unnotech.com.br/detalha-uma-application-pelo-id-40775571e0.md): Estado completo da solicitação: cotações, ofertas e a proposta em contratação. É a fonte da verdade — mesmo quem usa webhook deve ler aqui antes de agir. - Originação FGTS [Status enxuto da application (para polling)](https://docs.unnotech.com.br/status-enxuto-da-application-para-polling-40775572e0.md): Mesma solicitação, sem `quotes` nem `offers` no corpo. É o endpoint desenhado para o laço de espera: chame este enquanto aguarda e só busque o `GET` completo quando `status` ou `offers_count` mudarem. - Autenticação [Gera um access_token](https://docs.unnotech.com.br/gera-um-access-token-40775573e0.md): Troca um par `client_id` / `client_secret` por um access_token JWT. - Propostas [Lista propostas com filtros e paginação](https://docs.unnotech.com.br/lista-propostas-com-filtros-e-pagina%C3%A7%C3%A3o-40775574e0.md): Lista paginada de propostas visíveis ao caller. Filtros são combinados com AND. - Propostas [Detalha uma proposta pelo UUID](https://docs.unnotech.com.br/detalha-uma-proposta-pelo-uuid-40775575e0.md): Retorna o detalhe da proposta. 404 quando não existe OU está fora da hierarquia. - Grupos [Lista grupos disponíveis](https://docs.unnotech.com.br/lista-grupos-dispon%C3%ADveis-40775576e0.md): Retorna grupos não-globais ordenados por label. ## Schemas - [CreateUserRequest](https://docs.unnotech.com.br/createuserrequest-16722313d0.md): - [CreateUserResponse](https://docs.unnotech.com.br/createuserresponse-16722314d0.md): - [Data](https://docs.unnotech.com.br/data-16722315d0.md): - [CreateUserResponseData](https://docs.unnotech.com.br/createuserresponsedata-16821844d0.md): - [BankerizeErrorResponse](https://docs.unnotech.com.br/bankerizeerrorresponse-16722316d0.md): - [Address](https://docs.unnotech.com.br/address-16722317d0.md): - [BankAccount](https://docs.unnotech.com.br/bankaccount-16722318d0.md): - [CreatePartnerRequest](https://docs.unnotech.com.br/createpartnerrequest-16722319d0.md): - [Partner](https://docs.unnotech.com.br/partner-16722320d0.md): - [Pix](https://docs.unnotech.com.br/pix-16722321d0.md): - [CreatePartnerResponse](https://docs.unnotech.com.br/createpartnerresponse-16722322d0.md): - [CreateFgtsApplicationRequest](https://docs.unnotech.com.br/createfgtsapplicationrequest-16722323d0.md): - [CreatePartnerResponseData](https://docs.unnotech.com.br/createpartnerresponsedata-16821845d0.md): - [Customer](https://docs.unnotech.com.br/customer-16722324d0.md): - [ApiError](https://docs.unnotech.com.br/apierror-16722325d0.md): - [ApiErrorCode](https://docs.unnotech.com.br/apierrorcode-16722326d0.md): - [ApiErrorResponse](https://docs.unnotech.com.br/apierrorresponse-16722327d0.md): - [ErrorDetail](https://docs.unnotech.com.br/errordetail-16722328d0.md): - [FieldErrorCode](https://docs.unnotech.com.br/fielderrorcode-16722329d0.md): - [ApplicationStatus](https://docs.unnotech.com.br/applicationstatus-16722330d0.md): - [FgtsApplication](https://docs.unnotech.com.br/fgtsapplication-16722331d0.md): - [FgtsInstallment](https://docs.unnotech.com.br/fgtsinstallment-16722332d0.md): - [FgtsOffer](https://docs.unnotech.com.br/fgtsoffer-16722333d0.md): - [FgtsQuote](https://docs.unnotech.com.br/fgtsquote-16722334d0.md): - [OfferStatus](https://docs.unnotech.com.br/offerstatus-16722335d0.md): - [QuoteStatus](https://docs.unnotech.com.br/quotestatus-16722336d0.md): - [RejectionKind](https://docs.unnotech.com.br/rejectionkind-16722337d0.md): - [RejectionReason](https://docs.unnotech.com.br/rejectionreason-16722338d0.md): - [AcceptFgtsOfferRequest](https://docs.unnotech.com.br/acceptfgtsofferrequest-16722339d0.md): - [AcceptFgtsOfferResponse](https://docs.unnotech.com.br/acceptfgtsofferresponse-16722340d0.md): - [AccountType](https://docs.unnotech.com.br/accounttype-16722341d0.md): - [CivilStatus](https://docs.unnotech.com.br/civilstatus-16722342d0.md): - [DisbursementMethod](https://docs.unnotech.com.br/disbursementmethod-16722343d0.md): - [FgtsKyc](https://docs.unnotech.com.br/fgtskyc-16722344d0.md): - [FgtsKycAddress](https://docs.unnotech.com.br/fgtskycaddress-16722345d0.md): - [FgtsKycBank](https://docs.unnotech.com.br/fgtskycbank-16722346d0.md): - [Gender](https://docs.unnotech.com.br/gender-16722347d0.md): - [PixKeyType](https://docs.unnotech.com.br/pixkeytype-16722348d0.md): - [TokenRequest](https://docs.unnotech.com.br/tokenrequest-16722349d0.md): - [TokenResponse](https://docs.unnotech.com.br/tokenresponse-16722350d0.md): - [OAuth2ErrorResponse](https://docs.unnotech.com.br/oauth2errorresponse-16722351d0.md): - [UpdateUserRequest](https://docs.unnotech.com.br/updateuserrequest-16722352d0.md): - [Group](https://docs.unnotech.com.br/group-16722353d0.md): - [UserDetail](https://docs.unnotech.com.br/userdetail-16722354d0.md): - [UserDetailResponse](https://docs.unnotech.com.br/userdetailresponse-16722355d0.md): - [UserPartnerEntry](https://docs.unnotech.com.br/userpartnerentry-16722356d0.md): - [UpdatePartnerRequest](https://docs.unnotech.com.br/updatepartnerrequest-16722357d0.md): - [PartnerDetail](https://docs.unnotech.com.br/partnerdetail-16722358d0.md): - [PartnerDetailResponse](https://docs.unnotech.com.br/partnerdetailresponse-16722359d0.md): - [PageInfo](https://docs.unnotech.com.br/pageinfo-16722360d0.md): - [SortInfo](https://docs.unnotech.com.br/sortinfo-16722361d0.md): - [UserListItem](https://docs.unnotech.com.br/userlistitem-16722362d0.md): - [UsersPage](https://docs.unnotech.com.br/userspage-16722363d0.md): - [ProposalsPage](https://docs.unnotech.com.br/proposalspage-16722364d0.md): - [PublicProposalListItem](https://docs.unnotech.com.br/publicproposallistitem-16722365d0.md): - [PublicCustomerSummary](https://docs.unnotech.com.br/publiccustomersummary-16722366d0.md): - [PublicDisbursementAccount](https://docs.unnotech.com.br/publicdisbursementaccount-16722367d0.md): - [PublicLoanSummary](https://docs.unnotech.com.br/publicloansummary-16722368d0.md): - [PublicProposalDetail](https://docs.unnotech.com.br/publicproposaldetail-16722369d0.md): - [PublicProposalDetailResponse](https://docs.unnotech.com.br/publicproposaldetailresponse-16722370d0.md): - [PartnerListItem](https://docs.unnotech.com.br/partnerlistitem-16722371d0.md): - [PartnersPage](https://docs.unnotech.com.br/partnerspage-16722372d0.md): - [ListOfGroupsResponse](https://docs.unnotech.com.br/listofgroupsresponse-16722373d0.md): - [FgtsApplicationList](https://docs.unnotech.com.br/fgtsapplicationlist-16722374d0.md): - [FgtsApplicationStatus](https://docs.unnotech.com.br/fgtsapplicationstatus-16722375d0.md):