1. Parceiros
Docs Unnotech
  • Visão geral da API
  • Guia: Originação FGTS
  • Guia: Originação CLT
  • Guia: Quota diária
  • Changelog e avisos de mudança
  • Autenticação
    • Gera um access_token
      POST
  • Originação
    • FGTS
      • Busca applications pelo id externo do consumidor
      • Cria uma solicitação (application) e dispara a cotação
      • Status enxuto da application (para polling)
      • Detalha uma application pelo id
      • Re-cota uma application (ofertas antigas invalidadas)
      • Lê o KYC (pré-preenchido quando disponível na plataforma)
      • Submete o KYC (cadastro completo) exigido antes do aceite
      • Aceita uma oferta e inicia a contratação
    • CLT
      • Busca solicitações pelo id externo do consumidor
      • Cria uma solicitação (application) de consignado CLT
      • Status enxuto da solicitação (para polling)
      • Detalha uma solicitação pelo id
      • Consulta o consentimento do trabalhador
      • Força uma nova verificação do consentimento
      • Consulta a margem consignável por vínculo
      • Simula e monta o menu de ofertas
      • Completa o cadastro do cliente
      • Lê o KYC (pré-preenchido quando disponível)
      • Submete o KYC exigido antes do aceite
      • Aceita uma oferta e inicia a contratação
  • Propostas
    • Lista propostas com filtros e paginação
      GET
    • Detalha uma proposta pelo UUID
      GET
  • Admin
    • Usuários
      • Lista usuários com filtros e paginação
      • Cadastra um novo usuário
      • Remove o usuário dos seus parceiros
      • Detalha um usuário pelo UUID
      • Atualiza um usuário (parcial) — e liga/desliga o acesso dele aos seus parceiros
    • Parceiros
      • Lista parceiros com filtros e paginação
        GET
      • Cadastra um novo parceiro
        POST
      • Detalha um parceiro pelo UUID
        GET
      • Remove um parceiro
        DELETE
      • Atualiza um parceiro (parcial)
        PATCH
      • Ativa ou inativa um usuário dentro do parceiro
        PUT
    • Grupos
      • Lista grupos disponíveis
  • Esquemas
    • CreateUserRequest
    • CreateUserResponse
    • UserDetail
    • Data
    • CreateUserResponseData
    • BankerizeErrorResponse
    • UserPartnerEntry
    • Address
    • BankAccount
    • CreatePartnerRequest
    • Partner
    • Pix
    • CreatePartnerResponse
    • CreatePartnerResponseData
    • Customer
    • ApiError
    • ApiErrorResponse
    • CreateFgtsApplicationRequest
    • ErrorDetail
    • FieldErrorCode
    • ApiErrorCode
    • ApplicationStatus
    • FgtsInstallment
    • FgtsQuote
    • OfferStatus
    • FgtsApplication
    • QuoteStatus
    • RejectionKind
    • FgtsOffer
    • RejectionReason
    • AcceptFgtsOfferRequest
    • AcceptFgtsOfferResponse
    • AccountType
    • CivilStatus
    • DisbursementMethod
    • FgtsKyc
    • FgtsKycAddress
    • FgtsKycBank
    • Gender
    • PixKeyType
    • TokenRequest
    • TokenResponse
    • CltCustomer
    • OAuth2ErrorResponse
    • AuthorizationStatus
    • Group
    • UserDetailResponse
    • CreateCltApplicationRequest
    • CltCustomerCompleteness
    • UpdatePartnerRequest
    • CltApplication
    • CltEmploymentAlert
    • CltAuthorization
    • CltInstallment
    • PartnerDetail
    • PartnerDetailResponse
    • PageInfo
    • CltEmployment
    • CltQuote
    • SortInfo
    • CltSimulation
    • CustomerField
    • CltIneligibilityReason
    • UsersPage
    • CltOffer
    • ProposalsPage
    • AcceptCltOfferRequest
    • PublicProposalListItem
    • PublicCustomerSummary
    • QuoteBasis
    • AcceptCltOfferResponse
    • PublicDisbursementAccount
    • CltSimulationRequest
    • OfferNotice
    • PublicLoanSummary
    • CltKycAddress
    • CltKycBank
    • PublicProposalDetailResponse
    • CltKyc
    • PartnerListItem
    • PartnersPage
    • ListOfGroupsResponse
    • CltKycEmployer
    • FgtsApplicationList
    • FgtsApplicationStatus
    • UpdateUserRequest
    • UpdateCltCustomerRequest
    • UserListItem
    • PublicProposalDetail
    • CltApplicationList
    • CltApplicationStatus
    • CltMargin
  1. Parceiros

Lista parceiros com filtros e paginação

GET
/api/v1/partners
Lista paginada de parceiros aos quais o caller tem acesso (filtragem por hierarquia).

Filtros#

full_name — busca parcial case-insensitive em full_name.
cpf_cnpj — busca parcial em cpf_cnpj (aceita CPF ou CNPJ, apenas dígitos).
Múltiplos filtros são combinados com AND (todos precisam bater).

Paginação#

page — base 0 (a primeira página é page=0).
size — entre 1 e 100 (valores acima de 100 são capados em 100).

Ordenação (parâmetro sort)#

Formato campo,direcao, repetível para ordenar por múltiplos campos:
GET /api/v1/partners?sort=created_at,desc
GET /api/v1/partners?sort=full_name,asc&sort=created_at,desc
campo — nome do field em snake_case (created_at, full_name, cpf_cnpj, …).
direcao — asc ou desc. Default quando omitido: asc.
Default geral quando sort não é informado: created_at,desc.

Requisição

Authorization
JWT Bearer
Adicionar o parâmetro
Authorization
a Cabeçalhos
Exemplo:
Authorization: ********************
or
Parâmetros de Consulta

Parâmetros Header

Respostas

🟢200OK
application/json
Lista paginada.
Bodyapplication/json

🟠401Não Autorizado
🟠403Proibido
🔴500Erro do Servidor
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://gtw.unnotech.com.br/public/api/v1/partners?page=0&size=20&full_name=fulano&cpf_cnpj=12345678&sort=full_name%2Casc' \
--header 'Authorization: Bearer <token>'
Response Response Example
200 - Exemplo 1
{
    "content": [
        {
            "partner_id": "3ea1d784-4c6f-4dd0-bfa3-5e027c172fd1",
            "name": "Fulano de Tal",
            "status": "active",
            "email": "fulano@detal.com.br",
            "phone": "11987654321",
            "document_number": "12345678901",
            "person_type": "pf",
            "created_at": "2026-05-08T13:45:00Z",
            "parent_id": "a52a555d-68f8-4560-b544-8ebc76a447ac"
        }
    ],
    "page": {
        "number": 0,
        "size": 20,
        "total_elements": 142,
        "total_pages": 8
    },
    "sort": [
        {
            "property": "created_at",
            "direction": "asc"
        }
    ]
}
Modificado em 2026-08-18 04:28:10
Página anterior
Atualiza um usuário (parcial) — e liga/desliga o acesso dele aos seus parceiros
Próxima página
Cadastra um novo parceiro
Built with