1. CLT
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
        GET
      • Cria uma solicitação (application) de consignado CLT
        POST
      • Status enxuto da solicitação (para polling)
        GET
      • Detalha uma solicitação pelo id
        GET
      • Consulta o consentimento do trabalhador
        GET
      • Força uma nova verificação do consentimento
        POST
      • Consulta a margem consignável por vínculo
        GET
      • Simula e monta o menu de ofertas
        POST
      • Completa o cadastro do cliente
        PATCH
      • Lê o KYC (pré-preenchido quando disponível)
        GET
      • Submete o KYC exigido antes do aceite
        POST
      • Aceita uma oferta e inicia a contratação
        POST
  • 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. CLT

Submete o KYC exigido antes do aceite

POST
/api/v1/clt/applications/{application_id}/kyc
Registra o cadastro completo do cliente. Obrigatório antes do aceite.
Não exige Idempotency-Key, e propositalmente: a operação é upsert. Reenviar sobrescreve, que é como se corrige um dado errado antes de contratar.
Os campos de desembolso em bank são os que valem na contratação — informe a conta bancária ou a chave Pix. Sem um dos dois o aceite é recusado com DISBURSEMENT_DATA_REQUIRED.

Requisição

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

Parâmetros Bodyapplication/jsonNecessário

Examples

Respostas

🟢200OK
application/json
KYC registrado, como ficou armazenado.
Bodyapplication/json

🟠404Registo Não Encontrado
🟠422Erro de Parâmetro
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://gtw.unnotech.com.br/public/api/v1/clt/applications//kyc' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "Maria Souza Lima",
    "birth_date": "1988-04-17",
    "phone": "11987654321",
    "email": "maria.lima@example.com",
    "gender": "MALE",
    "civil_status": "SINGLE",
    "scholarity": "Ensino Superior Completo",
    "mothers_name": "Joana Souza Lima",
    "politically_exposed_person": false,
    "nationality": "Brasileira",
    "occupation": "Analista Administrativo",
    "rg_number": "123456789",
    "rg_organ": "SSP",
    "rg_uf": "SP",
    "rg_issue_date": "2010-03-22",
    "address": {
        "zip_code": "01310100",
        "uf": "SP",
        "city": "São Paulo",
        "district": "Bela Vista",
        "street": "Avenida Paulista",
        "number": "1578",
        "complement": "Apto 42"
    },
    "bank": {
        "disbursement_method": "PIX",
        "account_type": "CHECKING_ACCOUNT",
        "bank_code": "341",
        "agency": "0001",
        "agency_digit": "5",
        "account_number": "123456",
        "account_digit": "7",
        "pix_key": "maria.lima@example.com",
        "pix_type": "CPF"
    },
    "employer": {
        "email": "rh@empresa.com.br",
        "phone": "1133334444"
    }
}'
Response Response Example
200 - Exemplo 1
{
    "name": "Maria Souza Lima",
    "name_from_dataprev": true,
    "birth_date": "1988-04-17",
    "phone": "11987654321",
    "email": "maria.lima@example.com",
    "gender": "MALE",
    "civil_status": "SINGLE",
    "scholarity": "Ensino Superior Completo",
    "mothers_name": "Joana Souza Lima",
    "politically_exposed_person": false,
    "nationality": "Brasileira",
    "occupation": "Analista Administrativo",
    "rg_number": "123456789",
    "rg_organ": "SSP",
    "rg_uf": "SP",
    "rg_issue_date": "2010-03-22",
    "address": {
        "zip_code": "01310100",
        "uf": "SP",
        "city": "São Paulo",
        "district": "Bela Vista",
        "street": "Avenida Paulista",
        "number": "1578",
        "complement": "Apto 42"
    },
    "bank": {
        "disbursement_method": "PIX",
        "account_type": "CHECKING_ACCOUNT",
        "bank_code": "341",
        "agency": "0001",
        "agency_digit": "5",
        "account_number": "123456",
        "account_digit": "7",
        "pix_key": "maria.lima@example.com",
        "pix_type": "CPF"
    },
    "employer": {
        "email": "rh@empresa.com.br",
        "phone": "1133334444"
    }
}
Modificado em 2026-08-18 04:28:10
Página anterior
Lê o KYC (pré-preenchido quando disponível)
Próxima página
Aceita uma oferta e inicia a contratação
Built with