1. FGTS
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
        GET
      • Cria uma solicitação (application) e dispara a cotação
        POST
      • Status enxuto da application (para polling)
        GET
      • Detalha uma application pelo id
        GET
      • Re-cota uma application (ofertas antigas invalidadas)
        POST
      • Lê o KYC (pré-preenchido quando disponível na plataforma)
        GET
      • Submete o KYC (cadastro completo) exigido antes do aceite
        POST
      • Aceita uma oferta e inicia a contratação
        POST
    • 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
      • Cadastra um novo parceiro
      • Detalha um parceiro pelo UUID
      • Remove um parceiro
      • Atualiza um parceiro (parcial)
      • Ativa ou inativa um usuário dentro do parceiro
    • 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. FGTS

Busca applications pelo id externo do consumidor

GET
/api/v1/fgts/applications
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.
Devolve lista: o mesmo id externo pode ter sido usado em mais de uma solicitação.

Requisição

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

Respostas

🟢200OK
application/json
Solicitações com esse id externo. Lista vazia quando não há nenhuma.
Bodyapplication/json

🟠401Não Autorizado
🟠422Erro de Parâmetro
🔴500Erro do Servidor
🔴502Gateway Inválido
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://gtw.unnotech.com.br/public/api/v1/fgts/applications?api_external_id=PEDIDO-2026-0001' \
--header 'Authorization: Bearer <token>'
Response Response Example
200 - Exemplo 1
{
    "data": [
        {
            "application_id": "3f6a1b2c-8d4e-4f10-9a7b-2c5e6d8f0a13",
            "api_external_id": "PEDIDO-2026-0001",
            "cpf": "12345678909",
            "status": "AWAITING_AUTHORIZATION",
            "quotes_pending": 1,
            "quotes": [
                {
                    "source": "J17",
                    "status": "PENDING",
                    "reason": "Saldo FGTS insuficiente para antecipação."
                }
            ],
            "offers": [
                {
                    "offer_id": "of_9f2c41a7e8b34d61",
                    "source": "J17",
                    "table_name": "FGTS 1.79",
                    "table_id": "3f1b7c2e-9a44-4c1d-8e57-6b2d0f9a1c34",
                    "status": "AVAILABLE",
                    "net_amount": 3418.72,
                    "total_amount": 4200,
                    "iof": 62.18,
                    "gross_amount": 3540.9,
                    "monthly_interest_rate": 1.79,
                    "annual_interest_rate": 23.71,
                    "total_interest": 781.28,
                    "tc_value": 60,
                    "cet_monthly": 1.79,
                    "cet_annual": 23.71,
                    "installments": [
                        {
                            "due_date": "2027-04-01",
                            "amount": 512.44
                        }
                    ],
                    "expires_at": "2026-07-27T18:45:00Z",
                    "rejection_reason": {
                        "kind": "REGRA_VIOLADA",
                        "code": "IDADE_MINIMA",
                        "message": "Cliente não atende à idade mínima exigida para a operação."
                    }
                }
            ],
            "proposal_uuid": "b81c9f30-5a24-4e6d-91f8-7d3a0c5b2e64"
        }
    ]
}
Modificado em 2026-08-18 04:28:10
Página anterior
Gera um access_token
Próxima página
Cria uma solicitação (application) e dispara a cotação
Built with