{ "info": { "name": "AUTOUNIT — API de Parceiros", "description": "Collection oficial da **API de Parceiros** da AUTOUNIT (Unit) — consulta/cotação e formalização (submit/formalize/status/cancel) de crédito consignado multi-banco. Ver guia completo em `docs/partners/api-parceiros-guia-integracao.md`.\n\n## Autenticação\nHeader **`X-Partner-Api-Key`** em toda requisição (configurado no nível da collection via a variável `{{apiKey}}`). A chave é entregue uma única vez na criação do parceiro e trafega **servidor-a-servidor** (nunca no frontend).\n\n## Seleção de bancos (duas camadas)\n1. **allowlist** fixo por parceiro (contratual, server-side).\n2. campo opcional **`providers`** por requisição — interseção com o allowlist.\n\n## Formalização (submit/formalize/status/cancel)\nEndpoint unificado — um schema só por trás de Zipdin/Unit/C6/Facta (§8.1 do guia). `proposal_id` é o id interno do card, devolvido pelo submit.\n\n## Base URL\nVariável `{{baseUrl}}` — troque o environment pra `sandbox` (`autounit-partners-sandbox.postman_environment.json`) pra testar sem tocar em banco real, com o catálogo de CPFs de teste documentado no guia (§14).\n\nGerada a partir dos contratos reais em produção; exemplos **anonimizados**.\n\nAtualizada em 30/07/2026: exemplo Crefaz (referencias/conta COMPE/naturalidade), digito_agencia no exemplo de conta bancária. NÃO envie `initialDueDate` (removido do contrato — ver changelog 30/07).", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "_postman_id": "au7c0000-0000-4000-a000-000000000001" }, "auth": { "type": "apikey", "apikey": [ { "key": "in", "value": "header", "type": "string" }, { "key": "key", "value": "X-Partner-Api-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" } ] }, "variable": [ { "key": "baseUrl", "value": "https://api.somosunit.com.br", "type": "string" }, { "key": "apiKey", "value": "", "type": "string" } ], "item": [ { "name": "Consulta agregada", "item": [ { "name": "POST /partners/v1/consultas", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/partners/v1/consultas", "host": [ "{{baseUrl}}" ], "path": [ "partners", "v1", "consultas" ] }, "body": { "mode": "raw", "raw": "{\n \"cpf\": \"11144477735\",\n \"nome\": \"MARIA DE EXEMPLO SILVA\",\n \"data_nascimento\": \"1990-05-15\",\n \"telefone\": \"11987654321\",\n \"email\": \"maria@exemplo.com\",\n \"client_ip\": \"203.0.113.10\",\n \"sexo\": 0\n}", "options": { "raw": { "language": "json" } } }, "description": "Consulta **agregada** multi-banco. Roda em paralelo os bancos do *allowlist* do parceiro (interseção com o campo opcional `providers`) e devolve as propostas já ordenadas + `providerResults` detalhado por banco.\n\n⚠️ Dispara efeitos colaterais do fluxo síncrono (webhooks de lead, persistência de ofertas)." }, "response": [ { "name": "200 — propostas + providerResults", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/partners/v1/consultas", "host": [ "{{baseUrl}}" ], "path": [ "partners", "v1", "consultas" ] }, "body": { "mode": "raw", "raw": "{\n \"cpf\": \"11144477735\",\n \"nome\": \"MARIA DE EXEMPLO SILVA\",\n \"data_nascimento\": \"1990-05-15\",\n \"telefone\": \"11987654321\",\n \"email\": \"maria@exemplo.com\",\n \"client_ip\": \"203.0.113.10\",\n \"sexo\": 0\n}", "options": { "raw": { "language": "json" } } }, "description": "Consulta **agregada** multi-banco. Roda em paralelo os bancos do *allowlist* do parceiro (interseção com o campo opcional `providers`) e devolve as propostas já ordenadas + `providerResults` detalhado por banco.\n\n⚠️ Dispara efeitos colaterais do fluxo síncrono (webhooks de lead, persistência de ofertas)." }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"proposals\": [\n {\n \"provider\": \"zipdin\",\n \"loanValue\": 3141.14,\n \"installmentValue\": 519.0,\n \"installments\": 8,\n \"interestRate\": 3.79,\n \"tableCode\": \"NORMAL_0003\"\n },\n {\n \"provider\": \"zipdin\",\n \"loanValue\": 2487.16,\n \"installmentValue\": 519.0,\n \"installments\": 6,\n \"interestRate\": 3.79,\n \"tableCode\": \"NORMAL_0003\"\n }\n ],\n \"providerResults\": {\n \"zipdin\": {\n \"provider\": \"zipdin\",\n \"success\": true,\n \"proposals\": [\n \"…(ver offers acima)\"\n ],\n \"vinculos\": [\n {\n \"employerName\": \"EMPRESA EXEMPLO LTDA\"\n }\n ],\n \"elapsedMs\": 1902\n },\n \"c6\": {\n \"provider\": \"c6\",\n \"success\": false,\n \"proposals\": [],\n \"noProposalReasons\": [\n \"Cliente não autorizou prova de vida\"\n ],\n \"elapsedMs\": 5012\n },\n \"facta\": {\n \"provider\": \"facta\",\n \"success\": false,\n \"proposals\": [],\n \"noProposalReasons\": [\n \"Cota diária DATAPREV atingida\"\n ],\n \"elapsedMs\": 1103\n }\n },\n \"employers\": [\n {\n \"cnpj\": \"00000000000191\",\n \"name\": \"EMPRESA EXEMPLO LTDA\",\n \"matricula\": \"000000\",\n \"provider\": \"unit\",\n \"margin\": 850.0\n }\n ],\n \"elapsedMs\": 5100,\n \"timestamp\": \"2026-07-02T19:14:00.000000\",\n \"simulationGroupId\": \"a1b2c3d4-0000-0000-0000-000000000000\"\n}" }, { "name": "401 — sem X-Partner-Api-Key", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/partners/v1/consultas", "host": [ "{{baseUrl}}" ], "path": [ "partners", "v1", "consultas" ] }, "body": { "mode": "raw", "raw": "{\n \"cpf\": \"11144477735\",\n \"nome\": \"MARIA DE EXEMPLO SILVA\",\n \"data_nascimento\": \"1990-05-15\",\n \"telefone\": \"11987654321\",\n \"email\": \"maria@exemplo.com\",\n \"client_ip\": \"203.0.113.10\",\n \"sexo\": 0\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"detail\": \"X-Partner-Api-Key ausente\"\n}" } ] } ] }, { "name": "Consulta individual por banco", "item": [ { "name": "POST /partners/v1/providers/:name/consultas", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/partners/v1/providers/:name/consultas", "host": [ "{{baseUrl}}" ], "path": [ "partners", "v1", "providers", ":name", "consultas" ], "variable": [ { "key": "name", "value": "zipdin", "description": "Nome do banco (deve estar no allowlist): zipdin, c6, facta, unit, hubcredito…" } ] }, "body": { "mode": "raw", "raw": "{\n \"cpf\": \"11144477735\",\n \"nome\": \"MARIA DE EXEMPLO SILVA\",\n \"data_nascimento\": \"1990-05-15\",\n \"telefone\": \"11987654321\",\n \"email\": \"maria@exemplo.com\",\n \"client_ip\": \"203.0.113.10\",\n \"sexo\": 0\n}", "options": { "raw": { "language": "json" } } }, "description": "Consulta **um único banco** (precisa estar no *allowlist* do parceiro, senão **403**). Devolve o **envelope padrão** (`ProviderEnvelope`). Não dispara os webhooks de lead do fluxo agregado.\n\n**status:** `ok` (tem ofertas) · `no_offers` · `requires_action` (ver `action.url`) · `error`." }, "response": [ { "name": "200 — ok (2 ofertas, zipdin)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/partners/v1/providers/:name/consultas", "host": [ "{{baseUrl}}" ], "path": [ "partners", "v1", "providers", ":name", "consultas" ], "variable": [ { "key": "name", "value": "zipdin", "description": "Nome do banco (deve estar no allowlist): zipdin, c6, facta, unit, hubcredito…" } ] }, "body": { "mode": "raw", "raw": "{\n \"cpf\": \"11144477735\",\n \"nome\": \"MARIA DE EXEMPLO SILVA\",\n \"data_nascimento\": \"1990-05-15\",\n \"telefone\": \"11987654321\",\n \"email\": \"maria@exemplo.com\",\n \"client_ip\": \"203.0.113.10\",\n \"sexo\": 0\n}", "options": { "raw": { "language": "json" } } }, "description": "Consulta **um único banco** (precisa estar no *allowlist* do parceiro, senão **403**). Devolve o **envelope padrão** (`ProviderEnvelope`). Não dispara os webhooks de lead do fluxo agregado.\n\n**status:** `ok` (tem ofertas) · `no_offers` · `requires_action` (ver `action.url`) · `error`." }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"provider\": \"zipdin\",\n \"status\": \"ok\",\n \"offers\": [\n {\n \"provider\": \"zipdin\",\n \"loan_value\": 2487.16,\n \"installment_value\": 519.0,\n \"installments\": 6,\n \"interest_rate\": 3.79,\n \"total_amount\": 3114.0,\n \"table_code\": \"NORMAL_0003\",\n \"first_due_date\": \"2026-09-20\",\n \"employer_name\": \"EMPRESA EXEMPLO LTDA\",\n \"employer_cnpj\": \"00000000000191\",\n \"matricula\": null,\n \"operator_commission\": null,\n \"provider_data\": {\n \"preRegisterId\": 1200652,\n \"partnerCode\": 26462,\n \"tableCode\": \"NORMAL_0003\",\n \"maxInstallmentValue\": 519.74,\n \"comSeguro\": true,\n \"raw\": {\n \"loanValue\": 2487.16,\n \"installmentValue\": 519.0,\n \"installmentsNumber\": 6,\n \"monthlyRate\": 3.79,\n \"yearlyRate\": 56.27,\n \"monthlyCet\": 4.5,\n \"yearlyCet\": 70.74,\n \"withInsurance\": true,\n \"insurance\": 43.0,\n \"fundedValue\": 2574.69,\n \"principalIof\": 33.56,\n \"gracePeriod\": 50\n },\n \"cpfUsado\": \"11144477735\",\n \"takerRegister\": {\n \"customerName\": \"MARIA DE EXEMPLO SILVA\",\n \"birthDate\": \"15/05/1990\",\n \"motherName\": \"ANA DE EXEMPLO\",\n \"gender\": \"F\"\n },\n \"takerData\": {\n \"profession\": \"ANALISTA\",\n \"registerId\": \"000000\"\n },\n \"discounts\": {\n \"commitments\": 0.0,\n \"inssValue\": 248.61,\n \"irpfValue\": 38.92\n }\n }\n },\n {\n \"provider\": \"zipdin\",\n \"loan_value\": 3141.14,\n \"installment_value\": 519.0,\n \"installments\": 8,\n \"interest_rate\": 3.79,\n \"total_amount\": 4152.0,\n \"table_code\": \"NORMAL_0003\",\n \"first_due_date\": \"2026-09-20\",\n \"employer_name\": \"EMPRESA EXEMPLO LTDA\",\n \"employer_cnpj\": \"00000000000191\",\n \"matricula\": null,\n \"operator_commission\": null,\n \"provider_data\": {\n \"preRegisterId\": 1200652,\n \"partnerCode\": 26462,\n \"tableCode\": \"NORMAL_0003\",\n \"maxInstallmentValue\": 519.74,\n \"comSeguro\": true,\n \"raw\": {\n \"loanValue\": 3141.14,\n \"installmentValue\": 519.0,\n \"installmentsNumber\": 8,\n \"monthlyRate\": 3.79,\n \"yearlyRate\": 56.27,\n \"monthlyCet\": 4.5,\n \"yearlyCet\": 70.74,\n \"withInsurance\": true,\n \"insurance\": 43.0,\n \"fundedValue\": 2574.69,\n \"principalIof\": 33.56,\n \"gracePeriod\": 50\n },\n \"cpfUsado\": \"11144477735\",\n \"takerRegister\": {\n \"customerName\": \"MARIA DE EXEMPLO SILVA\",\n \"birthDate\": \"15/05/1990\",\n \"motherName\": \"ANA DE EXEMPLO\",\n \"gender\": \"F\"\n },\n \"takerData\": {\n \"profession\": \"ANALISTA\",\n \"registerId\": \"000000\"\n },\n \"discounts\": {\n \"commitments\": 0.0,\n \"inssValue\": 248.61,\n \"irpfValue\": 38.92\n }\n }\n }\n ],\n \"vinculos\": [\n {\n \"provider\": \"zipdin\",\n \"cnpj\": \"00000000000191\",\n \"employerName\": \"EMPRESA EXEMPLO LTDA\",\n \"matricula\": null,\n \"partnerCode\": null\n }\n ],\n \"proposal_id\": null,\n \"action\": null,\n \"error\": null,\n \"elapsed_ms\": 1902,\n \"no_proposal_reasons\": [],\n \"term_auto_authorized\": false,\n \"provider_data\": null\n}" }, { "name": "200 — requires_action (assinatura DATAPREV)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/partners/v1/providers/:name/consultas", "host": [ "{{baseUrl}}" ], "path": [ "partners", "v1", "providers", ":name", "consultas" ], "variable": [ { "key": "name", "value": "zipdin", "description": "Nome do banco (deve estar no allowlist): zipdin, c6, facta, unit, hubcredito…" } ] }, "body": { "mode": "raw", "raw": "{\n \"cpf\": \"11144477735\",\n \"nome\": \"MARIA DE EXEMPLO SILVA\",\n \"data_nascimento\": \"1990-05-15\",\n \"telefone\": \"11987654321\",\n \"email\": \"maria@exemplo.com\",\n \"client_ip\": \"203.0.113.10\",\n \"sexo\": 0\n}", "options": { "raw": { "language": "json" } } }, "description": "Consulta **um único banco** (precisa estar no *allowlist* do parceiro, senão **403**). Devolve o **envelope padrão** (`ProviderEnvelope`). Não dispara os webhooks de lead do fluxo agregado.\n\n**status:** `ok` (tem ofertas) · `no_offers` · `requires_action` (ver `action.url`) · `error`." }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"provider\": \"zipdin\",\n \"status\": \"requires_action\",\n \"offers\": [],\n \"vinculos\": [],\n \"proposal_id\": null,\n \"action\": {\n \"type\": \"signature\",\n \"url\": \"https://zipdinsign.zipdin.com.br/sign/EXEMPLO0000000000000000000000\",\n \"detail\": null\n },\n \"error\": \"Assinatura DATAPREV pendente\",\n \"elapsed_ms\": 422,\n \"no_proposal_reasons\": [],\n \"term_auto_authorized\": false,\n \"provider_data\": null\n}" }, { "name": "200 — no_offers (c6: prova de vida)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/partners/v1/providers/:name/consultas", "host": [ "{{baseUrl}}" ], "path": [ "partners", "v1", "providers", ":name", "consultas" ], "variable": [ { "key": "name", "value": "zipdin", "description": "Nome do banco (deve estar no allowlist): zipdin, c6, facta, unit, hubcredito…" } ] }, "body": { "mode": "raw", "raw": "{\n \"cpf\": \"11144477735\",\n \"nome\": \"MARIA DE EXEMPLO SILVA\",\n \"data_nascimento\": \"1990-05-15\",\n \"telefone\": \"11987654321\",\n \"email\": \"maria@exemplo.com\",\n \"client_ip\": \"203.0.113.10\",\n \"sexo\": 0\n}", "options": { "raw": { "language": "json" } } }, "description": "Consulta **um único banco** (precisa estar no *allowlist* do parceiro, senão **403**). Devolve o **envelope padrão** (`ProviderEnvelope`). Não dispara os webhooks de lead do fluxo agregado.\n\n**status:** `ok` (tem ofertas) · `no_offers` · `requires_action` (ver `action.url`) · `error`." }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"provider\": \"c6\",\n \"status\": \"no_offers\",\n \"offers\": [],\n \"vinculos\": [],\n \"proposal_id\": null,\n \"action\": null,\n \"error\": null,\n \"elapsed_ms\": 5012,\n \"no_proposal_reasons\": [\n \"Cliente não autorizou prova de vida (status: NAO_AUTORIZADO)\"\n ],\n \"term_auto_authorized\": false,\n \"provider_data\": null\n}" }, { "name": "200 — error (cota da loja)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/partners/v1/providers/:name/consultas", "host": [ "{{baseUrl}}" ], "path": [ "partners", "v1", "providers", ":name", "consultas" ], "variable": [ { "key": "name", "value": "zipdin", "description": "Nome do banco (deve estar no allowlist): zipdin, c6, facta, unit, hubcredito…" } ] }, "body": { "mode": "raw", "raw": "{\n \"cpf\": \"11144477735\",\n \"nome\": \"MARIA DE EXEMPLO SILVA\",\n \"data_nascimento\": \"1990-05-15\",\n \"telefone\": \"11987654321\",\n \"email\": \"maria@exemplo.com\",\n \"client_ip\": \"203.0.113.10\",\n \"sexo\": 0\n}", "options": { "raw": { "language": "json" } } }, "description": "Consulta **um único banco** (precisa estar no *allowlist* do parceiro, senão **403**). Devolve o **envelope padrão** (`ProviderEnvelope`). Não dispara os webhooks de lead do fluxo agregado.\n\n**status:** `ok` (tem ofertas) · `no_offers` · `requires_action` (ver `action.url`) · `error`." }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"provider\": \"hubcredito\",\n \"status\": \"error\",\n \"offers\": [],\n \"vinculos\": [],\n \"proposal_id\": null,\n \"action\": null,\n \"error\": \"Loja XXXXX atingiu o limite de consultas para CLT Consignado. Limite: 100, Consumido: 100\",\n \"elapsed_ms\": 423,\n \"no_proposal_reasons\": [],\n \"term_auto_authorized\": false,\n \"provider_data\": null\n}" }, { "name": "403 — banco fora do allowlist", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/partners/v1/providers/banco_pan/consultas", "host": [ "{{baseUrl}}" ], "path": [ "partners", "v1", "providers", "banco_pan", "consultas" ] }, "body": { "mode": "raw", "raw": "{\n \"cpf\": \"11144477735\",\n \"nome\": \"MARIA DE EXEMPLO SILVA\",\n \"data_nascimento\": \"1990-05-15\",\n \"telefone\": \"11987654321\",\n \"email\": \"maria@exemplo.com\",\n \"client_ip\": \"203.0.113.10\",\n \"sexo\": 0\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"detail\": \"provider 'banco_pan' fora do allowlist do parceiro\"\n}" } ] } ] }, { "name": "Leilão — lookup por proposal_key", "item": [ { "name": "Lookup OK (sandbox: sbx-leilao-ok)", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/partners/v1/auction-proposals/sbx-leilao-ok", "host": [ "{{baseUrl}}" ], "path": [ "partners", "v1", "auction-proposals", "sbx-leilao-ok" ] }, "description": "Proposta do leilão + dados do cliente pela proposal_key — mesmo lookup do Step0 do funil, sem side effects (não cria card, não dispara SMS). Exige 'unit' no allowlist do parceiro (403 sem). No sandbox, 'sbx-leilao-ok' devolve JOANA SANDBOX DA SILVA (CPF 11144477735, o CPF feliz do catálogo — encadeia lookup → consulta → formalização). Em produção, use a proposal_key recebida no link do leilão." } }, { "name": "Lookup 404 (sandbox: sbx-leilao-expirada)", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/partners/v1/auction-proposals/sbx-leilao-expirada", "host": [ "{{baseUrl}}" ], "path": [ "partners", "v1", "auction-proposals", "sbx-leilao-expirada" ] }, "description": "Contrato de erro: proposal_key desconhecida ou expirada → 404 (falha da Unit → 502; sem key de parceiro → 401)." } } ] }, { "name": "Autorização — colheita de evidência (fluxo WhatsApp)", "description": "Gera link de autorização, o cliente autoriza na página compacta (IP/geo/device colhidos lá) e a consulta usa authorization_id no lugar de client_ip. No sandbox, o passo 'accept' pode ser chamado direto pra simular o cliente.", "item": [ { "name": "1. Criar sessão (gera o link)", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/partners/v1/authorizations", "host": [ "{{baseUrl}}" ], "path": [ "partners", "v1", "authorizations" ] }, "description": "Idempotente: sessão pendente viva do mesmo CPF reusa o MESMO link.", "body": { "mode": "raw", "raw": "{\n \"cpf\": \"11144477735\",\n \"nome\": \"JOANA SANDBOX DA SILVA\",\n \"telefone\": \"27999990000\"\n}" } } }, { "name": "2. Página — bootstrap (público)", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/partners/v1/authorizations/public/{{authorizationId}}", "host": [ "{{baseUrl}}" ], "path": [ "partners", "v1", "authorizations", "public", "{{authorizationId}}" ] }, "description": "O que a página compacta carrega: nome, CPF mascarado, versão do termo." } }, { "name": "3. Página — aceite (público; simula o cliente no sandbox)", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/partners/v1/authorizations/public/{{authorizationId}}/accept", "host": [ "{{baseUrl}}" ], "path": [ "partners", "v1", "authorizations", "public", "{{authorizationId}}", "accept" ] }, "description": "", "body": { "mode": "raw", "raw": "{\n \"geo\": {\n \"latitude\": \"-20.31\",\n \"longitude\": \"-40.29\",\n \"cidade\": \"Vitória\",\n \"uf\": \"ES\",\n \"ip\": \"203.0.113.42\"\n },\n \"device\": {\n \"userAgent\": \"Mozilla/5.0 (Android 14)\",\n \"operationalSystem\": \"Android 14\",\n \"deviceModel\": \"Pixel 8\",\n \"deviceType\": \"mobile\"\n },\n \"signature_date\": \"2026-08-13T12:00:00-03:00\"\n}" } } }, { "name": "4. Consultar sessão (status + evidência)", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/partners/v1/authorizations/{{authorizationId}}", "host": [ "{{baseUrl}}" ], "path": [ "partners", "v1", "authorizations", "{{authorizationId}}" ] }, "description": "" } }, { "name": "5. Consulta agregada com authorization_id (sem client_ip)", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/partners/v1/consultas", "host": [ "{{baseUrl}}" ], "path": [ "partners", "v1", "consultas" ] }, "description": "", "body": { "mode": "raw", "raw": "{\n \"cpf\": \"11144477735\",\n \"nome\": \"JOANA SANDBOX DA SILVA\",\n \"data_nascimento\": \"1994-03-10\",\n \"telefone\": \"27999990000\",\n \"email\": \"joana@teste.com\",\n \"authorization_id\": \"{{authorizationId}}\"\n}" } } } ] }, { "name": "Formalização (submit / formalize / status / cancel)", "description": "Endpoint unificado de formalização (§8.1 do guia) — mesmo schema por trás de Zipdin/Unit/C6/Facta. Exemplos abaixo usam o CPF `99922255561` do catálogo do sandbox (Facta: fluxo completo submit→formalize→paga→cancelada).", "item": [ { "name": "POST /partners/v1/proposals (submit)", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/partners/v1/proposals", "host": [ "{{baseUrl}}" ], "path": [ "partners", "v1", "proposals" ] }, "body": { "mode": "raw", "raw": "{\n \"offer_ref\": {\n \"provider\": \"facta\",\n \"offer_id\": \"\"\n },\n \"titular\": {\n \"nome\": \"JOAO DE EXEMPLO SANDBOX\",\n \"cpf\": \"999.222.555-61\",\n \"data_nascimento\": \"1985-03-20\",\n \"sexo\": \"M\",\n \"nome_mae\": \"MARIA DE EXEMPLO SANDBOX\",\n \"nome_pai\": \"PEDRO DE EXEMPLO SANDBOX\",\n \"nacionalidade\": \"BRASILEIRA\",\n \"estado_civil\": \"CASADO\",\n \"naturalidade_cidade\": \"SAO PAULO\",\n \"naturalidade_uf\": \"SP\",\n \"exposicao_politica\": \"NAO\"\n },\n \"documento\": {\n \"numero\": \"987654321\",\n \"orgao_emissor\": \"SSP\",\n \"uf_emissor\": \"SP\",\n \"data_emissao\": \"2005-01-01\"\n },\n \"contato\": {\n \"telefone\": \"11987654322\",\n \"email\": \"joao@exemplo.com\"\n },\n \"endereco\": {\n \"cep\": \"01310-100\",\n \"logradouro\": \"AV PAULISTA\",\n \"numero\": \"2000\",\n \"bairro\": \"BELA VISTA\",\n \"cidade\": \"SAO PAULO\",\n \"uf\": \"SP\"\n },\n \"vinculo\": {\n \"cnpj_empregador\": \"00000000000191\",\n \"nome_empregador\": \"EMPRESA SANDBOX LTDA\",\n \"cargo\": \"ANALISTA\",\n \"salario\": 3000.0,\n \"margem\": 400.0,\n \"data_admissao\": \"2018-01-01\",\n \"matricula\": \"000001\"\n },\n \"recebimento\": {\n \"pix\": {\n \"tipo_chave\": \"cpf\",\n \"chave\": \"99922255561\"\n }\n },\n \"assinatura\": {\n \"ip\": \"203.0.113.10\",\n \"tipo_envio\": \"sms\"\n }\n}", "options": { "raw": { "language": "json" } } }, "description": "Submete a proposta ao banco (cria). `offer_ref.offer_id` é o `simulationId`/`offer_id` devolvido pela consulta (§7) para a oferta escolhida — para Unit, a API resolve os termos financeiros server-side a partir dele (§8.1). Blocos obrigatórios variam por banco — ver tabela em §8.1 do guia." }, "response": [ { "name": "201 — submit ok (Facta)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/partners/v1/proposals", "host": [ "{{baseUrl}}" ], "path": [ "partners", "v1", "proposals" ] }, "body": { "mode": "raw", "raw": "{\n \"offer_ref\": {\n \"provider\": \"facta\",\n \"offer_id\": \"\"\n },\n \"titular\": {\n \"nome\": \"JOAO DE EXEMPLO SANDBOX\",\n \"cpf\": \"999.222.555-61\",\n \"data_nascimento\": \"1985-03-20\",\n \"sexo\": \"M\",\n \"nome_mae\": \"MARIA DE EXEMPLO SANDBOX\",\n \"nome_pai\": \"PEDRO DE EXEMPLO SANDBOX\",\n \"nacionalidade\": \"BRASILEIRA\",\n \"estado_civil\": \"CASADO\",\n \"naturalidade_cidade\": \"SAO PAULO\",\n \"naturalidade_uf\": \"SP\",\n \"exposicao_politica\": \"NAO\"\n },\n \"documento\": {\n \"numero\": \"987654321\",\n \"orgao_emissor\": \"SSP\",\n \"uf_emissor\": \"SP\",\n \"data_emissao\": \"2005-01-01\"\n },\n \"contato\": {\n \"telefone\": \"11987654322\",\n \"email\": \"joao@exemplo.com\"\n },\n \"endereco\": {\n \"cep\": \"01310-100\",\n \"logradouro\": \"AV PAULISTA\",\n \"numero\": \"2000\",\n \"bairro\": \"BELA VISTA\",\n \"cidade\": \"SAO PAULO\",\n \"uf\": \"SP\"\n },\n \"vinculo\": {\n \"cnpj_empregador\": \"00000000000191\",\n \"nome_empregador\": \"EMPRESA SANDBOX LTDA\",\n \"cargo\": \"ANALISTA\",\n \"salario\": 3000.0,\n \"margem\": 400.0,\n \"data_admissao\": \"2018-01-01\",\n \"matricula\": \"000001\"\n },\n \"recebimento\": {\n \"pix\": {\n \"tipo_chave\": \"cpf\",\n \"chave\": \"99922255561\"\n }\n },\n \"assinatura\": {\n \"ip\": \"203.0.113.10\",\n \"tipo_envio\": \"sms\"\n }\n}", "options": { "raw": { "language": "json" } } }, "description": "Submete a proposta ao banco (cria). `offer_ref.offer_id` é o `simulationId`/`offer_id` devolvido pela consulta (§7) para a oferta escolhida — para Unit, a API resolve os termos financeiros server-side a partir dele (§8.1). Blocos obrigatórios variam por banco — ver tabela em §8.1 do guia." }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"proposal_id\": \"123\",\n \"provider\": \"facta\",\n \"status\": \"ok\",\n \"action\": null,\n \"offer\": null,\n \"error\": null,\n \"provider_data\": null,\n \"updated_at\": \"2026-07-06T21:27:18.495375+00:00\"\n}" }, { "name": "422 — bloco obrigatório ausente", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/partners/v1/proposals", "host": [ "{{baseUrl}}" ], "path": [ "partners", "v1", "proposals" ] }, "body": { "mode": "raw", "raw": "{\n \"offer_ref\": {\n \"provider\": \"facta\",\n \"offer_id\": \"\"\n },\n \"titular\": {\n \"nome\": \"JOAO DE EXEMPLO SANDBOX\",\n \"cpf\": \"999.222.555-61\",\n \"data_nascimento\": \"1985-03-20\",\n \"sexo\": \"M\",\n \"nome_mae\": \"MARIA DE EXEMPLO SANDBOX\",\n \"nome_pai\": \"PEDRO DE EXEMPLO SANDBOX\",\n \"nacionalidade\": \"BRASILEIRA\",\n \"estado_civil\": \"CASADO\",\n \"naturalidade_cidade\": \"SAO PAULO\",\n \"naturalidade_uf\": \"SP\",\n \"exposicao_politica\": \"NAO\"\n },\n \"documento\": {\n \"numero\": \"987654321\",\n \"orgao_emissor\": \"SSP\",\n \"uf_emissor\": \"SP\",\n \"data_emissao\": \"2005-01-01\"\n },\n \"contato\": {\n \"telefone\": \"11987654322\",\n \"email\": \"joao@exemplo.com\"\n },\n \"endereco\": {\n \"cep\": \"01310-100\",\n \"logradouro\": \"AV PAULISTA\",\n \"numero\": \"2000\",\n \"bairro\": \"BELA VISTA\",\n \"cidade\": \"SAO PAULO\",\n \"uf\": \"SP\"\n },\n \"vinculo\": {\n \"cnpj_empregador\": \"00000000000191\",\n \"nome_empregador\": \"EMPRESA SANDBOX LTDA\",\n \"cargo\": \"ANALISTA\",\n \"salario\": 3000.0,\n \"margem\": 400.0,\n \"data_admissao\": \"2018-01-01\",\n \"matricula\": \"000001\"\n },\n \"recebimento\": {\n \"pix\": {\n \"tipo_chave\": \"cpf\",\n \"chave\": \"99922255561\"\n }\n },\n \"assinatura\": {\n \"ip\": \"203.0.113.10\",\n \"tipo_envio\": \"sms\"\n }\n}", "options": { "raw": { "language": "json" } } }, "description": "Submete a proposta ao banco (cria). `offer_ref.offer_id` é o `simulationId`/`offer_id` devolvido pela consulta (§7) para a oferta escolhida — para Unit, a API resolve os termos financeiros server-side a partir dele (§8.1). Blocos obrigatórios variam por banco — ver tabela em §8.1 do guia." }, "status": "Unprocessable Entity", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"detail\": {\n \"code\": \"invalid_input\",\n \"message\": \"campo obrigatório ausente: nome_pai\",\n \"retryable\": false,\n \"field\": \"nome_pai\"\n }\n}" }, { "name": "422 — oferta Unit não resolvida (server-side)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/partners/v1/proposals", "host": [ "{{baseUrl}}" ], "path": [ "partners", "v1", "proposals" ] }, "body": { "mode": "raw", "raw": "{\n \"offer_ref\": {\n \"provider\": \"facta\",\n \"offer_id\": \"\"\n },\n \"titular\": {\n \"nome\": \"JOAO DE EXEMPLO SANDBOX\",\n \"cpf\": \"999.222.555-61\",\n \"data_nascimento\": \"1985-03-20\",\n \"sexo\": \"M\",\n \"nome_mae\": \"MARIA DE EXEMPLO SANDBOX\",\n \"nome_pai\": \"PEDRO DE EXEMPLO SANDBOX\",\n \"nacionalidade\": \"BRASILEIRA\",\n \"estado_civil\": \"CASADO\",\n \"naturalidade_cidade\": \"SAO PAULO\",\n \"naturalidade_uf\": \"SP\",\n \"exposicao_politica\": \"NAO\"\n },\n \"documento\": {\n \"numero\": \"987654321\",\n \"orgao_emissor\": \"SSP\",\n \"uf_emissor\": \"SP\",\n \"data_emissao\": \"2005-01-01\"\n },\n \"contato\": {\n \"telefone\": \"11987654322\",\n \"email\": \"joao@exemplo.com\"\n },\n \"endereco\": {\n \"cep\": \"01310-100\",\n \"logradouro\": \"AV PAULISTA\",\n \"numero\": \"2000\",\n \"bairro\": \"BELA VISTA\",\n \"cidade\": \"SAO PAULO\",\n \"uf\": \"SP\"\n },\n \"vinculo\": {\n \"cnpj_empregador\": \"00000000000191\",\n \"nome_empregador\": \"EMPRESA SANDBOX LTDA\",\n \"cargo\": \"ANALISTA\",\n \"salario\": 3000.0,\n \"margem\": 400.0,\n \"data_admissao\": \"2018-01-01\",\n \"matricula\": \"000001\"\n },\n \"recebimento\": {\n \"pix\": {\n \"tipo_chave\": \"cpf\",\n \"chave\": \"99922255561\"\n }\n },\n \"assinatura\": {\n \"ip\": \"203.0.113.10\",\n \"tipo_envio\": \"sms\"\n }\n}", "options": { "raw": { "language": "json" } } }, "description": "Submete a proposta ao banco (cria). `offer_ref.offer_id` é o `simulationId`/`offer_id` devolvido pela consulta (§7) para a oferta escolhida — para Unit, a API resolve os termos financeiros server-side a partir dele (§8.1). Blocos obrigatórios variam por banco — ver tabela em §8.1 do guia." }, "status": "Unprocessable Entity", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"detail\": {\n \"code\": \"invalid_input\",\n \"message\": \"oferta Unit não resolvida — termos financeiros indisponíveis para o CPF/offer_id\",\n \"retryable\": false,\n \"field\": \"offer_ref.offer_id\"\n }\n}" } ] }, { "name": "POST /partners/v1/proposals (submit Crefaz — com referencias)", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/partners/v1/proposals", "host": [ "{{baseUrl}}" ], "path": [ "partners", "v1", "proposals" ] }, "body": { "mode": "raw", "raw": "{\n \"offer_ref\": {\n \"provider\": \"crefaz\",\n \"offer_id\": \"{{offerId}}\"\n },\n \"titular\": {\n \"nome\": \"JOAO DE EXEMPLO SANDBOX\",\n \"cpf\": \"999.222.555-61\",\n \"data_nascimento\": \"1985-03-20\",\n \"sexo\": \"M\",\n \"nome_mae\": \"MARIA DE EXEMPLO SANDBOX\",\n \"nome_pai\": \"PEDRO DE EXEMPLO SANDBOX\",\n \"nacionalidade\": \"BRASILEIRA\",\n \"estado_civil\": \"CASADO\",\n \"naturalidade_cidade\": \"Sao Paulo\",\n \"naturalidade_uf\": \"SP\",\n \"exposicao_politica\": \"NAO\"\n },\n \"documento\": {\n \"numero\": \"987654321\",\n \"orgao_emissor\": \"SSP\",\n \"uf_emissor\": \"SP\",\n \"data_emissao\": \"2005-01-01\"\n },\n \"contato\": {\n \"telefone\": \"11987654322\",\n \"email\": \"joao@exemplo.com\"\n },\n \"endereco\": {\n \"cep\": \"01310-100\",\n \"logradouro\": \"AV PAULISTA\",\n \"numero\": \"2000\",\n \"bairro\": \"BELA VISTA\",\n \"cidade\": \"SAO PAULO\",\n \"uf\": \"SP\"\n },\n \"vinculo\": {\n \"cnpj_empregador\": \"00000000000191\",\n \"nome_empregador\": \"EMPRESA SANDBOX LTDA\",\n \"cargo\": \"ANALISTA\",\n \"salario\": 3000.0,\n \"margem\": 400.0,\n \"data_admissao\": \"2018-01-01\",\n \"matricula\": \"000001\"\n },\n \"recebimento\": {\n \"conta_bancaria\": {\n \"banco\": \"001\",\n \"agencia\": \"1234\",\n \"digito_agencia\": \"0\",\n \"conta\": \"56789\",\n \"digito_conta\": \"0\",\n \"tipo_conta\": \"cc\"\n }\n },\n \"assinatura\": {\n \"ip\": \"203.0.113.10\",\n \"tipo_envio\": \"sms\"\n },\n \"referencias\": [\n {\n \"nome\": \"Maria Aparecida\",\n \"telefone\": \"11988887777\",\n \"grau\": 1\n },\n {\n \"nome\": \"Carlos Souza\",\n \"telefone\": \"11977776666\",\n \"grau\": 2\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "description": "Submit Crefaz (Crédito do Trabalhador). Particularidades vs os demais bancos: (1) bloco `referencias` OBRIGATÓRIO — mínimo 2, com nome+telefone; `grau`: 0=Cônjuge, 1=Parente, 2=Amigo. (2) recebimento SÓ por conta_bancaria (PIX não é aceito), banco = código COMPE. (3) naturalidade_cidade + naturalidade_uf obrigatórias. (4) A consulta dispara SMS de autorização (DataPrev): submit antes da autorização concluída volta **422 `invalid_input`** apontando `offer_ref.offer_id` (aguarde o webhook authorization_result — ou re-consulte — e submeta com o `offerId` novo). Sandbox: CPFs 200.444.666-84 (fluxo completo) e 300.555.777-41 (SMS pendente)." }, "response": [ { "name": "201 — submit ok (Facta)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/partners/v1/proposals", "host": [ "{{baseUrl}}" ], "path": [ "partners", "v1", "proposals" ] }, "body": { "mode": "raw", "raw": "{\n \"offer_ref\": {\n \"provider\": \"facta\",\n \"offer_id\": \"\"\n },\n \"titular\": {\n \"nome\": \"JOAO DE EXEMPLO SANDBOX\",\n \"cpf\": \"999.222.555-61\",\n \"data_nascimento\": \"1985-03-20\",\n \"sexo\": \"M\",\n \"nome_mae\": \"MARIA DE EXEMPLO SANDBOX\",\n \"nome_pai\": \"PEDRO DE EXEMPLO SANDBOX\",\n \"nacionalidade\": \"BRASILEIRA\",\n \"estado_civil\": \"CASADO\",\n \"naturalidade_cidade\": \"SAO PAULO\",\n \"naturalidade_uf\": \"SP\",\n \"exposicao_politica\": \"NAO\"\n },\n \"documento\": {\n \"numero\": \"987654321\",\n \"orgao_emissor\": \"SSP\",\n \"uf_emissor\": \"SP\",\n \"data_emissao\": \"2005-01-01\"\n },\n \"contato\": {\n \"telefone\": \"11987654322\",\n \"email\": \"joao@exemplo.com\"\n },\n \"endereco\": {\n \"cep\": \"01310-100\",\n \"logradouro\": \"AV PAULISTA\",\n \"numero\": \"2000\",\n \"bairro\": \"BELA VISTA\",\n \"cidade\": \"SAO PAULO\",\n \"uf\": \"SP\"\n },\n \"vinculo\": {\n \"cnpj_empregador\": \"00000000000191\",\n \"nome_empregador\": \"EMPRESA SANDBOX LTDA\",\n \"cargo\": \"ANALISTA\",\n \"salario\": 3000.0,\n \"margem\": 400.0,\n \"data_admissao\": \"2018-01-01\",\n \"matricula\": \"000001\"\n },\n \"recebimento\": {\n \"pix\": {\n \"tipo_chave\": \"cpf\",\n \"chave\": \"99922255561\"\n }\n },\n \"assinatura\": {\n \"ip\": \"203.0.113.10\",\n \"tipo_envio\": \"sms\"\n }\n}", "options": { "raw": { "language": "json" } } }, "description": "Submete a proposta ao banco (cria). `offer_ref.offer_id` é o `simulationId`/`offer_id` devolvido pela consulta (§7) para a oferta escolhida — para Unit, a API resolve os termos financeiros server-side a partir dele (§8.1). Blocos obrigatórios variam por banco — ver tabela em §8.1 do guia." }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"proposal_id\": \"123\",\n \"provider\": \"facta\",\n \"status\": \"ok\",\n \"action\": null,\n \"offer\": null,\n \"error\": null,\n \"provider_data\": null,\n \"updated_at\": \"2026-07-06T21:27:18.495375+00:00\"\n}" }, { "name": "422 — bloco obrigatório ausente", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/partners/v1/proposals", "host": [ "{{baseUrl}}" ], "path": [ "partners", "v1", "proposals" ] }, "body": { "mode": "raw", "raw": "{\n \"offer_ref\": {\n \"provider\": \"facta\",\n \"offer_id\": \"\"\n },\n \"titular\": {\n \"nome\": \"JOAO DE EXEMPLO SANDBOX\",\n \"cpf\": \"999.222.555-61\",\n \"data_nascimento\": \"1985-03-20\",\n \"sexo\": \"M\",\n \"nome_mae\": \"MARIA DE EXEMPLO SANDBOX\",\n \"nome_pai\": \"PEDRO DE EXEMPLO SANDBOX\",\n \"nacionalidade\": \"BRASILEIRA\",\n \"estado_civil\": \"CASADO\",\n \"naturalidade_cidade\": \"SAO PAULO\",\n \"naturalidade_uf\": \"SP\",\n \"exposicao_politica\": \"NAO\"\n },\n \"documento\": {\n \"numero\": \"987654321\",\n \"orgao_emissor\": \"SSP\",\n \"uf_emissor\": \"SP\",\n \"data_emissao\": \"2005-01-01\"\n },\n \"contato\": {\n \"telefone\": \"11987654322\",\n \"email\": \"joao@exemplo.com\"\n },\n \"endereco\": {\n \"cep\": \"01310-100\",\n \"logradouro\": \"AV PAULISTA\",\n \"numero\": \"2000\",\n \"bairro\": \"BELA VISTA\",\n \"cidade\": \"SAO PAULO\",\n \"uf\": \"SP\"\n },\n \"vinculo\": {\n \"cnpj_empregador\": \"00000000000191\",\n \"nome_empregador\": \"EMPRESA SANDBOX LTDA\",\n \"cargo\": \"ANALISTA\",\n \"salario\": 3000.0,\n \"margem\": 400.0,\n \"data_admissao\": \"2018-01-01\",\n \"matricula\": \"000001\"\n },\n \"recebimento\": {\n \"pix\": {\n \"tipo_chave\": \"cpf\",\n \"chave\": \"99922255561\"\n }\n },\n \"assinatura\": {\n \"ip\": \"203.0.113.10\",\n \"tipo_envio\": \"sms\"\n }\n}", "options": { "raw": { "language": "json" } } }, "description": "Submete a proposta ao banco (cria). `offer_ref.offer_id` é o `simulationId`/`offer_id` devolvido pela consulta (§7) para a oferta escolhida — para Unit, a API resolve os termos financeiros server-side a partir dele (§8.1). Blocos obrigatórios variam por banco — ver tabela em §8.1 do guia." }, "status": "Unprocessable Entity", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"detail\": {\n \"code\": \"invalid_input\",\n \"message\": \"campo obrigatório ausente: nome_pai\",\n \"retryable\": false,\n \"field\": \"nome_pai\"\n }\n}" }, { "name": "422 — oferta Unit não resolvida (server-side)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/partners/v1/proposals", "host": [ "{{baseUrl}}" ], "path": [ "partners", "v1", "proposals" ] }, "body": { "mode": "raw", "raw": "{\n \"offer_ref\": {\n \"provider\": \"facta\",\n \"offer_id\": \"\"\n },\n \"titular\": {\n \"nome\": \"JOAO DE EXEMPLO SANDBOX\",\n \"cpf\": \"999.222.555-61\",\n \"data_nascimento\": \"1985-03-20\",\n \"sexo\": \"M\",\n \"nome_mae\": \"MARIA DE EXEMPLO SANDBOX\",\n \"nome_pai\": \"PEDRO DE EXEMPLO SANDBOX\",\n \"nacionalidade\": \"BRASILEIRA\",\n \"estado_civil\": \"CASADO\",\n \"naturalidade_cidade\": \"SAO PAULO\",\n \"naturalidade_uf\": \"SP\",\n \"exposicao_politica\": \"NAO\"\n },\n \"documento\": {\n \"numero\": \"987654321\",\n \"orgao_emissor\": \"SSP\",\n \"uf_emissor\": \"SP\",\n \"data_emissao\": \"2005-01-01\"\n },\n \"contato\": {\n \"telefone\": \"11987654322\",\n \"email\": \"joao@exemplo.com\"\n },\n \"endereco\": {\n \"cep\": \"01310-100\",\n \"logradouro\": \"AV PAULISTA\",\n \"numero\": \"2000\",\n \"bairro\": \"BELA VISTA\",\n \"cidade\": \"SAO PAULO\",\n \"uf\": \"SP\"\n },\n \"vinculo\": {\n \"cnpj_empregador\": \"00000000000191\",\n \"nome_empregador\": \"EMPRESA SANDBOX LTDA\",\n \"cargo\": \"ANALISTA\",\n \"salario\": 3000.0,\n \"margem\": 400.0,\n \"data_admissao\": \"2018-01-01\",\n \"matricula\": \"000001\"\n },\n \"recebimento\": {\n \"pix\": {\n \"tipo_chave\": \"cpf\",\n \"chave\": \"99922255561\"\n }\n },\n \"assinatura\": {\n \"ip\": \"203.0.113.10\",\n \"tipo_envio\": \"sms\"\n }\n}", "options": { "raw": { "language": "json" } } }, "description": "Submete a proposta ao banco (cria). `offer_ref.offer_id` é o `simulationId`/`offer_id` devolvido pela consulta (§7) para a oferta escolhida — para Unit, a API resolve os termos financeiros server-side a partir dele (§8.1). Blocos obrigatórios variam por banco — ver tabela em §8.1 do guia." }, "status": "Unprocessable Entity", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"detail\": {\n \"code\": \"invalid_input\",\n \"message\": \"oferta Unit não resolvida — termos financeiros indisponíveis para o CPF/offer_id\",\n \"retryable\": false,\n \"field\": \"offer_ref.offer_id\"\n }\n}" } ] }, { "name": "POST /partners/v1/proposals (submit Unit — conta bancária)", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/partners/v1/proposals", "host": [ "{{baseUrl}}" ], "path": [ "partners", "v1", "proposals" ] }, "body": { "mode": "raw", "raw": "{\n \"offer_ref\": {\n \"provider\": \"unit\",\n \"offer_id\": \"\"\n },\n \"titular\": {\n \"nome\": \"JOAO DE EXEMPLO SANDBOX\",\n \"cpf\": \"999.222.555-61\",\n \"data_nascimento\": \"1985-03-20\",\n \"sexo\": \"M\",\n \"nome_mae\": \"MARIA DE EXEMPLO SANDBOX\",\n \"nacionalidade\": \"BRASILEIRA\",\n \"estado_civil\": \"CASADO\",\n \"exposicao_politica\": \"NAO\"\n },\n \"documento\": {\n \"numero\": \"987654321\",\n \"orgao_emissor\": \"SSP\",\n \"uf_emissor\": \"SP\",\n \"data_emissao\": \"2005-01-01\"\n },\n \"contato\": {\n \"telefone\": \"11987654322\",\n \"email\": \"joao@exemplo.com\"\n },\n \"endereco\": {\n \"cep\": \"01310-100\",\n \"logradouro\": \"AV PAULISTA\",\n \"numero\": \"2000\",\n \"bairro\": \"BELA VISTA\",\n \"cidade\": \"SAO PAULO\",\n \"uf\": \"SP\"\n },\n \"recebimento\": {\n \"conta_bancaria\": {\n \"banco\": \"001\",\n \"agencia\": \"1234\",\n \"digito_agencia\": \"0\",\n \"conta\": \"56789\",\n \"digito_conta\": \"0\",\n \"tipo_conta\": \"cc\"\n }\n },\n \"assinatura\": {\n \"ip\": \"203.0.113.10\"\n }\n}", "options": { "raw": { "language": "json" } } }, "description": "Submit Unit. ENVIE SEMPRE `recebimento.conta_bancaria` — não PIX. A Unit desembolsa por duas carteiras: a qitech aceita PIX, a carteira própria (BMP) só desembolsa em conta. Qual delas atende a operação é decidido pela elegibilidade do vínculo do cliente DEPOIS da consulta — o parceiro não escolhe nem sabe de antemão, então PIX passa em parte das propostas e é recusado (`provider_rejected`, 422, `retryable: false`) em outra. Conta bancária vale nas duas carteiras. Demais particularidades: `assinatura.ip` obrigatório; os termos financeiros NÃO são informados pelo parceiro — a API os resolve server-side a partir da oferta persistida na consulta, e `offer_ref.offer_id` é o auctionProposalKey ecoado por ela." }, "response": [] }, { "name": "POST /partners/v1/proposals/:proposal_id/formalize", "request": { "method": "POST", "header": [], "url": { "raw": "{{baseUrl}}/partners/v1/proposals/:proposal_id/formalize", "host": [ "{{baseUrl}}" ], "path": [ "partners", "v1", "proposals", ":proposal_id", "formalize" ], "variable": [ { "key": "proposal_id", "value": "123", "description": "id interno do card, devolvido pelo submit" } ] }, "description": "Dispara/retorna o link de assinatura da proposta (ownership checada pelo parceiro autenticado)." }, "response": [ { "name": "200 — link de assinatura (Facta)", "originalRequest": { "method": "POST", "header": [], "url": { "raw": "{{baseUrl}}/partners/v1/proposals/:proposal_id/formalize", "host": [ "{{baseUrl}}" ], "path": [ "partners", "v1", "proposals", ":proposal_id", "formalize" ], "variable": [ { "key": "proposal_id", "value": "123", "description": "id interno do card, devolvido pelo submit" } ] }, "description": "Dispara/retorna o link de assinatura da proposta (ownership checada pelo parceiro autenticado)." }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"proposal_id\": \"123\",\n \"provider\": \"facta\",\n \"status\": \"awaiting_signature\",\n \"action\": {\n \"type\": \"signature\",\n \"url\": \"https://facta.sandbox.somosunit.com.br/formalizacao/SANDBOX01\",\n \"delivery\": null\n },\n \"offer\": null,\n \"error\": null,\n \"provider_data\": null,\n \"updated_at\": \"2026-07-06T21:27:18.495375+00:00\"\n}" } ] }, { "name": "GET /partners/v1/proposals/:proposal_id (status)", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/partners/v1/proposals/:proposal_id", "host": [ "{{baseUrl}}" ], "path": [ "partners", "v1", "proposals", ":proposal_id" ], "variable": [ { "key": "proposal_id", "value": "123", "description": "id interno do card, devolvido pelo submit" } ] }, "description": "Status normalizado da proposta — projeção do `PipelineStatus` da linha, mantido atualizado pelo scheduler de cada banco (não faz chamada síncrona ao banco)." }, "response": [ { "name": "200 — paga (Facta)", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/partners/v1/proposals/:proposal_id", "host": [ "{{baseUrl}}" ], "path": [ "partners", "v1", "proposals", ":proposal_id" ], "variable": [ { "key": "proposal_id", "value": "123", "description": "id interno do card, devolvido pelo submit" } ] }, "description": "Status normalizado da proposta — projeção do `PipelineStatus` da linha, mantido atualizado pelo scheduler de cada banco (não faz chamada síncrona ao banco)." }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"proposal_id\": \"123\",\n \"provider\": \"facta\",\n \"status\": \"paid\",\n \"action\": null,\n \"offer\": null,\n \"error\": null,\n \"provider_data\": null,\n \"updated_at\": \"2026-07-06T21:27:18.495375+00:00\"\n}" }, { "name": "404 — proposal_id de outro parceiro (ownership)", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/partners/v1/proposals/:proposal_id", "host": [ "{{baseUrl}}" ], "path": [ "partners", "v1", "proposals", ":proposal_id" ], "variable": [ { "key": "proposal_id", "value": "123", "description": "id interno do card, devolvido pelo submit" } ] }, "description": "Status normalizado da proposta — projeção do `PipelineStatus` da linha, mantido atualizado pelo scheduler de cada banco (não faz chamada síncrona ao banco)." }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"detail\": \"proposta não encontrada\"\n}" } ] }, { "name": "POST /partners/v1/proposals/:proposal_id/cancel", "request": { "method": "POST", "header": [], "url": { "raw": "{{baseUrl}}/partners/v1/proposals/:proposal_id/cancel", "host": [ "{{baseUrl}}" ], "path": [ "partners", "v1", "proposals", ":proposal_id", "cancel" ], "variable": [ { "key": "proposal_id", "value": "123", "description": "id interno do card, devolvido pelo submit" } ] }, "description": "Cancela a proposta. Só **Facta** suporta hoje (`supports_cancel`); nos demais bancos o adapter devolve **501** (`error.code=provider_error`)." }, "response": [ { "name": "200 — cancelada (Facta)", "originalRequest": { "method": "POST", "header": [], "url": { "raw": "{{baseUrl}}/partners/v1/proposals/:proposal_id/cancel", "host": [ "{{baseUrl}}" ], "path": [ "partners", "v1", "proposals", ":proposal_id", "cancel" ], "variable": [ { "key": "proposal_id", "value": "123", "description": "id interno do card, devolvido pelo submit" } ] }, "description": "Cancela a proposta. Só **Facta** suporta hoje (`supports_cancel`); nos demais bancos o adapter devolve **501** (`error.code=provider_error`)." }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"proposal_id\": \"123\",\n \"provider\": \"facta\",\n \"status\": \"canceled\",\n \"action\": null,\n \"offer\": null,\n \"error\": null,\n \"provider_data\": null,\n \"updated_at\": \"2026-07-06T21:27:18.495375+00:00\"\n}" }, { "name": "501 — banco não suporta cancel (ex.: Unit/C6/Zipdin)", "originalRequest": { "method": "POST", "header": [], "url": { "raw": "{{baseUrl}}/partners/v1/proposals/:proposal_id/cancel", "host": [ "{{baseUrl}}" ], "path": [ "partners", "v1", "proposals", ":proposal_id", "cancel" ], "variable": [ { "key": "proposal_id", "value": "123", "description": "id interno do card, devolvido pelo submit" } ] }, "description": "Cancela a proposta. Só **Facta** suporta hoje (`supports_cancel`); nos demais bancos o adapter devolve **501** (`error.code=provider_error`)." }, "status": "Not Implemented", "code": 501, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"detail\": {\n \"code\": \"provider_error\",\n \"message\": \"[unit] operação não suportada: cancel\",\n \"retryable\": false,\n \"field\": null\n }\n}" } ] } ] }, { "name": "Stream de ofertas (SSE)", "item": [ { "name": "POST /partners/v1/consultas/stream", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/partners/v1/consultas/stream", "host": [ "{{baseUrl}}" ], "path": [ "partners", "v1", "consultas", "stream" ] }, "body": { "mode": "raw", "raw": "{\n \"cpf\": \"11144477735\",\n \"nome\": \"MARIA DE EXEMPLO SILVA\",\n \"data_nascimento\": \"1990-05-15\",\n \"telefone\": \"11987654321\",\n \"email\": \"maria@exemplo.com\",\n \"client_ip\": \"203.0.113.10\",\n \"sexo\": 0\n}", "options": { "raw": { "language": "json" } } }, "description": "**Stream SSE** — resultado progressivo por banco (`text/event-stream`). Eventos: `start` → `provider_start` (por banco) → `provider_result` → `complete`. Entrega só os resultados progressivos; não replica os efeitos cross-provider da rota agregada." }, "response": [ { "name": "200 — text/event-stream", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/partners/v1/consultas/stream", "host": [ "{{baseUrl}}" ], "path": [ "partners", "v1", "consultas", "stream" ] }, "body": { "mode": "raw", "raw": "{\n \"cpf\": \"11144477735\",\n \"nome\": \"MARIA DE EXEMPLO SILVA\",\n \"data_nascimento\": \"1990-05-15\",\n \"telefone\": \"11987654321\",\n \"email\": \"maria@exemplo.com\",\n \"client_ip\": \"203.0.113.10\",\n \"sexo\": 0\n}", "options": { "raw": { "language": "json" } } }, "description": "**Stream SSE** — resultado progressivo por banco (`text/event-stream`). Eventos: `start` → `provider_start` (por banco) → `provider_result` → `complete`. Entrega só os resultados progressivos; não replica os efeitos cross-provider da rota agregada." }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/event-stream" } ], "cookie": [], "body": "data: {\"event\": \"start\", \"message\": \"Iniciando consulta paralela\"}\n\ndata: {\"event\": \"provider_start\", \"provider\": \"zipdin\"}\n\ndata: {\"event\": \"provider_start\", \"provider\": \"c6\"}\n\ndata: {\"event\": \"provider_result\", \"provider\": \"zipdin\", \"success\": true, \"proposals\": [{\"loanValue\": 2487.16, \"installments\": 6}], \"elapsedMs\": 1902}\n\ndata: {\"event\": \"provider_result\", \"provider\": \"c6\", \"success\": false, \"noProposalReasons\": [\"Cliente não autorizou prova de vida\"], \"elapsedMs\": 5012}\n\ndata: {\"event\": \"complete\"}\n" } ] } ] }, { "name": "Exemplo — seleção por requisição", "item": [ { "name": "POST /partners/v1/consultas (providers=[zipdin,c6])", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/partners/v1/consultas", "host": [ "{{baseUrl}}" ], "path": [ "partners", "v1", "consultas" ] }, "body": { "mode": "raw", "raw": "{\n \"cpf\": \"11144477735\",\n \"nome\": \"MARIA DE EXEMPLO SILVA\",\n \"data_nascimento\": \"1990-05-15\",\n \"telefone\": \"11987654321\",\n \"email\": \"maria@exemplo.com\",\n \"client_ip\": \"203.0.113.10\",\n \"sexo\": 0,\n \"providers\": [\n \"zipdin\",\n \"c6\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "description": "Mesma rota agregada, restringindo a consulta a um subconjunto do allowlist via `providers`. O efetivo é `allowlist ∩ providers`." }, "response": [] } ] } ] }