3. Cadastro da proposta

POST

/proposals/fgts

Esta seção da documentação descreve como realizar a requisição para cadastrar uma proposta de FGTS. É obrigatório que ao chegar aqui, você já tenha conseguido realizar a simulação e tenha o simulation_id. Sem ele voce não conseguirá concluir o cadastro.

Caso o digitador da proposta por API ou por plataforma pertença a um parceiro configurado como "varejista", o valor do split se torna obrigatório.

Requisição

Parâmetros Header

Parâmetros Bodyapplication/json

Examples

Respostas

🟢200Success

application/json

Body

🔴500Erro do servidor

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://develop.api.bankerize.com.br/v1/proposals/fgts' \
--header 'Authorization: ' \
--header 'X-User-Cpf;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "customer": {
        "pf": {
            "name": "Teste Bankerize",
            "cpf": "00459581309",
            "birth_date": "1960-12-10",
            "gender": "M",
            "civil_status_id": "2",
            "scholarity_id": "8",
            "rg_number": "123123",
            "rg_organ": "SSP",
            "rg_uf": "SP"
        },
        "contacts": {
            "email": "teste@teste.com.br",
            "celphone": "11987654321"
        },
        "address": {
            "zipcode": "04107030",
            "street": "Rua Guimarães Passos",
            "district": "Vila Mariana",
            "uf": "SP",
            "number": "323",
            "complement": "Casa",
            "city": "São Paulo"
        },
        "account": {
            "bank_id": "115",
            "type": "CCT",
            "agency": "0001",
            "agency_digit": "8",
            "account_number": "0045958",
            "account_digit": "6"
        }
    },
    "simulation": {
        "id": "c6982563-e033-4494-9c45-ed389acbec60"
    },
    "split": {
        "value": 100
    },
    "subscribers": [
        {
            "cpf": "29508441038",
            "name": "teste",
            "email": "teste@teste.com.br",
            "phone": "11987654321"
        }
    ]
}'

Response Example

200 - Example 1

{
  "data": {
    "proposal_code": "edf58e40-2090-4778-bcf7-48ee0f8b9f2e "
  },
  "message": "Proposta cadastrada com sucesso!"
}

Página anterior

2. Simulação por parcela

Próxima página

Introdução