--- page 1 --- Manual API V29.md 2025-1 1-04 1 / 56Documentação API - C6 Consignado A documentação a seguir detalha passos para usabilidade das APIs disponibilizadas no âmbito do Empréstimo Consignado e Empréstimo Garantia Saque-Aniversário (FGTS). Domínio do Ambiente O domínio a ser utilizado para autenticação é https://marketplace-proposal-service-api-p.c6bank.info Todas as requisições referenciadas neste documento são chamadas HTTPS para este domínio. . Domínio do Ambiente . Histórico de Versões . Autenticação . Gera token de acesso à API . Path e método da requisição: . Parâmetros enviados na requisição: . CURL Request exemplo: . Response exemplo da API . Simulação - Consignado . Campos enviados . EXEMPLOS de envio de requisição de simulação do consignado . Path e método da requisição: . Headers enviados na requisição: . Exemplo Request e response - Simulação INSS, Margem Livre, POR_VALOR_SOLICITADO, uma expense de Multiplo com exempt "Nao": . Exemplo Request e response - Simulação SIAPE, Refinanciamento, POR_VALOR_PARCELA, expense Pacote de Beneficios com exempt "Nao": . Campos enviados . EXEMPLOS de envio de requisição de inclusão do consignado . Path e método da requisição: . Headers enviados na requisição: . Exemplo Request e response - Inclusão INSS, Margem Livre, POR_VALOR_SOLICITADO, uma expense de Pacote de Beneficios com exempt "Nao": . Exemplo Request e response - Inclusão INSS, Refinanciamento, POR_VALOR_PARCELA, uma expense de Multiplos com exempt "Nao": . Simulação - FGTS . Campos enviados . Path e método da requisição: . Headers enviados na requisição: . Exemplo Request e response - Simulação FGTS, BY_INSTALLMENT_QUANTITY : . Exemplo Request e response - Simulação FGTS, BY_REQUESTED_AMOUNT : . Exemplo Request e response - Simulação FGTS, BY_FULL_AVALIABLE_AMOUNT : . Inclusão - FGTS . Campos enviados . Path e método da requisição: . Headers enviados na requisição: . Exemplo Request e response - Inclusão FGTS: --- page 2 --- Manual API V29.md 2025-1 1-04 2 / 56. Busca UPAG . Path e método da requisição: . Parâmetros enviados na requisição: . Exemplo de Request e Response da API: . Consultar proposta . Path e método da requisição: . Parâmetros enviados na requisição: . Exemplo de Request e Response da API: . Obter link de formalização . Path e método da requisição: . Parâmetros enviados na requisição: . Exemplo de Request e Response da API: . Movimentação de proposta . Path e método da requisição: . Parâmetros enviados na requisição: . Exemplo de Request e Response da API: . Geração de Link para Autorização de Consulta de Dados - Emprestimo do Trabalhador . Campos enviados . Path e método da requisição: . Headers enviados na requisição: . Exemplo Request e response - Geração de link de autorização : . Consulta de status da autorização do cliente . Campos enviados . Path e método da requisição: . Headers enviados na requisição: . Exemplo Request e response - Status da Autorização: . Geração de Oferta - Consignado Trabalhador . Campos enviados . Path e método da requisição: . Headers enviados na requisição: . Exemplo Request e response - Geração de oferta - Consignado Trabalhador : . Simulação de Propostas - Consignado Trabalhador . Campos enviados . Path e método da requisição: . Headers enviados na requisição: . Exemplos Request e response - Simulação de Propostas - Consignado Trabalhador : . Inclusão de Propostas - Consignado Trabalhador . Campos enviados . Path e método da requisição: . Headers enviados na requisição: . Exemplo Request e response - Inclusão de Propostas - Consignado Trabalhador : Histórico de Versões DataVersãoDescrição 04/05/2022V10 Buscar URL de formalização Digital Web da proposta 27/06/2022V11 Adicionadas despesas no payload de simulação --- page 3 --- Manual API V29.md 2025-1 1-04 3 / 56DataVersãoDescrição 27/06/2022V12 Renomeada propriedade 11/07/2022V14 Adicionado endpoint de Simulação de Propostas de Margem Livre 20/07/2022V16 Fix: campo income_amount não é obrigatório 25/07/2022V18 Adicionados códigos de erro de Simulação de Propostas de Margem Livre 02/08/2022V19Adição de funcionalidade para busca de órgãos associados aos convênios e Adição da inclusão de margem livre 06/12/2022V20 Alteração da simulação de consignado, obrigatoriedade do campo income_amount 14/12/2022V21 Adição do campo product_type_code na simulação 02/08/2023V22 Adição de novo filtro na simulação de Consignado 02/10/2023V23Versão 2 da API de Simulação e Inclusão FGTS 06/12/2023V24 Nova Api de Movimentação de Propostas 24/05/2024V25Suporte descontinuado a versão 1 da API FGTS e Inclusão do objeto não obrigatório de representante legal 20/03/2025V26 Inclusão do objeto expenses na simulação/inclusão do consignado 01/07/2025V27Novas APIs de Geração e envio de link de prova de vida via SMS e Consulta de status da análise da prova de vida dos clientes 18/09/2025V28 Nova API de Geração de Ofertas do Consignado Trabalhador 03/11/2025V29 Novas API de Simulação e Inclusão de propostas do Consignado Trabalhador Autenticação Gera token de acesso à API Para utilização das APIs desta documentação, é necessária a autenticação e uso do token retornado na API de autenticação, declarado no header access_token. O token deve ser informado nas requisições resumido, sem Bearer Path e método da requisição: https://marketplace-proposal-service-api-p.c6bank.info/auth/token método POST Parâmetros enviados na requisição: Campo Tipo Descrição Content-Type Header Preenchimento obrigatório: x-www-form-urlencoded username string Obrigatório. Usuário do sistema password string Obrigatório. Senha do sistema --- page 4 --- Manual API V29.md 2025-1 1-04 4 / 56CURL Request exemplo: curl --location --request POST 'https: //marketplace-proposal-service-api- p.c6bank.info/auth/token \ --header 'Content-Type: application/x-www-form-urlencoded' \ --data-urlencode 'username= 99999999999 _000001' \ --data-urlencode 'password=C6bank@ 1234' } Response exemplo da API { "access_token" : "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9. eyJhY2Nlc3NfdG9rZW4iOiJmYUlpbWJ0a3FuYjdBV1ZQVi1MQVJ4QURSY2 lJOTNvUG5RVVZuVC11SS1IUWVIcFdNM1BLbHdaTkJVYm9hOFF BYTQzOURQNUZjZ01RWEt1WHhmVDBjU2pkVFc4aktsc1NjWk43 YzRsVXdxRkJsWjVXQTN5dGhuV09FUE9rd2F6dThnY2hKclVCLXB SUi1TbktCM3Z0TlNsLWNnNWtFTS1ZbVF0dHFlREZjOVNBRzhrR29 3QTdDRnRjSFFBUGVNUlk4cEdwd0RsVTFBdkhKdEd1bkRDMjFyckd NRkozZ3JhbWFlLVpvczhCTnNITXpFSkhsVXBLWVVEUkRoTTVkeG 5XRDg3Uk0zOFVaRkJUN0o2aV9ZMEp2S EZlQWt6cHdoZmluLTJoTjM3a3J0MmJZVG9JRWNpOXhodEhzMGJpc GhYWjduWmR5MVNkT0VBQzd0UWc4cDJFRVJqMFhyVzdHQ0N0TXpJZ jktNzRXbHpISF9mZm4tbXdIT3hicHpYUzlNazkiLCJzdWIiOiJDNk JhbmtNYXJrZXRwbGFjZUhvbSIsImlzcyI6InVybjpcL1wvYzZiYW5rLW 1hcmtldHBsYWNlLWhvbSIsImV4cCI6MTc0MTcyODQyMCwiaWF0IjoxNzQ xNzI3MjIxLCJqdGkiOiIyZDVlYmU1NC01ZjUzLTRiMGQtYjc3NS1mND Q1OTQ5NzdjOGIiLCJ1c2VybmFtZSI6Imx1Y2FzLmZyYW5 jYW5pIn0.w_uzsRq0yQ04e4au8UK-58sx6rizYqOPf8qSVyKdGaI" , "expires_in_seconds" : 1199 } Simulação - Consignado Campos enviados Listagem de todos os campos enviados no objeto, sua obrigatoriedade e preenchimento Parâmetro Obrigatório Definição do campo operation_type SIMTipo de operação. Valores possíveis: NOVA, REFINANCIAMENTO product_type_code SIMCódigo do produto. Corresponde ao campo “Tipo de Produto” que é preenchido em tela. Margem Livre = 0001, Refinanciamento= 0002, Aumento Margem Livre = 0007 --- page 5 --- Manual API V29.md 2025-1 1-04 5 / 56Parâmetro Obrigatório Definição do campo simulation_type SIMTipo de simulação. Valores possíveis: POR_VALOR_SOLICITADO, POR_VALOR_PARCELA formalization_subtype SIMSubtipo de formalização. Valores possíveis: DIGITAL_WEB e PLUS promoter_code SIM Código de promotora correspondente covenant_group SIMGrupo do convênio (Empregador). Os valores possíveis são:INSS, SIAPE_SERVIDOR, SIAPE_PENSIONISTA public_agency SIMCódigo da agência pública. O default desse parâmetro é ‘000001ʼ. Os valores possíveis podem ser consultados na API de convênios por meio do path /marketplace/covenant-companies/public- agencies requested_amountPara simulation_type POR_VALOR_SOLICITADOValor solicitado a ser financiado. installment_amountPara simulation_type POR_VALOR_PARCELAValor a ser pago por parcela. installment_quantity SIM Quantidade de parcelas do financiamento client SIM Tipo complexo com os dados do cliente client.tax_identifier SIM Atributo do objeto client. CPF do cliente client.enrollment SIMAtributo do objeto client. Matrícula do cliente no empregador. client.founder_enrollmentQuando covenant_group SIAPE_PENSIONISTAAtributo do objeto client. Matrícula do instituidor client.birth_date SIMAtributo do objeto client. Data de nascimento do cliente client.income_amount SIM Atributo do objeto client. Valor da renda do cliente client.expenses NÃOAtributo do objeto client. Lista contendo os dados de despesa. Essa lista não é obrigatória. Ao ser informada e não isenta (conf. campo expenses) valores retornados pela API condizem com a inclusão da despesa na simulação. codeQuando incluso campo expensesAtributo do objeto expense. Código da despesa descriptionQuando incluso campo expensesAtributo do objeto expense. Descrição da despesa type_codeQuando incluso campo expensesAtributo do objeto expense. Código de tipo da despesa --- page 6 --- Manual API V29.md 2025-1 1-04 6 / 56Parâmetro Obrigatório Definição do campo item_numberQuando incluso campo expensesAtributo do objeto expense. Número do item da despesa group_codeQuando incluso campo expensesAtributo do objeto expense. Código do grupo de despesa AmountQuando incluso campo expensesAtributo do objeto expense. Valor debitado pela despesa exemptQuando incluso campo expensesAtributo do objeto expense. Esse atributo informa se essa despesa deve ser alterada para isenta ou para não isenta. Se isenta deve ser preenchido com ‘Simʼ se não isenta(se vai ser cobrada) deve ser preenchida com ‘Naoʼ financed_expenseQuando incluso campo expensesAtributo do objeto expense. Informa se a despesa é financiada description_typeQuando incluso campo expensesAtributo do objeto expense. Descrição do tipo de despesa observationQuando incluso campo expensesAtributo do objeto expense. Observação do tipo de despesa. changes_defaultQuando incluso campo expensesAtributo do objeto expense. Informa se a despesa altera principal minimum_amountQuando incluso campo expensesAtributo do objeto expense. Informa minimo da despesa maximum_amountQuando incluso campo expensesAtributo do objeto expense. Informa maximo da despesa refinancing_contractsSomente com parâmetro operation_type REFINANCIAMENTOLista de operações de contrato a serem refinanciadas EXEMPLOS de envio de requisição de simulação do consignado Path e método da requisição: https://marketplace-proposal-service-api- p.c6bank.info/marketplace/proposal/simulation , método POST Headers enviados na requisição: Header Descrição Content-Type Preenchimento: application/json Accept Preenchimento. application/vnd.c6bank_error_data_v2+json --- page 7 --- Manual API V29.md 2025-1 1-04 7 / 56Header Descrição Authorization Preenchimento. Token de autenticação obtido previamente Exemplo Request e response - Simulação INSS, Margem Livre, POR_VALOR_SOLICITADO, uma expense de Multiplo com exempt "Nao": Details CURL Request exemplo (clique aqui para visualizar) curl --location --request POST 'https: //marketplace-proposal-service-api- p.c6bank.info/marketplace/proposal/simulation' \ --header 'Accept: application/vnd.c6bank_error_data_v2+json' \ --header 'Content-Type: application/json' \ --header 'Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhY2Nlc3NfdG9rZW4iOiJNVHZfZ3FFN2VLSTlKU0p Jdkw2Q2VnMGJjWGpIb0JRdFNTT1JTYV9KOElFZTZIX3VzenpDcVRQcEZYS1hmUU85SmxBMmsxNVhLY0h iMU05VUVGWkRQb3ZaVURHd2taN3pGYTZTcWpGQzZaQ1UyUWZpdVZBRkkwTWl6eld5bWFmSkJ2eGNCdFJ 5TV8zTElBdGoyTlVZVjE0VHVxNEVLT29VbmFsVnRQMURHQ29Cd3l3ZUtORE9Sd3lLY0hpQ2g4THNxRW1 STXAtbHBpLTlfSWZZaWs3T0RBUlJxdGx1Q203aVJXTC1HVERRWU5OTlg4dGdzVFpiNm5KX3VsUHYtbl8 zR1ZKM3drNU13bXhYXzI5cUFyZUlfS09ZNGpqNVIxOHRza1hRM3dNOFJUWXF3d3BZRHA5UzZXWWNwaU4 5NzFqMHd0S1k4cDdNYjc2NkZNQmdVQ2hsaWwwMS05Z2wzTTJ0NWczMENHc2dESHV3QzN2WkV6OHhwMW4 4SU5fOGxJaGQiLCJzdWIiOiJDNkJhbmtNYXJrZXRwbGFjZUhvbSIsImlzcyI6InVybjpcL1wvYzZiYW5 rLW1hcmtldHBsYWNlLWhvbSIsImV4cCI6MTc0MjMxOTY2NywiaWF0IjoxNzQyMzE4NDY4LCJqdGkiOiI 4YWRhYjIxMC1jYzY1LTRkM2QtODMzMy0wOTYwZTUyNTBhNTciLCJ1c2VybmFtZSI6Imx1Y2FzLmZyYW5 jYW5pIn0.dsVlQLRahlr3lW2pugoqoniGfqXkrDiLWWrZBs62vcc' \ --data-raw '{ "operation_type" : "NOVA", "product_type_code" : "0001", "simulation_type" : "POR_VALOR_SOLICITADO" , "formalization_subtype" : "DIGITAL_WEB" , "promoter_code" : "000001" , "covenant_group" : "INSS", "public_agency" : "000001" , "requested_amount" : 6900, "installment_quantity" : 96, "client" : { "tax_identifier" : "123.456.789-07" , "enrollment" : "1234567890" , "birth_date" : "1980-10-10" , "income_amount" : 4000 }, "expenses" : [ { "code": "12", "description" : "SEGURO" , "type_code" : 104, "item_number" : 12, "group_code" : "2", "amount" : 500.0, "exempt" : "Nao", "financed_expense" : "Nao", "description_type" : "Pacote 4" , "observation" : "Esse pacote contém:\n-Assistência Funeral Individual - prestação de serviços funerários até R$ 5 mil\n(Não haverá --- page 8 --- Manual API V29.md 2025-1 1-04 8 / 56reembolso).\n-Descontos em Medicamentos na Rede Credenciada.\n-Descontos em Consultas e Exames na Rede Credenciada.\n-Telemedicina: 1 teleconsulta por ano - Clínico Geral.\n*Vigência de 18 meses." , "changes_default" : "Sim", "minimum_amount" : 500.0, "maximum_amount" : 99999999.0 } ] }' Response exemplo da API (clique aqui para visualizar) { "covenant" : { "code": "210177" , "description" : "INSS ML Normal - Web MULT" }, "product" : { "code": "000030" , "description" : "INSS ML DWEB" }, "installment_quantity" : 96, "requested_amount" : 6900.0, "principal_amount" : 7118.69, "installment_amount" : 159.69, "gross_amount" : 15330.24 , "iof_amount" : 218.69, "net_amount" : 6400.0, "client_amount" : 6400.0, "first_due_date" : "2025-05-07" , "last_due_date" : "2033-04-07" , "monthly_effective_total_cost_rate" : 2.11, "annual_effective_total_cost_rate" : 28.87, "monthly_customer_rate" : 1.8, "annual_customer_rate" : 23.8721, "expenses" : [ { "code": "12", "description" : "SEGURO" , "type_code" : 104, "item_number" : 12, "group_code" : "2", "amount" : 500.0, "exempt" : "Nao", "financed_expense" : "Nao", "description_type" : "Pacote 4" , "observation" : "Esse pacote contém:\n-Assistência Funeral Individual - prestação de serviços funerários até R$ 5 mil\n(Não haverá reembolso).\n-Descontos em Medicamentos na Rede Credenciada.\n-Descontos em Consultas e Exames na Rede Credenciada.\n-Telemedicina: 1 teleconsulta por ano - Clínico Geral.\n*Vigência de 18 meses." , "changes_default" : "Nao", "minimum_amount" : 500.0, "maximum_amount" : 99999999.0 }, --- page 9 --- Manual API V29.md 2025-1 1-04 9 / 56 { "code": "12", "description" : "SEGURO" , "type_code" : 105, "item_number" : 13, "group_code" : "2", "amount" : 750.0, "exempt" : "Sim", "financed_expense" : "Nao", "description_type" : "Pacote 5" , "observation" : "Esse pacote contém:\n-Assistência Funeral Individual - prestação de serviços funerários até R$ 5 mil.\n(Não haverá reembolso)\n-Descontos em Medicamentos na Rede Credenciada.\n-Descontos em Consultas e Exames na Rede Credenciada.\n-Telemedicina: Teleconsulta com Clinico Geral – utilização ilimitada e até 2 teleconsultas por ano com Geriatra\n*Vigência de 12 meses." , "changes_default" : "Nao", "minimum_amount" : 750.0, "maximum_amount" : 99999999.0 }, { "code": "12", "description" : "SEGURO" , "type_code" : 106, "item_number" : 14, "group_code" : "2", "amount" : 1000.0, "exempt" : "Sim", "financed_expense" : "Nao", "description_type" : "Pacote 6" , "observation" : "Esse pacote contém:\n-Assistência Funeral Individual, serviços funerários até R$ 6 mil (Não haverá reembolso).\n-Descontos em Medicamentos na Rede Credenciada.\n-Descontos em Consultas e Exames na Rede Credenciada.\n-Telemedicina: Teleconsulta ilimitada com Clinico Geral e até 2 teleconsultas com Geriatra.\n-Auxílio Cesta Básica de R$ 300 em caso de morte acid. do titular.\n*Vigência de 12 meses." , "changes_default" : "Nao", "minimum_amount" : 1000.0, "maximum_amount" : 99999999.0 }, { "code": "12", "description" : "SEGURO" , "type_code" : 107, "item_number" : 15, "group_code" : "2", "amount" : 1250.0, "exempt" : "Sim", "financed_expense" : "Nao", "description_type" : "Pacote 7 " , "observation" : "Esse pacote contém:\n-Assistência Funeral Individual – prestação de serviços funerários até R$ 5mil\n(Não haverá reembolso)\n-Descontos em Medicamentos na Rede Credenciada.\n-Descontos em Consultas e Exames na Rede Credenciada.\n-Telemedicina: Teleconsulta com Clinico Geral – utilização ilimitada e até 2 teleconsultas por ano com Geriatra.\n*Vigência de 18 meses." , "changes_default" : "Nao", --- page 10 --- Manual API V29.md 2025-1 1-04 10 / 56 "minimum_amount" : 1250.0, "maximum_amount" : 99999999.0 } ], "refinancing" : [] } Exemplo Request e response - Simulação SIAPE, Refinanciamento, POR_VALOR_PARCELA, expense Pacote de Beneficios com exempt "Nao": Details CURL Request exemplo (clique aqui para visualizar) curl --location --request POST 'https: //marketplace-proposal-service-api- p.c6bank.info/marketplace/proposal/simulation' \ --header 'Accept: application/vnd.c6bank_simulation_v1+json' \ --header 'Content-Type: application/json' \ --header 'Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhY2Nlc3NfdG9rZW4iOiJKYUlqTDZkYWRXcmtSRnB GQWxxc0JhS0Y3OWxURTh2ZHZJNmh2WW1NeVVtZ0Fpc2RpTERxMERMOWl5QjVGQng5TUwyS0RwYkVJNER wTGFvcnVxNXo5b1NCN1BoX2NqQU5sOERmR1JLV3gtYzZVc254OGEzdjRUd2Qta3AwNlFraTJHdEJFMnN FeTBLMF9UczRKUkM0cHdVRExQcTdqamdLM3RXdldOeVA3R2o1VDYtQzJFa3dlc2VTSDFJRnVnaHVLYVU 5bDhfemN5QVAxek1JQlJ2Ym1SU2pCdk1xLTBCNmh3bmNkUzRfSWJXYjN6aUpJRzUzUUt2dDVJQ2hLTU5 GdFlhdHVORWp5TWpWdGVtVlA0UUlCMGJtaEVNcFNSU0pfNllGbUIxOHJlcmFWSVRrLXlNN1RabVV4OGh uVHNKemxBWUExZkdTSkJWbUdPaVJKcVE5bnZSWnE1ZmRoUC12YWFGRXd2YmhpUWZibTVvOU9scU96eUZ hWGdvMnRKMHMiLCJzdWIiOiJDNkJhbmtNYXJrZXRwbGFjZUhvbSIsImlzcyI6InVybjpcL1wvYzZiYW5 rLW1hcmtldHBsYWNlLWhvbSIsImV4cCI6MTc0MjIzMjA5MCwiaWF0IjoxNzQyMjMwODkxLCJqdGkiOiI zYzE0MmI0NS1hMzNlLTRjYmItOGM3Yy0yNmM0ZWU2M2IxZGMiLCJ1c2VybmFtZSI6Imx1Y2FzLmZyYW5 jYW5pIn0.o-fdTdrVS6r-ZDJGLNOp9ngKUn4XB8fTQrFyFcXbQpQ' \ --data-raw '{ "operation_type" : "REFINANCIAMENTO" , "product_type_code" : "0002", "simulation_type" : "POR_VALOR_PARCELA" , "formalization_subtype" : "DIGITAL_WEB" , "promoter_code" : "000001" , "covenant_group" : "SIAPE_SERVIDOR" , "public_agency" : "017000" , "installment_quantity" : 96, "installment_amount" : 150.9, "client" : { "tax_identifier" : "123.456.789-10" , "enrollment" : "1234567" , "founder_enrollment" : "7564321" , "birth_date" : "1980-10-10" , "income_amount" : 4000 }, "expenses" : [ { "code": "18", "description" : "SEGURO" , "type_code" : 5, "item_number" : 3, "group_code" : "2", "amount" : 300.0, --- page 11 --- Manual API V29.md 2025-1 1-04 11 / 56 "exempt" : "Nao", "financed_expense" : "Nao", "description_type" : "PACOTE DE BENEFICIOS" , "observation" : "", "changes_default" : "Nao", "minimum_amount" : 0.0, "maximum_amount" : 300.0 } ], "refinancing_contracts" : ["900123456789" ] }' Response exemplo da API (clique aqui para visualizar) { "covenant" : { "code": "001033" , "description" : "SIAPE Refin 1 - Web" }, "product" : { "code": "000035" , "description" : "SIAPE REFIN DWEB" }, "installment_quantity" : 96, "requested_amount" : 6676.46, "principal_amount" : 6833.08, "installment_amount" : 150.9, "gross_amount" : 14486.4, "iof_amount" : 156.62, "net_amount" : 6376.46, "client_amount" : 4622.18, "first_due_date" : "2025-05-10" , "last_due_date" : "2033-04-10" , "monthly_effective_total_cost_rate" : 1.94, "annual_effective_total_cost_rate" : 26.4, "monthly_customer_rate" : 1.75, "annual_customer_rate" : 23.1439, "expenses" : [ { "code": "18", "description" : "SEGURO" , "type_code" : 5, "item_number" : 3, "group_code" : "2", "amount" : 300.0, "exempt" : "Nao", "financed_expense" : "Nao", "description_type" : "PACOTE DE BENEFICIOS" , "observation" : "", "changes_default" : "Nao", "minimum_amount" : 0.0, "maximum_amount" : 300.0 } ], "refinancing" : [ --- page 12 --- Manual API V29.md 2025-1 1-04 12 / 56 { "proposal_operation_number" : "900123456789" , "installments" : [ { "number" : "41", "amount" : 71.09 }, { "number" : "42", "amount" : 69.71 }, { "number" : "43", "amount" : 68.36 }, { "number" : "44", "amount" : 67.17 }, { "number" : "45", "amount" : 65.86 }, { "number" : "46", "amount" : 64.63 }, { "number" : "47", "amount" : 63.38 }, { "number" : "48", "amount" : 62.19 }, { "number" : "49", "amount" : 60.99 }, { "number" : "50", "amount" : 59.8 }, { "number" : "51", "amount" : 58.68 }, { "number" : "52", "amount" : 57.54 }, { "number" : "53", "amount" : 56.46 }, { "number" : "54", --- page 13 --- Manual API V29.md 2025-1 1-04 13 / 56 "amount" : 55.37 }, { "number" : "55", "amount" : 54.3 }, { "number" : "56", "amount" : 53.31 }, { "number" : "57", "amount" : 52.28 }, { "number" : "58", "amount" : 51.3 }, { "number" : "59", "amount" : 50.31 }, { "number" : "60", "amount" : 49.36 }, { "number" : "61", "amount" : 48.4 }, { "number" : "62", "amount" : 47.47 }, { "number" : "63", "amount" : 46.58 }, { "number" : "64", "amount" : 45.68 }, { "number" : "65", "amount" : 44.81 }, { "number" : "66", "amount" : 43.95 }, { "number" : "67", "amount" : 43.1 }, { "number" : "68", "amount" : 42.34 --- page 14 --- Manual API V29.md 2025-1 1-04 14 / 56 }, { "number" : "69", "amount" : 41.52 }, { "number" : "70", "amount" : 40.74 }, { "number" : "71", "amount" : 39.95 }, { "number" : "72", "amount" : 39.21 }, { "number" : "73", "amount" : 38.44 } ] } ] } Campos enviados Listagem de todos os campos enviados no objeto, sua obrigatoriedade e preenchimento Parâmetro Obrigatório Definição simulation_type SIMTipo de simulação que gerou os as condições de crédito. Valores possíveis: POR_VALOR_PARCELA ou POR_VALOR_SOLICITADO . Esse valor influencia na obrigatoriedade dos campos installment_amount e requested_amount. OBS: Para não haver divergência de valores, siga o mesmo preenchimento utilizado na simulação. formalization_subtype SIMSubtipo de formalização. Valores possíveis: DIGITAL_WEB ou PLUS --- page 15 --- Manual API V29.md 2025-1 1-04 15 / 56Parâmetro Obrigatório Definição operation_type SIMTipo de operação. Valores possíveis: NOVA , REFINANCIAMENTO origin SIMObjeto que define as informações do correspondente bancário. promoter_code SIMAtributo do objeto origin. Número de promotora do correspondente covenant_group SIMAtributo do objeto origin. Grupo do convênio (Empregador).  Os valores possíveis são: INSS SIAPE_SERVIDOR SIAPE_PENSIONISTA public_agency SIMAtributo do objeto origin. Orgão público vinculado ao convênio. Os valores possíveis podem ser consultados na API de convênios por meio do path /marketplace/covenant- companies/public- agencies informando o covenant_group typist_code SIMAtributo do objeto origin. Código do digitador obtido no sistema Função tax_identifier_of_certified_agent SIM CPF do agente certificado credit_condition SIMObjeto que defini as informações de crédito da proposta covenant_code SIMAtributo do objeto credit_codition. Código do convênio retornado na simulação product_code SIMAtributo do objeto credit_condition. Código do produto retornado na simulação --- page 16 --- Manual API V29.md 2025-1 1-04 16 / 56Parâmetro Obrigatório Definição installment_quantity SIMAtributo do objeto credit_condition. Quantidade de parcelas retornada na simulação principal_amount SIMAtributo do objeto credit_condition. Valor do principal retornado na simulação installment_amountQuando operation_type POR_VALOR_PARCELAAtributo do objeto credit_condition. Valor por parcelas retornado na simulação. Esse valor só é obrigatório caso o campo inclustion_type seja informado com o valor POR_VALOR_PARCELA requested_amountQuando operation_type POR_VALOR_SOLICITADOAtributo do objeto credit_condition. Valor solicitado retornado na simulação. Esse valor só é obrigatório caso o campo inclustion_type seja informado com o valor POR_VALOR_SOLICITADO iof_amount SIMAtributo do objeto credit_condition. Valor do iof retornado na simulação cliente_amount SIMAtributo do objeto credit_condition. Valor do cliente retornado na simulação first_due_date SIMAtributo do objeto credit_condition. Data da primeira parcela retonada na simulação last_due_date SIMAtributo do objeto credit_condition. Data da última parcela retonada na simulação monthly_effective_total_cost_rate SIMAtributo do objeto credit_condition. Taxa efetiva total mensal --- page 17 --- Manual API V29.md 2025-1 1-04 17 / 56Parâmetro Obrigatório Definição annual_effective_total_cost_rate SIMAtributo do objeto credit_condition. Taxa efetiva total anual monthly_customer_rate SIMAtributo do objeto credit_condition. Taxa mensal da proposta annual_customer_rate SIMAtributo do objeto credit_condition. Taxa anual da proposta expenses NÃOAtributo do objeto client. Lista contendo os dados de despesa. Essa lista não é obrigatória. Ao ser informada e não isenta (conf. campo expenses), a proposta será incluida com a despesa informada, se acatada. code Se incluso expensesAtributo do objeto expense. Código da despesa description Se incluso expensesAtributo do objeto expense. Descrição da despesa type_code Se incluso expensesAtributo do objeto expense. Código de tipo da despesa item_number Se incluso expensesAtributo do objeto expense. Número do item da despesa group_code Se incluso expensesAtributo do objeto expense. Código do grupo de despesa Amount Se incluso expensesAtributo do objeto expense. Valor debitado pela despesa --- page 18 --- Manual API V29.md 2025-1 1-04 18 / 56Parâmetro Obrigatório Definição exempt Se incluso expensesAtributo do objeto expense. Esse atributo informa se essa despesa deve ser alterada para isenta ou para não isenta. Se isenta deve ser preenchido com ‘Simʼ se não isenta(se vai ser cobrada) deve ser preenchida com ‘Naoʼ financed_expense Se incluso expensesAtributo do objeto expense. Informa se a despesa é financiada description_type Se incluso expensesAtributo do objeto expense. Descrição do tipo de despesa observation Se incluso expensesAtributo do objeto expense. Observação do tipo de despesa. changes_default Se incluso expensesAtributo do objeto expense. Informa se a despesa altera principal minimum_amount Se incluso expensesAtributo do objeto expense. Informa minimo da despesa maximum_amount Se incluso expensesAtributo do objeto expense. Informa maximo da despesa payment SIMObjeto que define as informações do cliente bank_code SIMAtributo do objeto payment. Número do banco agency_number SIMAtributo do objeto payment. Número da agência --- page 19 --- Manual API V29.md 2025-1 1-04 19 / 56Parâmetro Obrigatório Definição agency_digit SIMAtributo do objeto payment. Dígito da agência accountType SIMAtributo do objeto payment. Tipo da conta. Valores possíveis são: 1.       ContaCorrenteIndividual  2.       ContaPoupancaIndividual 3.       ContaSalario  4.       ContaCorrenteConjunta  5.       ContaPoupancaConjunta 6.       ContaInvestimento account_number SIMAtributo do objeto payment. Número da conta account_digit SIMAtributo do objeto payment. Dígito da conta client SIMObjeto que define as informações do cliente tax_identifier SIMAtributo do objeto client. CPF do cliente name SIMAtributo do objeto client. Nome do cliente document_type SIMAtributo do objeto client. Tipo do documento. Valores possíveis:  1.       RG 2.       RNE 3.       CTPS 4.       CNH 5.       CR 6.       NaoDefinido document_number SIMAtributo do objeto client. Número do documento document_federation_unit SIMAtributo do objeto client. Unidade federativa do documento --- page 20 --- Manual API V29.md 2025-1 1-04 20 / 56Parâmetro Obrigatório Definição issuance_date SIMAtributo do objeto client. Data de liberação do documento government_agency_which_has_issued_the_documentSIMAtributo do objeto client. Agência governamental que expediu o documento marital_status SIMAtributo do objeto client. Estado civil. Os valores possíveis são: 1.       Solteiro 2.       Casado 3.       Desquitado 4.       Divorciado 5.       Viuvo 6.       Outros politically_exposed_person SIMAtributo do objeto client. Pessoa politicamente exposta. Os valores possíveis são: 1.       Nao 2.       Sim birth_date SIMAtributo do objeto client. Data de nascimento do cliente gender SIMAtributo do objeto client. Gênero do cliente. Valores possíveis: 1.       Masculino 2.       Feminino spouse_name SIMAtributo do objeto client. Nome do conjuge income_amount SIMAtributo do objeto client. Valor da renda mensal do cliente mother_name SIMAtributo do objeto client. Nome da mãe do cliente email SIMAtributo do objeto client. Email do cliente mobile_phone_area_code SIMAtributo do objeto client. Código de área do celular do cliente --- page 21 --- Manual API V29.md 2025-1 1-04 21 / 56Parâmetro Obrigatório Definição mobile_phone_number SIMAtributo do objeto client. Número do celular do cliente bank_data SIMAtributo do objeto client. Dados bancários do cliente bank_code SIMAtributo do objeto bank_data. Número ou código do banco agency_number SIMAtributo do objeto bank_data. Número da agência agency_digit SIMAtributo do objeto bank_data. Dígito da agência account_type SIMAtributo do objeto bank_data. Tipo de conta. Os valores possíveis são: 1.       ContaCorrenteIndividual  2.       ContaPoupancaIndividual 3.       ContaSalario 4.       ContaCorrenteConjunta 5.       ContaPoupancaConjunta 6.       ContaInvestimento account_number SIMAtributo do objeto bank_data. Número da conta account_digit SIMAtributo do objeto bank_data. Dígito da conta benefit_data SIMAtributo do objeto client. Dados do benefício do cliente --- page 22 --- Manual API V29.md 2025-1 1-04 22 / 56Parâmetro Obrigatório Definição receive_card_benefit SIMAtributo do objeto benefit_data. Informa se o cliente recebe benefício via cartão. Valores possíveis 1.       Sim 2.       Nao federation_unit SIMAtributo do objeto benefit_data. Unidade federativa do benefício. Valores possíveis: Sigla do estado do benefício address SIMAtributo do objeto client. Dados de endereço do cliente street SIMAtributo do objeto address. Logradouro do endereço do cliente number SIMAtributo do objeto address. Número do endereço do cliente neighborhood SIMAtributo do objeto address. Bairro do endereço do cliente city SIMAtributo do objeto address. Cidade do endereço do cliente federation_unit SIMAtributo do objeto address. Unidade federativa do endereço do cliente zip_code SIMAtributo do objeto address. Código CEP do endereço do cliente professional_data SIMAtributo do objeto client. Dados profissionais do cliente enrollment SIMAtributo do objeto professional_data. Matrícula do cliente. --- page 23 --- Manual API V29.md 2025-1 1-04 23 / 56Parâmetro Obrigatório Definição founder_enrollmentQuando covenant_group SIAPE_PENSIONISTAAtributo do objeto professional_data. Matrícula do instituidor. Obrigatório caso a propriedade covenant_group assumir o valor  (SIAPE_PENSIONISTA) benefit_typeQuando covenant_group INSSAtributo do objeto professional_data. Tipo de benefício. É validado como um campo de 2 caracteres caso a propriedade covenant_group assumir o valor (INSS) Legal_representative NÃOObjeto que define os dados do representante legal do cliente (Se houver) NameSe incluso Legal_RepresentativeAtributo do objeto Legal Representative. Nome do Representante Legal Tax_identifierSe incluso Legal_RepresentativeAtributo do objeto Legal Representative. CPF do Representante Legal Tax_identifier_holder_releaseSe incluso Legal_RepresentativeAtributo do objeto Legal Representative. Define se o representante legal é titular da conta do beneficio. Valores possíveis: SIM ; NÃO Expiration_dateSe incluso Legal_RepresentativeAtributo do objeto Legal_Representative. Data de expiração do representante legal . Preenchimento “Ano- Mês-Dia”; Se não houver, preencher como “2079- 12-12”) Expiration_dateQuando Operation_type RefinanciamentoLista de contratos a serem refinanciados --- page 24 --- Manual API V29.md 2025-1 1-04 24 / 56EXEMPLOS de envio de requisição de inclusão do consignado Path e método da requisição: https://marketplace-proposal-service-api-p.c6bank.info/marketplace/proposal , método POST Headers enviados na requisição: Header Descrição Content-Type Preenchimento: application/json Accept Preenchimento. application/vnd.c6bank_error_data_v2+json Authorization Preenchimento. Token de autenticação obtido previamente Exemplo Request e response - Inclusão INSS, Margem Livre, POR_VALOR_SOLICITADO, uma expense de Pacote de Beneficios com exempt "Nao": CURL Request exemplo (clique aqui para visualizar) curl --location --request POST 'https: //marketplace-proposal-service-api- p.c6bank.info/marketplace/proposal' \ --header 'Accept: application/vnd.c6bank_error_data_v2+json' \ --header 'Content-Type: application/json' \ --header 'Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhY2Nlc3NfdG9rZW4iOiIzdFludVMyb2FtSW1zVm1 sRTEzRlAtRXBrRjd3SlU0V1J5endNQkcweGZtUEh0NU94c2lwWFczWUs4VENCRDBRYThzUHpPU01xRUN oazBXUWtIb2dDNUF6azJsaFdYVTh5X2FGNHZjbDZWVFZiUERiWnVWLW94T3RJQ0tFeFZ5a2htVmpyMGt udTlEcUpiLWEyeG5PMXBrblFBYVNMajA3eXJySHoxZnV3ZlJIZEtFajR4UEtROVRsdkVKN21vZ2JFTkN XVHFxOXFFOTZCbHVEX21SS0VMbF9rUmNoWnpyNkptRjNySmlxd1Y3T0VkVFg4ZHZRbHZ4aWdlbS1DTk0 4TUlGaHZrWFNNTXUzUV92U2haZXU0T012VEd4V1cyYmhFWFB0eXZPMURUZUNaSXdhQ295ZnhIanZnVjd oUXA4TC10aExFeGZ4Skg0Ymw0ZWk2YzdkUTJvMFppQ2NmbFFfZFBpWlB0V2JQRTV5a0JyUEZHX2tMUW8 4aWRJbnZWeHkiLCJzdWIiOiJDNkJhbmtNYXJrZXRwbGFjZUhvbSIsImlzcyI6InVybjpcL1wvYzZiYW5 rLW1hcmtldHBsYWNlLWhvbSIsImV4cCI6MTc0MjMyMTQ3MSwiaWF0IjoxNzQyMzIwMjcyLCJqdGkiOiJ mY2RlOTkzYy1kNTVjLTQ0NzUtYTJlMi1iNjc4ZThlY2UwZDEiLCJ1c2VybmFtZSI6Imx1Y2FzLmZyYW5 jYW5pIn0.jJxJnA2qmjaXixSXSS -7IQGKIga2p6es-IQ071Dircg' \ --data-raw '{ "formalization_subtype" : "PLUS", "operation_type" : "NOVA", "simulation_type" : "POR_VALOR_SOLICITADO" , "origin" : { "promoter_code" : "000001" , "covenant_group" : "INSS", "public_agency" : "000001" , "typist_code" : "000001" , "tax_identifier_of_certified_agent" : "98765432100" }, "credit_condition" : { "covenant_code" : "210161" , "product_code" : "210001" , "installment_quantity" : 96, --- page 25 --- Manual API V29.md 2025-1 1-04 25 / 56 "requested_amount" : 6900.0, "principal_amount" : 7118.82, "installment_amount" : 159.79, "gross_amount" : 15339.84 , "iof_amount" : 218.82, "net_amount" : 6600.0, "client_amount" : 6600.0, "first_due_date" : "2025-05-07" , "last_due_date" : "2033-04-07" , "monthly_effective_total_cost_rate" : 2.02, "annual_effective_total_cost_rate" : 27.48, "monthly_customer_rate" : 1.8, "annual_customer_rate" : 23.8721, "expenses" : [ { "code": "7", "description" : "SEGURO" , "type_code" : 5, "item_number" : 4, "group_code" : "2", "amount" : 300.0, "exempt" : "Nao", "financed_expense" : "Nao", "description_type" : "PACOTE DE BENEFICIOS" , "changes_default" : "Nao", "minimum_amount" : 0.0, "maximum_amount" : 300.0 } ] }, "payment" : { "bank_code" : "341", "agency_number" : "3740", "agency_digit" : "0", "account_type" : "ContaCorrenteIndividual" , "account_number" : "06515", "account_digit" : "0" }, "client" : { "tax_identifier" : "123.456.789-10" , "name": "TESTE SILVA" , "document_type" : "RG", "document_number" : "34534534-5" , "document_federation_unit" : "SP", "issuance_date" : "2012-12-20" , "government_agency_which_has_issued_the_document" : "SSP", "marital_status" : "Casado" , "politically_exposed_person" : "Nao", "birth_date" : "1956-11-29" , "gender" : "Masculino" , "spouses_name" : "Dona Marilda" , "income_amount" : 5000, "mother_name" : "Dona Maria" , "email": "TESTE_SILVA@HOTMAIL.COM" , "mobile_phone_area_code" : "11", "mobile_phone_number" : "940028922" , "bank_data" : { --- page 26 --- Manual API V29.md 2025-1 1-04 26 / 56 "bank_code" : "336", "agency_number" : "0001", "agency_digit" : "0", "account_type" : "ContaPoupancaIndividual" , "account_number" : "010101" , "account_digit" : "0" }, "benefit_data" : { "receive_card_benefit" : "Nao", "federation_unit" : "SP" }, "address" : { "zip_code" : "01406000" , "street" : "AV NOVE DE JULHO" , "number" : "3186", "neighborhood" : "JARDIM PAULISTA" , "city": "SÃO PAULO" , "federation_unit" : "SP" }, "professional_data" : { "enrollment" : "1250501250" , "benefit_type" : "42" } } }' Response exemplo da API (clique aqui para visualizar) Exemplo Request e response - Inclusão INSS, Refinanciamento, POR_VALOR_PARCELA, uma expense de Multiplos com exempt "Nao": CURL Request exemplo (clique aqui para visualizar) curl --location --request POST 'https: //marketplace-proposal-service-api- p.c6bank.info/marketplace/proposal' \ --header 'Accept: application/vnd.c6bank_error_data_v2+json' \ --header 'Content-Type: application/json' \ --header 'Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhY2Nlc3NfdG9rZW4iOiJYZi13OXkxdktmLUNPak4 tb3N5Ri1IMDJFWDJHUXI1dDBhbnhTam1MMURIRjJqaG5OWDhRTTdyWGZ0SllkTkQ3b1o4S21UUUlESU1 vNWt4NWtRT3Azb0RxaS1ZN3VWblZVNERvUjR3Mm1WVFZVa0ExRkotREc0QnhuYWJyUGZFOElhZkUxTng 2R1JRcmM1YWRZeGR5NmhKQnoxaWJram9SeF9PSVJlOXZkNmRlQ1JnS3dybWVfblBVU3lvZmt1RjQ5dEw 0bE5xcmNfd1ZfRnU1RW51NURsV2kyeU5JTWdSTHVvMXNfWkJlMFdfUjVnR2toRWVXOHpOd1VIV1hJMkV zT2VEVHdVcnA1NnVId0Q3SjlDZ2ZUT0pqeHZ1XzlLYUFmZlBrNEJmaE1oTGVRVjJEbGtlUXdKX182TFh yX1hFckFybktVN2Job1BCNGQteFFEUkt1d2ExVDVWTzNDNmRuWWRRODN0ZzJiQWowWWc2Wk5DOUNBU0x BRHlGaG9tV3MiLCJzdWIiOiJDNkJhbmtNYXJrZXRwbGFjZUhvbSIsImlzcyI6InVybjpcL1wvYzZiYW5 rLW1hcmtldHBsYWNlLWhvbSIsImV4cCI6MTc0MTcwNzE1NCwiaWF0IjoxNzQxNzA1OTU1LCJqdGkiOiJ hM2Y3OTUxZC1kYWEyLTRjMGItOTQ0OS01Y2YzYTc5OTVhMDAiLCJ1c2VybmFtZSI6Imx1Y2FzLmZyYW5 jYW5pIn0 .7L-_dhY3dDUF275k3eET0P1wiSeGyhomRL_pam730xg' \ --data-raw '{ "formalization_subtype" : "DIGITAL_WEB" , "operation_type" : "REFINANCIAMENTO" , "simulation_type" : "POR_VALOR_SOLICITADO" , "origin" : { "promoter_code" : "000001" , --- page 27 --- Manual API V29.md 2025-1 1-04 27 / 56 "covenant_group" : "INSS", "public_agency" : "000001" , "typist_code" : "000001" , "tax_identifier_of_certified_agent" : "12312312323" }, "credit_condition" : { "covenant_code" : "250107" , "product_code" : "000033" , "installment_quantity" : 96, "requested_amount" : 1000.0, "principal_amount" : 1007.01, "installment_amount" : 22.68, "gross_amount" : 2177.28, "iof_amount" : 7.01, "net_amount" : 925.0, "client_amount" : 70.37, "first_due_date" : "2025-05-07" , "last_due_date" : "2033-04-07" , "monthly_effective_total_cost_rate" : 2.04, "annual_effective_total_cost_rate" : 27.86, "monthly_customer_rate" : 1.8, "annual_customer_rate" : 23.8721, "expenses" : [ { "code": "12", "description" : "SEGURO" , "type_code" : 101, "item_number" : 4, "group_code" : "2", "amount" : 75.0, "exempt" : "Nao", "financed_expense" : "Nao", "description_type" : "Pacote 1" , "observation" : "Esse pacote contém:?\n- Assistência Nutricional ou Emocional: até 2 teleconsultas por ano, conforme escolha do cliente.?\n*Vigência de 12 meses.?" , "changes_default" : "Nao", "minimum_amount" : 75.0, "maximum_amount" : 99999999.0 } ] }, "payment" : { "bank_code" : "336", "agency_number" : "0001", "agency_digit" : "0", "account_type" : "ContaCorrenteIndividual" , "account_number" : "012345" , "account_digit" : "9" }, "client" : { "tax_identifier" : "123.499.590-90" , "name": "TESTE SILVA" , "document_type" : "RG", "document_number" : "78910117-9" , "document_federation_unit" : "SP", "issuance_date" : "2012-12-20" , --- page 28 --- Manual API V29.md 2025-1 1-04 28 / 56 "government_agency_which_has_issued_the_document" : "SSP", "marital_status" : "Casado" , "politically_exposed_person" : "Nao", "birth_date" : "1956-11-29" , "gender" : "Masculino" , "spouses_name" : "Dona Marilda" , "income_amount" : 5000, "mother_name" : "Dona Maria" , "email": "TESTE_SILVA@HOTMAIL.COM" , "mobile_phone_area_code" : "11", "mobile_phone_number" : "942284455" , "bank_data" : { "bank_code" : "341", "agency_number" : "3740", "agency_digit" : "0", "account_type" : "ContaPoupancaIndividual" , "account_number" : "06515", "account_digit" : "0" }, "benefit_data" : { "receive_card_benefit" : "Nao", "federation_unit" : "SP" }, "address" : { "zip_code" : "01310100" , "street" : "AV PAULISTA" , "number" : "671", "neighborhood" : "BELA VISTA" , "city": "SÃO PAULO" , "federation_unit" : "SP" }, "professional_data" : { "enrollment" : "1230001234" , "benefit_type" : "42" } }, "refinancing_contracts" : [ "9008006001" , "9008006002" , "9008006003" ] }' Response exemplo da API (clique aqui para visualizar) { "proposal_number" : "9990019999" } Simulação - FGTS A simulação das propostas de FGTS pode ser feita por: --- page 29 --- Manual API V29.md 2025-1 1-04 29 / 56. BY_INSTALLMENT_QUANTITY (Por quantidade de parcelas), . BY_REQUESTED_AMOUNT (Por valor solicitado), . BY_FULL_AVAILABLE_AMOUNT (Por valor total) Campos enviados Listagem de todos os campos enviados no objeto, sua obrigatoriedade e preenchimento Parâmetro Obrigatório Definição do campo simulation_type SIMTipo de simulação. Valores possíveis: - BY_INSTALLMENT_QUANTITY - BY_REQUESTED_AMOUNT - BY_FULL_AVAILABLE_AMOUNT tax_identifier SIM CPF do cliente birth_date SIM Data de nascimento do cliente. Ex: "1975-10-18" covenant_code SIM Código do convênio (Tabela de Financiamento) installment_quantityQuando simulation_type for BY_INSTALLMENT_QUANTITYDefine a quantidade de parcelas da simulação. Deve ser enviado apenas para o “simulation_type”: “BY_INSTALLMENT_QUANTITY” financed_amountQuando simulation_type for BY_REQUESTED_AMOUNTDefine o valor da antecipação. Deve ser enviado apenas para o “simulation_type”: “BY_REQUESTED_AMOUNT” promoter_code SIM Código de promotora do correspondente. Path e método da requisição: https://marketplace-proposal-service-api- p.c6bank.info/marketplace/proposal/fgts/simulation , método POST Headers enviados na requisição: Header Descrição Content-Type Preenchimento: application/json Accept Preenchimento. application/vnd.c6bank_fgts_simulation_v2+json Authorization Preenchimento. Token de autenticação obtido previamente Exemplo Request e response - Simulação FGTS, BY_INSTALLMENT_QUANTITY : CURL Request exemplo (clique aqui para visualizar) curl --location --request POST 'https: //marketplace-proposal-service-api- p.c6bank.info/marketplace/proposal/fgts/simulation' \ --header 'Accept: application/vnd.c6bank_fgts_simulation_v2+json' \ --header 'Content-Type: application/json' \ --- page 30 --- Manual API V29.md 2025-1 1-04 30 / 56--header 'Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhY2Nlc3NfdG9rZW4iOiJlOFlWaFZlZ3c4d2ItUWc xc1RHMi05elhUaU9jbTFfdi1HVnQtd1dnTWZWZXE3OEZybFByRkVaalhzZHBsdExHNW9lMGEzUHIwUW4 zWWlWTWFoWkRzUGxWc2tBSHJhLVVtZTVGVUxpbmNNZ2NNbG1FbVZaRFYzLWx0RUJtYzdieGZvTlNLQjB KM1BBekRkSkJadEtJYmdxNHpaQkZRdEtIbnJtdC1JY0JzemhEdVhDTGdsV1Y3NUZQM2ZjMkhaU3B3enB LY0pfLTFTSGJ6cHpWaE8xYXVZSG1FeEN2WjJlOTkyY09ndkhLRjNEMDlvSEhwOFBYaW0xSWpKcTl2MlN 1OERVcHA2VEM1dEliVk9GVmFYWUI3MnY2V1Rwb0dsXzV3TXI3b2dhLW9ZTjRGY01XRWU1YzlXNk1mdHN KaENuYm5WYk9uOXdNNnNwSTNweEVuaC1FaGg4akJzTUlwUmtaWjBDUDdqNW1UZUx1QUxKeU1naHM2UWh Gd0c0NldkYi0iLCJzdWIiOiJDNkJhbmtNYXJrZXRwbGFjZUhvbSIsImlzcyI6InVybjpcL1wvYzZiYW5 rLW1hcmtldHBsYWNlLWhvbSIsImV4cCI6MTc0MjMyNzc0NSwiaWF0IjoxNzQyMzI2NTQ2LCJqdGkiOiI zNTcwMGEyMi03MjkxLTRlN2QtYTRmOS02NjMwMmE2OTNhNDMiLCJ1c2VybmFtZSI6Imx1Y2FzLmZyYW5 jYW5pIn0.vyHdrs8l1oO1oQb5A_uJ2QtnjUDOtcE8dK3YKCPnfP8' \ --data-raw '{ "covenant_code" :"610001" , "formalization_subtype" :"DIGITAL_WEB" , "simulation_type" :"BY_INSTALLMENT_QUANTITY" , "installment_quantity" :5, "tax_identifier" :"02010140430" , "birth_date" :"1986-07-23" , "promoter_code" :"000001" } ' Response exemplo da API (clique aqui para visualizar) { "installment_quantity" : 5, "requested_amount" : 23082.31 , "principal_amount" : 23682.49 , "gross_amount" : 35046.53 , "net_amount" : 23082.31 , "iof_amount" : 600.18, "monthly_customer_rate" : 1.799, "annual_customer_rate" : 23.8575, "monthly_effective_total_cost_rate" : 1.9345, "annual_effective_total_cost_rate" : 26.2533, "monthly_appropriation_rate" : 1.799, "annual_appropriation_rate" : 23.8574, "installments" : [ { "number" : 1, "amount" : 7746.15, "due_date" : "2025-05-01T00:00:00" }, { "number" : 2, "amount" : 7358.84, "due_date" : "2026-05-01T00:00:00" }, { "number" : 3, "amount" : 6990.9, "due_date" : "2027-05-01T00:00:00" }, { --- page 31 --- Manual API V29.md 2025-1 1-04 31 / 56 "number" : 4, "amount" : 6641.35, "due_date" : "2028-05-01T00:00:00" }, { "number" : 5, "amount" : 6309.29, "due_date" : "2029-05-01T00:00:00" } ], "expenses" : [ { "code": 10, "type_code" : 6, "item_number" : 12, "group_code" : "2", "exempt" : true, "financed_expense" : false, "type": "SEGURO" , "amount" : 300.0 } ], "anniversary_withdraw_available" : 62164.87 , "simulation_id" : "01JPNC2JVB6ZAGVR8D7WF8G56Q" , "expire_at" : "2025-03-18T23:59:59.999999999" } Exemplo Request e response - Simulação FGTS, BY_REQUESTED_AMOUNT : CURL Request exemplo (clique aqui para visualizar) curl --location --request POST 'https: //marketplace-proposal-service-api- p.c6bank.info/marketplace/proposal/fgts/simulation' \ --header 'Accept: application/vnd.c6bank_fgts_simulation_v2+json' \ --header 'Content-Type: application/json' \ --header 'Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhY2Nlc3NfdG9rZW4iOiJlOFlWaFZlZ3c4d2ItUWc xc1RHMi05elhUaU9jbTFfdi1HVnQtd1dnTWZWZXE3OEZybFByRkVaalhzZHBsdExHNW9lMGEzUHIwUW4 zWWlWTWFoWkRzUGxWc2tBSHJhLVVtZTVGVUxpbmNNZ2NNbG1FbVZaRFYzLWx0RUJtYzdieGZvTlNLQjB KM1BBekRkSkJadEtJYmdxNHpaQkZRdEtIbnJtdC1JY0JzemhEdVhDTGdsV1Y3NUZQM2ZjMkhaU3B3enB LY0pfLTFTSGJ6cHpWaE8xYXVZSG1FeEN2WjJlOTkyY09ndkhLRjNEMDlvSEhwOFBYaW0xSWpKcTl2MlN 1OERVcHA2VEM1dEliVk9GVmFYWUI3MnY2V1Rwb0dsXzV3TXI3b2dhLW9ZTjRGY01XRWU1YzlXNk1mdHN KaENuYm5WYk9uOXdNNnNwSTNweEVuaC1FaGg4akJzTUlwUmtaWjBDUDdqNW1UZUx1QUxKeU1naHM2UWh Gd0c0NldkYi0iLCJzdWIiOiJDNkJhbmtNYXJrZXRwbGFjZUhvbSIsImlzcyI6InVybjpcL1wvYzZiYW5 rLW1hcmtldHBsYWNlLWhvbSIsImV4cCI6MTc0MjMyNzc0NSwiaWF0IjoxNzQyMzI2NTQ2LCJqdGkiOiI zNTcwMGEyMi03MjkxLTRlN2QtYTRmOS02NjMwMmE2OTNhNDMiLCJ1c2VybmFtZSI6Imx1Y2FzLmZyYW5 jYW5pIn0.vyHdrs8l1oO1oQb5A_uJ2QtnjUDOtcE8dK3YKCPnfP8' \ --data-raw '{ "covenant_code" :"610001" , "formalization_subtype" :"DIGITAL_WEB" , "simulation_type" :"BY_REQUESTED_AMOUNT" , "financed_amount" : 3000, "tax_identifier" :"02010140430" , "birth_date" :"1986-07-23" , "promoter_code" :"000001" --- page 32 --- Manual API V29.md 2025-1 1-04 32 / 56} ' Response exemplo da API (clique aqui para visualizar) { "installment_quantity" : 1, "requested_amount" : 3000.0, "principal_amount" : 3022.39, "gross_amount" : 3102.47, "net_amount" : 3000.0, "iof_amount" : 22.39, "monthly_customer_rate" : 1.799, "annual_customer_rate" : 23.8575, "monthly_effective_total_cost_rate" : 2.3164, "annual_effective_total_cost_rate" : 32.1297, "monthly_appropriation_rate" : 1.799, "annual_appropriation_rate" : 23.8573, "installments" : [ { "number" : 1, "amount" : 3102.47, "due_date" : "2025-05-01T00:00:00" } ], "expenses" : [ { "code": 10, "type_code" : 6, "item_number" : 12, "group_code" : "2", "exempt" : true, "financed_expense" : false, "type": "SEGURO" , "amount" : 300.0 } ], "anniversary_withdraw_available" : 62164.87 , "simulation_id" : "01JPNC852R01VV3N9G82R3Z6D0" , "expire_at" : "2025-03-18T23:59:59.999999999" } Exemplo Request e response - Simulação FGTS, BY_FULL_AVALIABLE_AMOUNT : CURL Request exemplo (clique aqui para visualizar) curl --location --request POST 'https: //marketplace-proposal-service-api- p.c6bank.info/marketplace/proposal/fgts/simulation' \ --header 'Accept: application/vnd.c6bank_fgts_simulation_v2+json' \ --header 'Content-Type: application/json' \ --header 'Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhY2Nlc3NfdG9rZW4iOiJlOFlWaFZlZ3c4d2ItUWc xc1RHMi05elhUaU9jbTFfdi1HVnQtd1dnTWZWZXE3OEZybFByRkVaalhzZHBsdExHNW9lMGEzUHIwUW4 --- page 33 --- Manual API V29.md 2025-1 1-04 33 / 56zWWlWTWFoWkRzUGxWc2tBSHJhLVVtZTVGVUxpbmNNZ2NNbG1FbVZaRFYzLWx0RUJtYzdieGZvTlNLQjB KM1BBekRkSkJadEtJYmdxNHpaQkZRdEtIbnJtdC1JY0JzemhEdVhDTGdsV1Y3NUZQM2ZjMkhaU3B3enB LY0pfLTFTSGJ6cHpWaE8xYXVZSG1FeEN2WjJlOTkyY09ndkhLRjNEMDlvSEhwOFBYaW0xSWpKcTl2MlN 1OERVcHA2VEM1dEliVk9GVmFYWUI3MnY2V1Rwb0dsXzV3TXI3b2dhLW9ZTjRGY01XRWU1YzlXNk1mdHN KaENuYm5WYk9uOXdNNnNwSTNweEVuaC1FaGg4akJzTUlwUmtaWjBDUDdqNW1UZUx1QUxKeU1naHM2UWh Gd0c0NldkYi0iLCJzdWIiOiJDNkJhbmtNYXJrZXRwbGFjZUhvbSIsImlzcyI6InVybjpcL1wvYzZiYW5 rLW1hcmtldHBsYWNlLWhvbSIsImV4cCI6MTc0MjMyNzc0NSwiaWF0IjoxNzQyMzI2NTQ2LCJqdGkiOiI zNTcwMGEyMi03MjkxLTRlN2QtYTRmOS02NjMwMmE2OTNhNDMiLCJ1c2VybmFtZSI6Imx1Y2FzLmZyYW5 jYW5pIn0.vyHdrs8l1oO1oQb5A_uJ2QtnjUDOtcE8dK3YKCPnfP8' \ --data-raw '{ "covenant_code" :"610001" , "formalization_subtype" :"DIGITAL_WEB" , "simulation_type" :"BY_FULL_AVAILABLE_AMOUNT" , "tax_identifier" :"02010140430" , "birth_date" :"1986-07-23" , "promoter_code" :"000001" } ' Response exemplo da API (clique aqui para visualizar) { "installment_quantity" : 10, "requested_amount" : 29063.32 , "principal_amount" : 29872.28 , "gross_amount" : 62164.87 , "net_amount" : 29063.32 , "iof_amount" : 808.96, "monthly_customer_rate" : 1.799, "annual_customer_rate" : 23.8575, "monthly_effective_total_cost_rate" : 1.8872, "annual_effective_total_cost_rate" : 25.5416, "monthly_appropriation_rate" : 1.799, "annual_appropriation_rate" : 23.8574, "installments" : [ { "number" : 1, "amount" : 7746.15, "due_date" : "2025-05-01T00:00:00" }, { "number" : 2, "amount" : 7358.84, "due_date" : "2026-05-01T00:00:00" }, { "number" : 3, "amount" : 6990.9, "due_date" : "2027-05-01T00:00:00" }, { "number" : 4, "amount" : 6641.35, "due_date" : "2028-05-01T00:00:00" }, --- page 34 --- Manual API V29.md 2025-1 1-04 34 / 56 { "number" : 5, "amount" : 6309.29, "due_date" : "2029-05-01T00:00:00" }, { "number" : 6, "amount" : 5993.82, "due_date" : "2030-05-01T00:00:00" }, { "number" : 7, "amount" : 5694.13, "due_date" : "2031-05-01T00:00:00" }, { "number" : 8, "amount" : 5409.43, "due_date" : "2032-05-01T00:00:00" }, { "number" : 9, "amount" : 5138.95, "due_date" : "2033-05-01T00:00:00" }, { "number" : 10, "amount" : 4882.01, "due_date" : "2034-05-01T00:00:00" } ], "expenses" : [ { "code": 10, "type_code" : 6, "item_number" : 12, "group_code" : "2", "exempt" : true, "financed_expense" : false, "type": "SEGURO" , "amount" : 300.0 } ], "anniversary_withdraw_available" : 62164.87 , "simulation_id" : "01JPND10MBADW4CQY0FSBYSNCM" , "expire_at" : "2025-03-18T23:59:59.999999999" } Inclusão - FGTS Campos enviados Listagem de todos os campos enviados no objeto, sua obrigatoriedade e preenchimento --- page 35 --- Manual API V29.md 2025-1 1-04 35 / 56Parâmetro ObrigatórioDefinição Parâmetro ObrigatórioDefinição simulation_id SIM Id da simulação promoter_code SIM Número de promotora do correspondente typist_code SIM Código do digitador tax_identifier_of_certified_agentSIM CPF do agente certificado Table_Code SIM Código da tabela da simulação Requested_amount SIM Quantia total solicitada na simulação client SIM Objeto que define as informações do client. tax_identifier SIM Atributo do objeto client. CPF do cliente. name SIM Atributo do objeto client. Nome do cliente. nationality_code SIMAtributo do objeto client. Nacionalidade do cliente. Valores possíveis: “01” (Brasileiro) “02” (Estrangeiro) document_number SIM Atributo do objeto client. Número do documento do cliente. document_federation_unit SIMAtributo do objeto client. Sigla da unidade federativa do documento do cliente. Ex: SP, RN, BA, MG, AM, etc. document_issuance_date SIMData de emissão do documento. Obs: Deve ser uma data mais nova do que a data definida no parâmetro birth_date. document_issuing_state SIMAtributo do objeto client. Órgão emissor do documento. Ex: SSP marital_status SIMAtributo do objeto client. Estado civíl. Valores possíveis:  Solteiro Casado SeparadoJudicialmente Divorciado Viuvo Desquitado Outros UniaoEstavel birth_date SIM Atributo do objeto client. Data de nascimento do cliente. gender SIMAtributo do objeto client. Gênero do cliente. Valores possíveis: Masculino Feminino NaoDefinido income_amount SIM Atributo do objeto client. Valor da renda do cliente. other_income_amount SIM Atributo do objeto client. Valor de outros tipos de renda --- page 36 --- Manual API V29.md 2025-1 1-04 36 / 56Parâmetro ObrigatórioDefinição mother_name SIM Atributo do objeto client. Nome da mãe do cliente pep SIMAtributo do objeto client. Informa se o cliente é uma pessoa politicamente exposta. Valores possíveis: Sim Não email SIM Atributo do objeto client. Email do cliente. mobile_phone_area_code SIM Atributo do objeto client. DDD do telefone celular do cliente mobile_phone_number SIMAtributo do objeto client. Número do telefone celular do cliente address SIMAtributo do objeto client. Objeto contendo os atributos do endereço do cliente. street SIMAtributo do objeto adress. Rua ou avenida do endereço do cliente. number SIM Atributo do objeto adress. Número do endereço do cliente neighborhood SIM Atributo do objeto adress. Bairro do endereço do cliente city SIM Atributo do objeto adress. Cidade do endereço do cliente federation_unit SIMAtributo do objeto adress. Sigla da unidade federativa do endereço do cliente. Ex: RN, MG, AM, SP, PR, RS zip_code SIM Atributo do objeto address. CEP do endereço do cliente bank_data SIMAtributo do objeto client. Define os dados bancários do cliente. bank_code SIM Atributo do objeto bank_data. Código do banco do cliente. agency_number SIMAtributo do objeto bank_data. Número da agência do banco do cliente. agency_digit SIMAtributo do objeto bank_data. Dígito da agência do banco do cliente. account_type SIMAtributo do objeto bank_data. Tipo de conta bancária do cliente. Valores possíveis:  ContaCorrenteIndividual ContaPoupancaIndividual ContaSalario ContaCorrenteConjunta ContaPoupancaConjunta ContaInvestimento account_number SIMAtributo do objeto bank_data. Número da conta bancária do cliente. account_digit SIMAtributo do objeto bank_data. Número do dígito da conta bancária do cliente. --- page 37 --- Manual API V29.md 2025-1 1-04 37 / 56Parâmetro ObrigatórioDefinição spouse_name NÃOAtributo do objeto client. Nome do cônjuge do cliente. Caso não tenha cônjuge esse campo não deverá ser informado. Path e método da requisição: https://marketplace-proposal-service-api- p.c6bank.info/marketplace/proposal/fgts/simulation , método POST Headers enviados na requisição: Header Descrição Content-Type Preenchimento: application/json Accept Preenchimento. application/vnd.c6bank_fgts_simulation_v2+json Authorization Preenchimento. Token de autenticação obtido previamente Exemplo Request e response - Inclusão FGTS: CURL Request exemplo (clique aqui para visualizar) curl --location --request POST 'https: //marketplace-proposal-service-api- p.c6bank.info/marketplace/proposal/fgts' \ --header 'Accept: application/vnd.c6bank_fgts_include_v2+json' \ --header 'Content-Type: application/json' \ --header 'Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhY2Nlc3NfdG9rZW4iOiJ1TDl2MkQzUkI1ZFQxSnQ 5YTRCTzJUZ1JMNndjTHFLT1pyVmlFNlJCVFhMNlJ5Mm1RNklfU1VCNG1ramk1T2RvZHpXNWtYQmpIdUJ 2c05fV3BsTTJNNE9YOEl0bkVYZXhQTThha1lvd3RmUVRJbzFxbWx6TkNJaFBPcG94bDlFUHR0SEpPMEN Da1RHLVJEVGUyRUctYXpUcDlEanUydHRwTmpneHhKYkt0Y0kzbVl0UTRibkRPNFptR3VyaUVGaHJfcHA 1N2d4Z09sZ2lGVlBhQUE2OTRiTlp2Y0VHNmpnREhhMklZaFp1Uk9yclRWdGVPRTNMSm83R25fc0VMT1J HMDVMOEtjNEVNaHplc3hKUGk3US1MSHZBNkt2Tk10Mi1NVDlfbExWZ0FSeXUzTWVfZHo2MVBwODRYWHR KandkUE9qaG9lOFdydk5McXA0Qlh5YzFSbGd3RVJLaGtUZndCd1pIT2JqdHFsbU4zRThnUHRhOWNYT0R vTVM4UU4wWm8iLCJzdWIiOiJDNkJhbmtNYXJrZXRwbGFjZUhvbSIsImlzcyI6InVybjpcL1wvYzZiYW5 rLW1hcmtldHBsYWNlLWhvbSIsImV4cCI6MTc0MjMzMTE5NiwiaWF0IjoxNzQyMzI5OTk3LCJqdGkiOiJ iMzhhZGVhZS05YzlkLTQzMzMtOTA5MS1lMDE5ODJhMWFlNzMiLCJ1c2VybmFtZSI6Imx1Y2FzLmZyYW5 jYW5pIn0.LD2o5w9VDhzZKhv48shGz_ODh9fMvQ15AbwkE5eH3pY' \ --data-raw '{ "simulation_id" : "01JPND10MBADW4CQY0FSBYSNCM" , "requested_amount" : 22896.68 , "promoter_code" : "000001" , "typist_code" : "000001" , "tax_identifier_of_certified_agent" : "12332145678" , "table_code" : "610001" , "formalization_subtype" : "DIGITAL_WEB" , "client" : { "tax_identifier" : "02118249330" , "name": "Teste Sobrenome" , "nationality_code" : "01", --- page 38 --- Manual API V29.md 2025-1 1-04 38 / 56 "document_type" : "RG", "document_number" : "34567890" , "document_federation_unit" : "SP", "document_issuance_date" : "2024-05-18" , "document_issuing_state" : "SSP", "marital_status" : "MARRIED" , "birth_date" : "2000-07-18" , "gender" : "MALE", "income_amount" : 5.000, "other_income_amount" : 250.0, "mother_name" : "Maria de Jesus" , "pep": false, "email": "user@example.com" , "mobile_phone_area_code" : "10", "mobile_phone_number" : "999009190" , "address" : { "street" : "AV PAULISTA" , "number" : "671", "neighborhood" : "BELA VISTA" , "city": "SÃO PAULO" , "federation_unit" : "SP", "zip_code" : "01310100" }, "bank_data" : { "bank_code" : "336", "agency_number" : "0001", "agency_digit" : "1", "account_type" : "INDIVIDUAL_CHECKING_ACCOUNT" , "account_number" : "99999", "account_digit" : "5" }, "spouse_name" : "Jose de Deus" }, "installments" : [ { "number" : 1, "amount" : 7746.15, "due_date" : "2025-05-01T00:00:00" }, { "number" : 2, "amount" : 7358.84, "due_date" : "2026-05-01T00:00:00" }, { "number" : 3, "amount" : 6990.9, "due_date" : "2027-05-01T00:00:00" }, { "number" : 4, "amount" : 6641.35, "due_date" : "2028-05-01T00:00:00" }, { "number" : 5, "amount" : 6309.29, --- page 39 --- Manual API V29.md 2025-1 1-04 39 / 56 "due_date" : "2029-05-01T00:00:00" } ], "expenses" : [ { "code": 10, "type_code" : 1, "item_number" : 11, "group_code" : "1", "exempt" : false, "financed_expense" : true, "type": "TARIFA DE CADASTRO" , "amount" : 100.0 } ] }' Response exemplo da API (clique aqui para visualizar) { "proposal_number" : "555290005" } Busca UPAG A busca de public_agencies, preenchido na simulação / inclusão de propostas do Consignado, utiliza o covenant_group (Empregador) como chave de pesquisa. Esta API tem uso primário para o consignado SIAPE, onde a public_agency determina a UPAG do cliente. Path e método da requisição: O endpoint tem 3 preenchimentos possíveis na raíz, de acordo com o covenant-group buscado, todas utilizando método GET. São estes: https://marketplace-proposal-service-api-p.c6bank.info/marketplace/covenant- companies/covenant-groups/SIAPE_SERVIDOR https://marketplace-proposal-service-api-p.c6bank.info/marketplace/covenant- companies/covenant-groups/SIAPE_PENSIONISTA https://marketplace-proposal-service-api-p.c6bank.info/marketplace/covenant- companies/covenant-groups/INSS Parâmetros enviados na requisição: Campo Descrição Accept Preenchimento. application/vnd.c6bank_public_agencies_v1+json Authorization Obrigatório. Token de acesso gerado anteriormente --- page 40 --- Manual API V29.md 2025-1 1-04 40 / 56Exemplo de Request e Response da API: CURL Request exemplo (clique para abrir) curl --location --request GET 'https: //marketplace-proposal-service-api- p.c6bank.info/marketplace/covenant-companies/covenant-groups/SIAPE_SERVIDOR' \ --header 'Accept: application/vnd.c6bank_public_agencies_v1+json' \ --header 'Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhY2Nlc3NfdG9rZW4iOiIxeEY3OF93ektJX2x0U2M wSUhhQ05vSTQyOGRIYlBTUGV1WjFRaVNSZGRBaF9SMHRQZFI3anU4akN0bTh2NWdrZU00U2hZb2Z3T2l wOUd1OGNXM1VCdkZrSHVfakJZN2FzY210T2pvLVZVWkVDX21MN2tweTlZUjdpZnUyMTBIb2pyT045Mk9 kd2gyTjNWTzF2RVdQc056TDdFVEg1LTl2UzlZeXhJcXI4YnJWWUE5Z0lfaXhqcWpmSWRJbXRNVjYxWl9 EWWVZRWJSdDlEMVF5am93WWJnd0l4bWlvcWl6N1FqSm0wUDQ5MjlFUllhejBmX0RjNmE5Y0lqQjdYZ2F MRG1GNTVTUU1HY2ExOS0zTzVOUHNEQ0NDNHdycUNRdHRYbW1PY0tkeXEyY01TQ194SDQ3YldodV9paFJ 5T0lWUm1FYnNfb090SG5UNUxkbXYwMXJvRUl4b2xUZjFrd3duaURtVzFKYURObmx2bDhBVlMzTTNFS2R DcDFZMHpRS1AiLCJzdWIiOiJDNkJhbmtNYXJrZXRwbGFjZUhvbSIsImlzcyI6InVybjpcL1wvYzZiYW5 rLW1hcmtldHBsYWNlLWhvbSIsImV4cCI6MTc0MjM5Njc5MiwiaWF0IjoxNzQyMzk1NTkzLCJqdGkiOiI 1ZjUxZTIzMi1mYjNkLTQ2MWUtOGYwOS1kYjRhYjQyZWFiNmQiLCJ1c2VybmFtZSI6Imx1Y2FzLmZyYW5 jYW5pIn0.epZjWOWe4TVRN5GuTFtwxj3a5-GOK9r0Knfc4JwiL5w' Response exemplo da API (clique para abrir) { "public_agencies" : [ { "code": "013000" , "description" : "MINIST.DA AGRIC" }, { "code": "013100" , "description" : "MIN DO DESENV A" } ] } Consultar proposta A API de consulta propostas permite a visualização de informações de uma proposta dentro do sistema, situação atual (campo situation), atividade em que a proposta se encontra (campo current_activity_description), Código e status de formalização (campos formalization_status e formalization_code), bem como todos os dados e valores cadastrados. Path e método da requisição: O endpoint utiliza método GET, e parâmetro único proposalNumber igual ao número da proposta buscada https://marketplace-proposal-service-api-p.c6bank.info/marketplace/proposal? proposalNumber=110111001 --- page 41 --- Manual API V29.md 2025-1 1-04 41 / 56Parâmetros enviados na requisição: Header Descrição Accept Obrigatório. application/vnd.c6bank_fgts_consult_v2+json Authorization Obrigatório. Token de acesso gerado anteriormente Exemplo de Request e Response da API: CURL Request exemplo (clique para abrir) curl --location --request GET ' https: //marketplace-proposal-service-api- p.c6bank.info/marketplace/proposal?proposalNumber=410161382' \ --header 'Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhY2Nlc3NfdG9rZW4iOiJpU0hqQlVjTk1nYi1idHl FUWdnRGZFaHNWb1VBQlhHT1NoMTlfN1N3SFl2SEN4eWVZdklBbHlad19iUk9zcUJlOHhasfSAklnLNSK NFKFNDzNFJSTVdsdfshRb1BoMG9EYzFfWld4OU9qWVNGemZOb1NZSU10dXdNAMCjdfMCmBlU1Y3eVJOZ ENKMk9PZkNZTnhQUnhfeHBjRmFHbDVfeElTM0UxSUIwRzhNQnpKeTQ4N0hwV2g4ZGUyUzNHUDRhcDZ3T kY1dk1TeUE0X2dYdlQ3VnhjdHAyM2cwMlhyNXd3RzJKTlpyUlhUaGxrSjc0aWZRWkkxVFVFQTZ4bThTd DBlSEsdfsdfWsdfsdfVJQaEZqZ3BpRnlrLWZacGJMcGVkSi1NQW1ORDBBbmJwcFVxSjRZMk5HU2NockR MOGw3ZVk4LUFxSjE4TEl3OUVLM2pITkVaYURxU19XeXdIUUw4SjdDWlJ6ejFVbFZJU2hsdm5Qc3RtQUF sYUFsczduWURPbUQtX08iLCJzAMDMDFDIJFJEOIJEIhvbSIsImlzcyI6InVybjpcL1wvYzZiYW5rLW1h cmtldHBsYWNlLWhvbSIsdfsdfsdfYkasFKSLFKSDFLSKkKSFJSKDF0IjoxNjQzNjg1Nzc5LCJqdGkiOi IxNDJhNDJjYS04YjliLTRhOGItOTRhZi02ODVlMDk1YTdhMjIiLCJ1c2VybmFtZSI6IlNWQ19ESUdJVE FMIn0.m6ugaTWl-Y522eMqoKQ1P3rCdfsdfAOPSFKAOKFDvA ' \ --header 'Content-Type: application/json' \ --header 'Accept: application/vnd.c6bank_fgts_consult_v2+json' Response exemplo da API (clique para abrir) { "proposal_number" : "string" , "operation_number" : "string" , "operation_type" : "string" , "registration_date" : "2022-01-24" , "login_typist" : "string" , "financing_table_code" : "string" , "formalization_type" : "string" , "formalization_sub_type_description" : "string" , "formalization_status" : "String" , "formalizationCode" : 0, "loan_track" : { "situation" : "string" , "current_activity_number" : 0, "activity_last_update" : "2022-01-24T20:19:33.821Z" , "current_activity_description" : "string" }, "agreement" : { "description" : "string" --- page 42 --- Manual API V29.md 2025-1 1-04 42 / 56 }, "product" : { "description" : "string" , "code": "string" }, "origins" : [ { "type": "string" , "code": "string" , "description" : "string" } ], "liberations" : [ { "beneficiary_type" : "string" , "way_liberation" : "string" , "document_type" : "string" , "value": 0, "agency_digit" : "string" , "agency_number" : "string" , "account_number" : "string" , "account_digit" : "string" , "bank_code" : "string" } ], "client" : { "tax_identifier" : "string" , "name": "string" , "document_type" : "string" , "document_number" : "string" , "marital_status" : "Solteiro" , "birth_date" : "2022-01-24" , "enrolment" : "string" , "address" : { "type": "string" , "street" : "string" , "number" : "string" , "neighborhood" : "string" , "city": "string" , "federation_unit" : "AC", "zip_code" : "string" }, "phone_numbers" : [ { "type": "string" , "phone_number_area_code" : "string" , "phone_number" : "string" } ] }, "credit_condition" : { "date": "2022-01-24T20:19:33.821Z" , "requested_amount" : 0, "gross_amount" : 0, "principal_amount" : 0, "net_amount" : 0, "installment_quantity" : 0, --- page 43 --- Manual API V29.md 2025-1 1-04 43 / 56 "installment_amount" : 0, "iof_amount" : 0, "first_due_date" : "2022-01-24" , "last_due_date" : "2022-01-24" , "taxes": { "monthly_customer_rate" : 0, "annual_customer_rate" : 0, "monthly_effective_total_cost_rate" : 0, "annual_effective_total_cost_rate" : 0, "monthly_appropriation_rate" : 0, "annual_appropriation_rate" : 0, "monthly_nominal_rate" : 0, "annual_nominal_rate" : 0 } } } Obter link de formalização A API de obter link de formalização consulta uma proposta e retorna seu link de formalização digital, bem como o status deste link (se está ativo ou não). Para uso ideal desta API, propostas devem estar com status condizente a geração de link de formalização, não reprovadas/canceladas e com validações prévias a geração de link já feitas. Path e método da requisição: O endpoint utiliza método GET, e parâmetro único proposalNumber igual ao número da proposta buscada https://marketplace-proposal-service-api- p.c6bank.info/marketplace/proposal/formalization-url?proposalNumber=900123456 Parâmetros enviados na requisição: Header Descrição Accept Obrigatório. application/vnd.c6bank_url_consult_v1+json Authorization Obrigatório. Token de acesso gerado anteriormente Exemplo de Request e Response da API: CURL Request exemplo (clique para abrir) curl --location --request GET ' https: //marketplace-proposal-service-api- p.c6bank.info/marketplace/proposal/formalization-url?proposalNumber=410161382' \ --header 'Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhY2Nlc3NfdG9rZW4iOiJpU0hqQlVjTk1nYi1idHl FUWdnRGZFaHNWb1VBQlhHT1NoMTlfN1N3SFl2SEN4eWVZdklBbHlad19iUk9zcUJlOHhasfSAklnLNSK NFKFNDzNFJSTVdsdfshRb1BoMG9EYzFfWld4OU9qWVNGemZOb1NZSU10dXdNAMCjdfMCmBlU1Y3eVJOZ ENKMk9PZkNZTnhQUnhfeHBjRmFHbDVfeElTM0UxSUIwRzhNQnpKeTQ4N0hwV2g4ZGUyUzNHUDRhcDZ3T --- page 44 --- Manual API V29.md 2025-1 1-04 44 / 56kY1dk1TeUE0X2dYdlQ3VnhjdHAyM2cwMlhyNXd3RzJKTlpyUlhUaGxrSjc0aWZRWkkxVFVFQTZ4bThTd DBlSEsdfsdfWsdfsdfVJQaEZqZ3BpRnlrLWZacGJMcGVkSi1NQW1ORDBBbmJwcFVxSjRZMk5HU2NockR MOGw3ZVk4LUFxSjE4TEl3OUVLM2pITkVaYURxU19XeXdIUUw4SjdDWlJ6ejFVbFZJU2hsdm5Qc3RtQUF sYUFsczduWURPbUQtX08iLCJzAMDMDFDIJFJEOIJEIhvbSIsImlzcyI6InVybjpcL1wvYzZiYW5rLW1h cmtldHBsYWNlLWhvbSIsdfsdfsdfYkasFKSLFKSDFLSKkKSFJSKDF0IjoxNjQzNjg1Nzc5LCJqdGkiOi IxNDJhNDJjYS04YjliLTRhOGItOTRhZi02ODVlMDk1YTdhMjIiLCJ1c2VybmFtZSI6IlNWQ19ESUdJVE FMIn0.m6ugaTWl-Y522eMqoKQ1P3rCdfsdfAOPSFKAOKFDvA ' \ --header 'Content-Type: application/json' \ --header 'Accept: application/vnd.c6bank_url_consult_v1+json' Response exemplo da API (clique para abrir) { "url": "http://web.c6consig.com.br/EPKwPMm5kcyvkJPN" , "status" : "ACTIVE" } Movimentação de proposta A API de movimentação de propostas permite movimentação em fases determinadas da esteira. As fases aceitas são: 105, 127, 1127, 3096. As decisões aceitas são: APPROVE, REPROVED, PENDING e CANCEL. O campo reason_code é opcional Path e método da requisição: O endpoint utiliza método POST, na seguinte URL https://marketplace-proposal-service-api- p.c6bank.info/marketplace/proposal/formalization-url?proposalNumber=900123456 Parâmetros enviados na requisição: Header Descrição Authorization Obrigatório. Token de acesso gerado anteriormente Exemplo de Request e Response da API: CURL Request exemplo (clique para abrir) curl --location 'https: //marketplace-proposal- in.hom.core.gondor.infra/marketplace/proposal/movement' \ --header 'Accept: application/json' \ --header 'Authorization: [access_token]' \ --header 'Content-Type: application/json' \ --data '{ "proposal_number" : "960916155" , "decision_number" : "105", --- page 45 --- Manual API V29.md 2025-1 1-04 45 / 56 "action" : "APPROVE" , "reasons" : [ 833000 ] }' Geração de Link para Autorização de Consulta de Dados - Emprestimo do Trabalhador A API de geração de link de autorização permite que seja gerada uma URL para os clientes fazerem uma jornada para autorização de consulta de dados referentes ao empréstimo do trabalhador. Após geração, no endpoint subsequente, poderá ser checado se a autorização foi aprovada, está pendente ou reprovou/expirou. Campos enviados Listagem de todos os campos enviados no objeto, sua obrigatoriedade e preenchimento Parâmetro ObrigatórioDefinição do campo nome SIM Nome do cliente cpf SIM CPF do cliente data_nascimentoSIM Data de nascimento do cliente. Ex: "1975-10-18" telefone NÃO Objeto que define as informações do telefone do cliente numero NÃO Número do telefone celular do cliente codigo_area NÃO DDD do telefone celular do cliente Path e método da requisição: https://marketplace-proposal-service-api- p.c6bank.info/marketplace/authorization/generate-liveness , método POST Headers enviados na requisição: Header Descrição Content-Type Preenchimento: application/json Accept Preenchimento: application/vnd.c6bank_authorization_generate_liveness_v1+json Authorization Preenchimento: Token de autenticação obtido previamente Exemplo Request e response - Geração de link de autorização : CURL Request exemplo (clique aqui para visualizar) --- page 46 --- Manual API V29.md 2025-1 1-04 46 / 56curl --location --request POST 'https: //marketplace-proposal-service-api- p.c6bank.info/marketplace/authorization/generate-liveness' \ --header 'Accept: application/vnd.c6bank_authorization_generate_liveness_v1+json' \ --header 'Content-Type: application/json' \ --header 'Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhY2Nlc3NfdG9rZW4iOiJlOFlWaFZlZ3c4d2ItUWc xc1RHMi05elhUaU9jbTFfdi1HVnQtd1dnTWZWZXE3OEZybFByRkVaalhzZHBsdExHNW9lMGEzUHIwUW4 zWWlWTWFoWkRzUGxWc2tBSHJhLVVtZTVGVUxpbmNNZ2NNbG1FbVZaRFYzLWx0RUJtYzdieGZvTlNLQjB KM1BBekRkSkJadEtJYmdxNHpaQkZRdEtIbnJtdC1JY0JzemhEdVhDTGdsV1Y3NUZQM2ZjMkhaU3B3enB LY0pfLTFTSGJ6cHpWaE8xYXVZSG1FeEN2WjJlOTkyY09ndkhLRjNEMDlvSEhwOFBYaW0xSWpKcTl2MlN 1OERVcHA2VEM1dEliVk9GVmFYWUI3MnY2V1Rwb0dsXzV3TXI3b2dhLW9ZTjRGY01XRWU1YzlXNk1mdHN KaENuYm5WYk9uOXdNNnNwSTNweEVuaC1FaGg4akJzTUlwUmtaWjBDUDdqNW1UZUx1QUxKeU1naHM2UWh Gd0c0NldkYi0iLCJzdWIiOiJDNkJhbmtNYXJrZXRwbGFjZUhvbSIsImlzcyI6InVybjpcL1wvYzZiYW5 rLW1hcmtldHBsYWNlLWhvbSIsImV4cCI6MTc0MjMyNzc0NSwiaWF0IjoxNzQyMzI2NTQ2LCJqdGkiOiI zNTcwMGEyMi03MjkxLTRlN2QtYTRmOS02NjMwMmE2OTNhNDMiLCJ1c2VybmFtZSI6Imx1Y2FzLmZyYW5 jYW5pIn0.vyHdrs8l1oO1oQb5A_uJ2QtnjUDOtcE8dK3YKCPnfP8' \ --data-raw '{ "nome":"Nome Teste" , "cpf":"08887744532" , "data_nascimento" :"1986-07-23" , "telefone" : { "numero" :"997773344" , "codigo_area" :"11" } }' Response exemplo da API (clique aqui para visualizar) { "link": "http://web.c6consig.com.br/EPKwPMm5kcyvkJPN" , "data_expiracao" : "yyyy-MM-dd" } Consulta de status da autorização do cliente A API de consulta de stautos da autorização retorna se a autorização gerada no endpoint anterior foi aprovada, está pendente ou foi reprovada/expirada. Campos enviados Listagem de todos os campos enviados no objeto, sua obrigatoriedade e preenchimento ParâmetroObrigatórioDefinição do campo cpf SIM CPF do cliente Path e método da requisição: --- page 47 --- Manual API V29.md 2025-1 1-04 47 / 56https://marketplace-proposal-service-api- p.c6bank.info/marketplace/authorization/status , método POST Headers enviados na requisição: Header Descrição Content-Type Preenchimento: application/json Accept Preenchimento: application/vnd.c6bank_authorization_status_v1+json Authorization Preenchimento: Token de autenticação obtido previamente Exemplo Request e response - Status da Autorização: CURL Request exemplo (clique aqui para visualizar) curl --location --request POST 'https: //marketplace-proposal-service-api- p.c6bank.info/marketplace/authorization/status' \ --header 'Accept: application/vnd.c6bank_authorization_status_v1+json' \ --header 'Content-Type: application/json' \ --header 'Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhY2Nlc3NfdG9rZW4iOiJlOFlWaFZlZ3c4d2ItUWc xc1RHMi05elhUaU9jbTFfdi1HVnQtd1dnTWZWZXE3OEZybFByRkVaalhzZHBsdExHNW9lMGEzUHIwUW4 zWWlWTWFoWkRzUGxWc2tBSHJhLVVtZTVGVUxpbmNNZ2NNbG1FbVZaRFYzLWx0RUJtYzdieGZvTlNLQjB KM1BBekRkSkJadEtJYmdxNHpaQkZRdEtIbnJtdC1JY0JzemhEdVhDTGdsV1Y3NUZQM2ZjMkhaU3B3enB LY0pfLTFTSGJ6cHpWaE8xYXVZSG1FeEN2WjJlOTkyY09ndkhLRjNEMDlvSEhwOFBYaW0xSWpKcTl2MlN 1OERVcHA2VEM1dEliVk9GVmFYWUI3MnY2V1Rwb0dsXzV3TXI3b2dhLW9ZTjRGY01XRWU1YzlXNk1mdHN KaENuYm5WYk9uOXdNNnNwSTNweEVuaC1FaGg4akJzTUlwUmtaWjBDUDdqNW1UZUx1QUxKeU1naHM2UWh Gd0c0NldkYi0iLCJzdWIiOiJDNkJhbmtNYXJrZXRwbGFjZUhvbSIsImlzcyI6InVybjpcL1wvYzZiYW5 rLW1hcmtldHBsYWNlLWhvbSIsImV4cCI6MTc0MjMyNzc0NSwiaWF0IjoxNzQyMzI2NTQ2LCJqdGkiOiI zNTcwMGEyMi03MjkxLTRlN2QtYTRmOS02NjMwMmE2OTNhNDMiLCJ1c2VybmFtZSI6Imx1Y2FzLmZyYW5 jYW5pIn0.vyHdrs8l1oO1oQb5A_uJ2QtnjUDOtcE8dK3YKCPnfP8' \ --data-raw '{ "cpf":"08887744532" }' Response exemplo da API (clique aqui para visualizar) { "status" : "AGUARDANDO_AUTORIZACAO/AUTORIZADO/NAO_AUTORIZADO" , "observacao" : "Observação sobre o status" } Geração de oferta - Consignado Trabalhador API responsável pela geração de oferta para o Consignado Trabalhador. Campos enviados --- page 48 --- Manual API V29.md 2025-1 1-04 48 / 56Listagem de todos os campos enviados no objeto, sua obrigatoriedade e preenchimento ParâmetroObrigatórioDefinição do campo cpf SIM CPF do cliente Path e método da requisição: https://marketplace-proposal-service-api-p.c6bank.info/marketplace/worker- payroll-loan-offers, método POST Headers enviados na requisição: Header Descrição Content-Type Preenchimento: application/json Accept Preenchimento: application/vnd.c6bank_generate_offer_v1+json Authorization Preenchimento: Token de autenticação obtido previamente Exemplo Request e response - Geração de oferta - Consignado Trablhador: CURL Request exemplo (clique aqui para visualizar) curl --location --request POST 'https: //marketplace-proposal-service-api- p.c6bank.info/marketplace/worker-payroll-loan-offers' \ --header 'Accept: application/vnd.c6bank_generate_offer_v1+json' \ --header 'Content-Type: application/json' \ --header 'Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhY2Nlc3NfdG9rZW4iOiJlOFlWaFZlZ3c4d2ItUWc xc1RHMi05elhUaU9jbTFfdi1HVnQtd1dnTWZWZXE3OEZybFByRkVaalhzZHBsdExHNW9lMGEzUHIwUW4 zWWlWTWFoWkRzUGxWc2tBSHJhLVVtZTVGVUxpbmNNZ2NNbG1FbVZaRFYzLWx0RUJtYzdieGZvTlNLQjB KM1BBekRkSkJadEtJYmdxNHpaQkZRdEtIbnJtdC1JY0JzemhEdVhDTGdsV1Y3NUZQM2ZjMkhaU3B3enB LY0pfLTFTSGJ6cHpWaE8xYXVZSG1FeEN2WjJlOTkyY09ndkhLRjNEMDlvSEhwOFBYaW0xSWpKcTl2MlN 1OERVcHA2VEM1dEliVk9GVmFYWUI3MnY2V1Rwb0dsXzV3TXI3b2dhLW9ZTjRGY01XRWU1YzlXNk1mdHN KaENuYm5WYk9uOXdNNnNwSTNweEVuaC1FaGg4akJzTUlwUmtaWjBDUDdqNW1UZUx1QUxKeU1naHM2UWh Gd0c0NldkYi0iLCJzdWIiOiJDNkJhbmtNYXJrZXRwbGFjZUhvbSIsImlzcyI6InVybjpcL1wvYzZiYW5 rLW1hcmtldHBsYWNlLWhvbSIsImV4cCI6MTc0MjMyNzc0NSwiaWF0IjoxNzQyMzI2NTQ2LCJqdGkiOiI zNTcwMGEyMi03MjkxLTRlN2QtYTRmOS02NjMwMmE2OTNhNDMiLCJ1c2VybmFtZSI6Imx1Y2FzLmZyYW5 jYW5pIn0.vyHdrs8l1oO1oQb5A_uJ2QtnjUDOtcE8dK3YKCPnfP8' \ --data-raw '{ "cpf":"08887744532" }' Response exemplo da API (clique aqui para visualizar) { "trabalhador" : { "valor_cliente" : "1234.22" , "quantidade_parcelas" : "10", --- page 49 --- Manual API V29.md 2025-1 1-04 49 / 56 "valor_parcela" : "123.42" , "valor_taxa" : "123.42" , "seguro" : { "valor_seguro" : "12.42" } } } Simulação de propostas - Consignado Trabalhador API responsável pela Simulação de propostas para o Consignado Trabalhador. Campos enviados Listagem de todos os campos enviados no objeto, sua obrigatoriedade e preenchimento Parâmetro ObrigatórioDefinição do campo cpf SIM CPF do cliente tipo_simulacaoSIMTipo de simulação. Valores possíveis: - POR_VALOR_MAXIMO - POR_VALOR_SOLICITADO - POR_VALOR_PARCELA prazo TALVEZPrazo máximo solicitado pelo cliente. Obrigatório se o tipo_simulacao for POR_VALOR_MAXIMO ou POR_VALOR_PARCELA valor_solicitadoTALVEZValor máximo solicitado pelo cliente. Obrigatório se o tipo_simulacao for POR_VALOR_SOLICITADO valor_parcelaTALVEZValor máximo da parcela solicitada pelo cliente. Obrigatório se o tipo_simulacao for POR_VALOR_PARCELA Path e método da requisição: https://marketplace-proposal-service-api-p.c6bank.info/marketplace/worker- payroll-loan-offers/simulate, método POST Headers enviados na requisição: Header Descrição Content-Type Preenchimento: application/json Accept Preenchimento: application/vnd.c6bank_simulate_proposal_v1+json Authorization Preenchimento: Token de autenticação obtido previamente Exemplo Request e response - Simulação de propostas - Consignado Trablhador: CURL Request exemplo por valor máximo (clique aqui para visualizar) --- page 50 --- Manual API V29.md 2025-1 1-04 50 / 56curl --location --request POST 'https: //marketplace-proposal-service-api- p.c6bank.info/marketplace/worker-payroll-loan-offers/simulate' \ --header 'Accept: application/vnd.c6bank_simulate_proposal_v1+json' \ --header 'Content-Type: application/json' \ --header 'Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhY2Nlc3NfdG9rZW4iOiJlOFlWaFZlZ3c4d2ItUWc xc1RHMi05elhUaU9jbTFfdi1HVnQtd1dnTWZWZXE3OEZybFByRkVaalhzZHBsdExHNW9lMGEzUHIwUW4 zWWlWTWFoWkRzUGxWc2tBSHJhLVVtZTVGVUxpbmNNZ2NNbG1FbVZaRFYzLWx0RUJtYzdieGZvTlNLQjB KM1BBekRkSkJadEtJYmdxNHpaQkZRdEtIbnJtdC1JY0JzemhEdVhDTGdsV1Y3NUZQM2ZjMkhaU3B3enB LY0pfLTFTSGJ6cHpWaE8xYXVZSG1FeEN2WjJlOTkyY09ndkhLRjNEMDlvSEhwOFBYaW0xSWpKcTl2MlN 1OERVcHA2VEM1dEliVk9GVmFYWUI3MnY2V1Rwb0dsXzV3TXI3b2dhLW9ZTjRGY01XRWU1YzlXNk1mdHN KaENuYm5WYk9uOXdNNnNwSTNweEVuaC1FaGg4akJzTUlwUmtaWjBDUDdqNW1UZUx1QUxKeU1naHM2UWh Gd0c0NldkYi0iLCJzdWIiOiJDNkJhbmtNYXJrZXRwbGFjZUhvbSIsImlzcyI6InVybjpcL1wvYzZiYW5 rLW1hcmtldHBsYWNlLWhvbSIsImV4cCI6MTc0MjMyNzc0NSwiaWF0IjoxNzQyMzI2NTQ2LCJqdGkiOiI zNTcwMGEyMi03MjkxLTRlN2QtYTRmOS02NjMwMmE2OTNhNDMiLCJ1c2VybmFtZSI6Imx1Y2FzLmZyYW5 jYW5pIn0.vyHdrs8l1oO1oQb5A_uJ2QtnjUDOtcE8dK3YKCPnfP8' \ --data-raw '{ "cpf": "08887744532" , "tipo_simulacao" : "POR_VALOR_MAXIMO" }' CURL Request exemplo por valor solicitado (clique aqui para visualizar) curl --location --request POST 'https: //marketplace-proposal-service-api- p.c6bank.info/marketplace/worker-payroll-loan-offers/simulate' \ --header 'Accept: application/vnd.c6bank_simulate_proposal_v1+json' \ --header 'Content-Type: application/json' \ --header 'Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhY2Nlc3NfdG9rZW4iOiJlOFlWaFZlZ3c4d2ItUWc xc1RHMi05elhUaU9jbTFfdi1HVnQtd1dnTWZWZXE3OEZybFByRkVaalhzZHBsdExHNW9lMGEzUHIwUW4 zWWlWTWFoWkRzUGxWc2tBSHJhLVVtZTVGVUxpbmNNZ2NNbG1FbVZaRFYzLWx0RUJtYzdieGZvTlNLQjB KM1BBekRkSkJadEtJYmdxNHpaQkZRdEtIbnJtdC1JY0JzemhEdVhDTGdsV1Y3NUZQM2ZjMkhaU3B3enB LY0pfLTFTSGJ6cHpWaE8xYXVZSG1FeEN2WjJlOTkyY09ndkhLRjNEMDlvSEhwOFBYaW0xSWpKcTl2MlN 1OERVcHA2VEM1dEliVk9GVmFYWUI3MnY2V1Rwb0dsXzV3TXI3b2dhLW9ZTjRGY01XRWU1YzlXNk1mdHN KaENuYm5WYk9uOXdNNnNwSTNweEVuaC1FaGg4akJzTUlwUmtaWjBDUDdqNW1UZUx1QUxKeU1naHM2UWh Gd0c0NldkYi0iLCJzdWIiOiJDNkJhbmtNYXJrZXRwbGFjZUhvbSIsImlzcyI6InVybjpcL1wvYzZiYW5 rLW1hcmtldHBsYWNlLWhvbSIsImV4cCI6MTc0MjMyNzc0NSwiaWF0IjoxNzQyMzI2NTQ2LCJqdGkiOiI zNTcwMGEyMi03MjkxLTRlN2QtYTRmOS02NjMwMmE2OTNhNDMiLCJ1c2VybmFtZSI6Imx1Y2FzLmZyYW5 jYW5pIn0.vyHdrs8l1oO1oQb5A_uJ2QtnjUDOtcE8dK3YKCPnfP8' \ --data-raw '{ "cpf": "08887744532" , "tipo_simulacao" : "POR_VALOR_SOLICITADO" , "prazo": 24, "valor_solicitado" : 1000 }' CURL Request exemplo por valor parcela (clique aqui para visualizar) curl --location --request POST 'https: //marketplace-proposal-service-api- p.c6bank.info/marketplace/worker-payroll-loan-offers/simulate' \ --header 'Accept: application/vnd.c6bank_simulate_proposal_v1+json' \ --- page 51 --- Manual API V29.md 2025-1 1-04 51 / 56--header 'Content-Type: application/json' \ --header 'Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhY2Nlc3NfdG9rZW4iOiJlOFlWaFZlZ3c4d2ItUWc xc1RHMi05elhUaU9jbTFfdi1HVnQtd1dnTWZWZXE3OEZybFByRkVaalhzZHBsdExHNW9lMGEzUHIwUW4 zWWlWTWFoWkRzUGxWc2tBSHJhLVVtZTVGVUxpbmNNZ2NNbG1FbVZaRFYzLWx0RUJtYzdieGZvTlNLQjB KM1BBekRkSkJadEtJYmdxNHpaQkZRdEtIbnJtdC1JY0JzemhEdVhDTGdsV1Y3NUZQM2ZjMkhaU3B3enB LY0pfLTFTSGJ6cHpWaE8xYXVZSG1FeEN2WjJlOTkyY09ndkhLRjNEMDlvSEhwOFBYaW0xSWpKcTl2MlN 1OERVcHA2VEM1dEliVk9GVmFYWUI3MnY2V1Rwb0dsXzV3TXI3b2dhLW9ZTjRGY01XRWU1YzlXNk1mdHN KaENuYm5WYk9uOXdNNnNwSTNweEVuaC1FaGg4akJzTUlwUmtaWjBDUDdqNW1UZUx1QUxKeU1naHM2UWh Gd0c0NldkYi0iLCJzdWIiOiJDNkJhbmtNYXJrZXRwbGFjZUhvbSIsImlzcyI6InVybjpcL1wvYzZiYW5 rLW1hcmtldHBsYWNlLWhvbSIsImV4cCI6MTc0MjMyNzc0NSwiaWF0IjoxNzQyMzI2NTQ2LCJqdGkiOiI zNTcwMGEyMi03MjkxLTRlN2QtYTRmOS02NjMwMmE2OTNhNDMiLCJ1c2VybmFtZSI6Imx1Y2FzLmZyYW5 jYW5pIn0.vyHdrs8l1oO1oQb5A_uJ2QtnjUDOtcE8dK3YKCPnfP8' \ --data-raw '{ "cpf": "08887744532" , "tipo_simulacao" : "POR_VALOR_PARCELA" , "prazo": 12, "valor_parcela" : 300 }' Response exemplo da API (clique aqui para visualizar) { "condicoes_credito" : [ { "condicao" : { "id_simulacao" : "01K97XMC9CG1515MNPAZPCVTYN" , "convenio" : { "codigo" : "800015" , "descricao" : "NÃO ENCONTRADO" , "observacao" : "Convênio inválido." }, "produto" : { "codigo" : "", "descricao" : "" }, "quantidade_parcelas" : 48, "valor_solicitado" : 2734.62, "valor_principal" : 2734.62, "valor_parcela" : 0.0, "valor_bruto" : 0.0, "valor_iof" : 0.0, "valor_liquido" : 0.0, "valor_cliente" : 0.0, "data_primeiro_vencimento" : "0001-01-01" , "data_ultimo_vencimento" : "0001-01-01" , "custo_total_efetivo_mensal" : 0.0, "custo_total_efetivo_anual" : 0.0, "taxa_cliente_mensal" : 0.0, "taxa_cliente_anual" : 0.0, "despesas" : [], "refinanciamento" : [] } }, { --- page 52 --- Manual API V29.md 2025-1 1-04 52 / 56 "condicao" : { "id_simulacao" : "01K97XMD148VTT298RA0FG6CXF" , "convenio" : { "codigo" : "800016" , "descricao" : "Trabalhador Seguro 2 Parcela" }, "produto" : { "codigo" : "800001" , "descricao" : "TRAB ML DW" }, "quantidade_parcelas" : 48, "valor_solicitado" : 2734.62, "valor_principal" : 2820.04, "valor_parcela" : 93.48, "valor_bruto" : 4487.04, "valor_iof" : 85.42, "valor_liquido" : 2559.78, "valor_cliente" : 2559.78, "data_primeiro_vencimento" : "2026-02-01" , "data_ultimo_vencimento" : "2030-01-01" , "custo_total_efetivo_mensal" : 2.32, "custo_total_efetivo_anual" : 32.11, "taxa_cliente_mensal" : 1.88, "taxa_cliente_anual" : 25.0453, "despesas" : [ { "codigo" : "24", "descricao" : "TRABALHADOR" , "codigo_tipo" : 201, "numero_item" : 2, "codigo_grupo" : "2", "valor": 174.84, "isento" : "Nao", "despesa_financiada" : "Nao", "descricao_tipo" : "Seguro 2 parcelas" , "observacao" : "Coberturas:\n- Morte: Quitação do saldo devedor limitado a R$ 50 mil\n- Invalidez Permanente e total por acidente: Quitação do saldo devedor limitado a R$ 50 mil\n- Desemprego involuntário: Capital segurado de até 2 parcelas, no valor de até R$ 1.500 cada. Com carência de 90 dias e franquia de 31 dias" , "altera_padrao" : "Nao", "valor_minimo" : 0.0, "valor_maximo" : 3100.0 } ], "refinanciamento" : [] } }, { "condicao" : { "id_simulacao" : "01K97XMDY9A48ZADDVX220JC4J" , "convenio" : { "codigo" : "800017" , "descricao" : "Trabalhador Seguro 4 Parcela" }, "produto" : { "codigo" : "800001" , --- page 53 --- Manual API V29.md 2025-1 1-04 53 / 56 "descricao" : "TRAB ML DW" }, "quantidade_parcelas" : 48, "valor_solicitado" : 2734.62, "valor_principal" : 2820.04, "valor_parcela" : 93.48, "valor_bruto" : 4487.04, "valor_iof" : 85.42, "valor_liquido" : 2431.47, "valor_cliente" : 2431.47, "data_primeiro_vencimento" : "2026-02-01" , "data_ultimo_vencimento" : "2030-01-01" , "custo_total_efetivo_mensal" : 2.55, "custo_total_efetivo_anual" : 35.9, "taxa_cliente_mensal" : 1.88, "taxa_cliente_anual" : 25.0453, "despesas" : [ { "codigo" : "25", "descricao" : "TRABALHADOR" , "codigo_tipo" : 202, "numero_item" : 2, "codigo_grupo" : "2", "valor": 303.15, "isento" : "Nao", "despesa_financiada" : "Nao", "descricao_tipo" : "Seguro 4 parcelas" , "observacao" : "Coberturas:\n- Morte: Quitação do saldo devedor limitado a R$ 50 mil\n- Invalidez Permanente e total por acidente: Quitação do saldo devedor limitado a R$ 50 mil\n- Desemprego involuntário: Capital segurado de até 4 parcelas, no valor de até R$ 1.500 cada. Com carência de 90 dias e franquia de 31 dias" , "altera_padrao" : "Nao", "valor_minimo" : 0.0, "valor_maximo" : 5375.0 } ], "refinanciamento" : [] } } ] } Inclusão de propostas - Consignado Trabalhador API responsável pela inclusão de propostas para o Consignado Trabalhador. Campos enviados Listagem de todos os campos enviados no objeto, sua obrigatoriedade e preenchimento Parâmetro ObrigatórioDefinição do campo id_simulacao SIM ID da simulação desejada para inclusão da proposta --- page 54 --- Manual API V29.md 2025-1 1-04 54 / 56Parâmetro ObrigatórioDefinição do campo cpf SIM CPF do cliente ddd SIM DDD do telefone celular do cliente numero_telefone SIM Número do telefone celular do cliente logradouro SIM Rua ou avenida do endereço do cliente numero SIM Número do endereço do cliente cep SIM CEP do endereço do cliente bairro SIM Bairro do endereço do cliente cidade SIM Cidade do endereço do cliente uf SIMSigla da unidade federativa do endereço do cliente. Ex: RN, MG, AM, SP, PR, RS codigo_origem_6 SIM Código do digitador numero_cpf_certificadoSIM CPF de quem tem o certificado no corban pra digitar proposta dados_bancarios SIM Objeto que define as informações dos dados bancários do cliente tipo_conta SIMAtributo do objeto dados_bancarios. Tipo da conta bancária do cliente. Valores possíveis são: 1.       ContaCorrenteIndividual 2.       ContaPoupancaIndividual 3.       ContaSalario 4.       ContaCorrenteConjunta 5.       ContaPoupancaConjunta 6.       ContaInvestimento numero_banco SIM Atributo do objeto dados_bancarios. Número do banco do cliente numero_agencia SIMAtributo do objeto dados_bancarios. Número da agência bancária do cliente digito_agencia SIMAtributo do objeto dados_bancarios. Digito da agência bancária do cliente numero_conta SIMAtributo do objeto dados_bancarios. Número da conta bancária do cliente digito_conta SIMAtributo do objeto dados_bancarios. Dígito da conta bancária do cliente Path e método da requisição: https://marketplace-proposal-service-api-p.c6bank.info/marketplace/worker- payroll-loan-offers/include, método POST Headers enviados na requisição: --- page 55 --- Manual API V29.md 2025-1 1-04 55 / 56Header Descrição Header Descrição Content-Type Preenchimento: application/json Accept Preenchimento: application/vnd.c6bank_include_proposal_v1+json Authorization Preenchimento: Token de autenticação obtido previamente Exemplo Request e response - Inclusão de propostas - Consignado Trablhador: CURL Request exemplo (clique aqui para visualizar) curl --location --request POST 'https: //marketplace-proposal-service-api- p.c6bank.info/marketplace/worker-payroll-loan-offers/include' \ --header 'Accept: application/vnd.c6bank_include_proposal_v1+json' \ --header 'Content-Type: application/json' \ --header 'Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhY2Nlc3NfdG9rZW4iOiJlOFlWaFZlZ3c4d2ItUWc xc1RHMi05elhUaU9jbTFfdi1HVnQtd1dnTWZWZXE3OEZybFByRkVaalhzZHBsdExHNW9lMGEzUHIwUW4 zWWlWTWFoWkRzUGxWc2tBSHJhLVVtZTVGVUxpbmNNZ2NNbG1FbVZaRFYzLWx0RUJtYzdieGZvTlNLQjB KM1BBekRkSkJadEtJYmdxNHpaQkZRdEtIbnJtdC1JY0JzemhEdVhDTGdsV1Y3NUZQM2ZjMkhaU3B3enB LY0pfLTFTSGJ6cHpWaE8xYXVZSG1FeEN2WjJlOTkyY09ndkhLRjNEMDlvSEhwOFBYaW0xSWpKcTl2MlN 1OERVcHA2VEM1dEliVk9GVmFYWUI3MnY2V1Rwb0dsXzV3TXI3b2dhLW9ZTjRGY01XRWU1YzlXNk1mdHN KaENuYm5WYk9uOXdNNnNwSTNweEVuaC1FaGg4akJzTUlwUmtaWjBDUDdqNW1UZUx1QUxKeU1naHM2UWh Gd0c0NldkYi0iLCJzdWIiOiJDNkJhbmtNYXJrZXRwbGFjZUhvbSIsImlzcyI6InVybjpcL1wvYzZiYW5 rLW1hcmtldHBsYWNlLWhvbSIsImV4cCI6MTc0MjMyNzc0NSwiaWF0IjoxNzQyMzI2NTQ2LCJqdGkiOiI zNTcwMGEyMi03MjkxLTRlN2QtYTRmOS02NjMwMmE2OTNhNDMiLCJ1c2VybmFtZSI6Imx1Y2FzLmZyYW5 jYW5pIn0.vyHdrs8l1oO1oQb5A_uJ2QtnjUDOtcE8dK3YKCPnfP8' \ --data-raw '{ "id_simulacao" : "01K97XMD148VTT298RA0FG6CXF" , "cpf": "08887744532" , "ddd": "11", "numero_telefone" : "999992234" , "logradouro" : "Rua das americas" , "numero" : "13", "cep": "30433344" , "bairro" : "Jardim America" , "cidade" : "Sao Paulo" , "uf": "SP", "dados_bancarios" : { "tipo_conta" : "string" , "numero_banco" : "string" , "numero_agencia" : "string" , "digito_agencia" : "string" , "numero_conta" : "string" , "digito_conta" : "string" }, "codigo_origem_6" : "string" , "numero_cpf_certificado" : "string" }' Response exemplo da API (clique aqui para visualizar) --- page 56 --- Manual API V29.md 2025-1 1-04 56 / 56{ "numero_proposta" : "string" }