1. Originação FGTS
Docs Unnotech
  • Visão geral da API
  • Guia: Originação FGTS
  • Usuários
    • Lista usuários com filtros e paginação
      GET
    • Cadastra um novo usuário
      POST
    • Detalha um usuário pelo UUID
      GET
    • Remove um usuário
      DELETE
    • Atualiza um usuário (parcial)
      PATCH
  • 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
  • Originação FGTS
    • Busca applications pelo id externo do consumidor
      GET
    • Cria uma solicitação (application) e dispara a cotação
      POST
    • Re-cota uma application (ofertas antigas invalidadas)
      POST
    • Aceita uma oferta e inicia a contratação
      POST
    • Lê o KYC (pré-preenchido quando disponível na plataforma)
      GET
    • Submete o KYC (cadastro completo) exigido antes do aceite
      POST
    • Detalha uma application pelo id
      GET
    • Status enxuto da application (para polling)
      GET
  • Autenticação
    • Gera um access_token
      POST
  • Propostas
    • Lista propostas com filtros e paginação
      GET
    • Detalha uma proposta pelo UUID
      GET
  • Grupos
    • Lista grupos disponíveis
      GET
  • Esquemas
    • CreateUserRequest
    • CreateUserResponse
    • Data
    • CreateUserResponseData
    • BankerizeErrorResponse
    • Address
    • BankAccount
    • CreatePartnerRequest
    • Partner
    • Pix
    • CreatePartnerResponse
    • CreateFgtsApplicationRequest
    • CreatePartnerResponseData
    • Customer
    • ApiError
    • ApiErrorCode
    • ApiErrorResponse
    • ErrorDetail
    • FieldErrorCode
    • ApplicationStatus
    • FgtsApplication
    • FgtsInstallment
    • FgtsOffer
    • FgtsQuote
    • OfferStatus
    • QuoteStatus
    • RejectionKind
    • RejectionReason
    • AcceptFgtsOfferRequest
    • AcceptFgtsOfferResponse
    • AccountType
    • CivilStatus
    • DisbursementMethod
    • FgtsKyc
    • FgtsKycAddress
    • FgtsKycBank
    • Gender
    • PixKeyType
    • TokenRequest
    • TokenResponse
    • OAuth2ErrorResponse
    • UpdateUserRequest
    • Group
    • UserDetail
    • UserDetailResponse
    • UserPartnerEntry
    • UpdatePartnerRequest
    • PartnerDetail
    • PartnerDetailResponse
    • PageInfo
    • SortInfo
    • UserListItem
    • UsersPage
    • ProposalsPage
    • PublicProposalListItem
    • PublicCustomerSummary
    • PublicDisbursementAccount
    • PublicLoanSummary
    • PublicProposalDetail
    • PublicProposalDetailResponse
    • PartnerListItem
    • PartnersPage
    • ListOfGroupsResponse
    • FgtsApplicationList
    • FgtsApplicationStatus
  1. Originação FGTS

Cria uma solicitação (application) e dispara a cotação

POST
/api/v1/fgts/applications
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.
Só o CPF é necessário: no FGTS quem determina o valor é o saldo do cliente, não um valor pedido.
Idempotency-Key é obrigatória. Repetir a chamada com a mesma chave e o mesmo corpo devolve a mesma solicitação, sem abrir outra nem cotar de novo — é assim que se reenvia com segurança após timeout de rede.

Requisição

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

Parâmetros Bodyapplication/jsonNecessário

Examples

Respostas

🟢202
application/json
Solicitação criada; a cotação está em curso.
Bodyapplication/json

🟠400
🟠401
🟠409
🟠422
🔴500
🔴502
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://gtw.unnotech.com.br/public/api/v1/fgts/applications' \
--header 'Idempotency-Key: 9f1c2b7e-4a58-4d3c-9e21-8b7f6a0d5c34' \
--header 'X-Api-External-Id: PEDIDO-2026-0001' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "customer": {
        "cpf": "12345678909"
    }
}'
Response Response Example
202 - Exemplo 1
{
    "application_id": "3f6a1b2c-8d4e-4f10-9a7b-2c5e6d8f0a13",
    "api_external_id": "PEDIDO-2026-0001",
    "status": "QUOTING",
    "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",
            "status": "AVAILABLE",
            "net_amount": 3418.72,
            "total_amount": 4200,
            "iof": 62.18,
            "cet_monthly": 1.79,
            "cet_annual": 23.71,
            "installments": [
                {
                    "due_date": "2027-04-01T00:00:00.000Z",
                    "amount": 512.44
                }
            ],
            "expires_at": "2026-07-27T18:45:00.000Z",
            "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-07-28 02:36:49
Página anterior
Busca applications pelo id externo do consumidor
Próxima página
Re-cota uma application (ofertas antigas invalidadas)
Built with