Submete o KYC (cadastro completo) exigido antes do aceite

POST

/api/v1/fgts/applications/{application_id}/kyc

Registra o cadastro completo do cliente. Obrigatório antes do aceite: aceitar sem KYC responde 409 KYC_REQUIRED.

Não exige Idempotency-Key, e propositalmente: a operação é upsert. Reenviar sobrescreve o cadastro, que é como se corrige um dado errado antes de contratar.

Os campos de desembolso em bank são os que valem na contratação. Quais são obrigatórios depende de disbursement_method — e a bancarizadora da oferta escolhida pode não suportar a forma pedida (aí o aceite responde DISBURSEMENT_DATA_REQUIRED).

Requisição

Authorization

JWT Bearer

Adicionar o parâmetro

Authorization

a Cabeçalhos

Exemplo:

Authorization: ********************

Parâmetros de Caminho

Parâmetros Bodyapplication/jsonNecessário

Examples

Respostas

🟢200

application/json

KYC registrado, como ficou armazenado.

Bodyapplication/json

🟠400

🟠401

🟠404

🟠422

🔴500

🔴502

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://gtw.unnotech.com.br/public/api/v1/fgts/applications/3f6a1b2c-8d4e-4f10-9a7b-2c5e6d8f0a13/kyc' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "Maria Souza Lima",
    "birth_date": "1988-04-17T00:00:00.000Z",
    "phone": "11987654321",
    "email": "maria.lima@example.com",
    "gender": "MALE",
    "civil_status": "SINGLE",
    "scholarity": "Ensino Superior Completo",
    "mothers_name": "Joana Souza Lima",
    "rg_number": "123456789",
    "rg_organ": "SSP",
    "rg_uf": "SP",
    "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"
    }
}'

Response Example

200 - Exemplo 1

{
    "name": "Maria Souza Lima",
    "birth_date": "1988-04-17T00:00:00.000Z",
    "phone": "11987654321",
    "email": "maria.lima@example.com",
    "gender": "MALE",
    "civil_status": "SINGLE",
    "scholarity": "Ensino Superior Completo",
    "mothers_name": "Joana Souza Lima",
    "rg_number": "123456789",
    "rg_organ": "SSP",
    "rg_uf": "SP",
    "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"
    }
}

Modificado em 2026-07-28 02:36:49

Página anterior

Lê o KYC (pré-preenchido quando disponível na plataforma)

Próxima página

Detalha uma application pelo id