{"openapi":"3.0.3","info":{"title":"[EXT] Auto único ","description":"Esta API é responsável por orquestrar a jornada do produto de seguro Auto, abrangendo o fluxo de cotação, geração de propostas e consulta do status da jornada.","version":"1.0.15"},"servers":[{"url":"https://api-sandbox.segurossura.com.br/auto/v1"},{"url":"https://api-dev.segurossura.com.br/auto/v1"},{"url":"https://api-hml.segurossura.com.br/auto/v1"},{"url":"https://api.segurossura.com.br/auto/v1"}],"tags":[{"name":"Quotes","description":"Operações relacionadas a cotações"},{"name":"Proposals","description":"Operações relacionadas a propostas"},{"name":"Coverages","description":"Operações relacionada a coberturas"},{"name":"Payments methods","description":"Operações relacionada a metodos de pagamento"},{"name":"Bank Slips","description":"Operações relacionada a boleto bancário"},{"name":"Policies","description":"Operações relacionadas a apólice"}],"paths":{"/quotes/{producer-codes}":{"post":{"summary":"Realiza cálculo de cotação para o produto auto","description":"O mesmo endpoint suporta cotações para Pessoa Física (PF) e Pessoa Jurídica (PJ), de acordo com o tipo de proponente informado na requisição: 1. Quando a cotação for para Pessoa Física, o objeto `accountHolder.person` é obrigatório. 2. Quando a cotação for para Pessoa Jurídica, o objeto `accountHolder.company` é obrigatório.","operationId":"postAutoQuote","tags":["Quotes"],"parameters":[{"name":"producer-codes","in":"path","required":true,"description":"Código do corretor","schema":{"type":"string"}},{"name":"x-signature","in":"header","required":true,"description":"Código de assinatura","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AutoQuoteRequest"},"example":{"accountHolder":{"contactSubtype":"company","document":"string","company":{"companyName":"string"},"person":{"firstName":"string","lastName":"string","socialName":"string","genderCode":"M","dateOfBirth":"2026-02-23","cellPhone":{"number":"string"}}},"submission":{"policyTypeCode":"New","effectiveStartDate":"2023-07-30","termTypeCode":"Annual"},"vehicle":{"isZeroKm":true,"dealershipExitDate":"2025-11-27T14:10:01.909Z","fipe":"string","licensePlate":"QJQ0A63","chassis":"988591233RKR62739","useTypeCode":"Private","previousPolicyNumber":"11111","previousCongenereCode":"6467","endPreviousPolicy":"2025-11-26T14:10:01.917Z","isArmored":true,"hasGas":true,"overnightZipCode":"string","bonusClass":"string","ci":"string","yearModel":0,"brand":"string","model":"string"},"conductorVehicle":{"driverSame":true,"document":"string","maritalStatusCode":"C","addCovForDriversCode":true},"vehicleAccessories":[{"code":"BikeRack","limitAccessories":"500.00"}],"coverages":[{"id":"SAICoFiRoThCoCov","info":[{"SAICoFiRoThCoCovDeductibleValueEdit":"13590"},{"SAICoFiRoThCoCovDeductible":"Increased50"}]}],"commercialConditionCode":{"rateModifier":"6.0000"},"overridePrimaryCommissionRate":"string"}}}},"responses":{"200":{"description":"Cotação realizada com sucesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QuotationResponse"},"example":{"success":true,"installments":true,"data":{"quotationNumber":"0009977705","totalPremium":"1490.77","taxesAndSurcharges":"110.01","totalCost":"1600.78","commercialDiscount":{"eligible":true,"id":"SAICommDiscMod","modifierType":{"code":"rate","name":"taxa"},"pattern":{"displayName":"Desconto Comercial","id":"SAICommDiscMod"},"rateModifier":"6.0000"},"coverages":[{"coverageType":{"code":"SAICoFiRoThCoCov","name":"Colisão, incêndio, Roubo ou Furto (Compreensiva)"},"details":{"limit":"R$ 275.121,00","deductible":{"type":"Majorada 50%","value":"13.590"},"netPremium":"1410","iof":"104.06","totalPremium":"1514.06"}},{"coverageType":{"code":"SAIReCarCov","name":"Carro Reserva"},"details":{"limit":"7 Dias","deductible":{},"netPremium":"69.01","iof":"5.09","totalPremium":"74.1"}}],"SAICoFiRoThCoCovLimit":"Limite","SAICoFiRoThCoCovDeductibleValue":"Valor Franquia","installments":[]}}}}},"400":{"description":"Erro de validação dos dados enviados","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseValidation"},"example":{"error":{"message":"Dados inválidos no request","infoData":[]},"success":false}}}},"422":{"description":"Erro de validação semântica / regra de negócio","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseValidation"},"example":{"error":{"message":"Erro inesperado ao processar a cotação","infoData":[]},"success":false}}}},"500":{"description":"Erro interno no servidor","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":{"message":"Erro inesperado ao processar a cotação"},"success":false}}}},"503":{"description":"Serviço indisponível","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":{"message":"Serviço temporariamente indisponível"},"success":false}}}}},"security":[{"BearerAuth":[]}]}},"/quotes/{quotationNumber}/documents":{"get":{"summary":"Download do pdf cotação.","parameters":[{"name":"quotationNumber","in":"path","required":true,"description":"Número da cotação","schema":{"type":"string"}}],"tags":["Quotes"],"responses":{"200":{"description":"Arquvivo gerado de cotação","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Download"}}}},"400":{"description":"Erro de validação dos dados enviados","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseValidation"},"example":{"error":{"message":"Dados inválidos no request","infoData":[]},"success":false}}}},"422":{"description":"Erro de validação semântica / regra de negócio","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseValidation"},"example":{"error":{"message":"Erro inesperado ao processar a cotação","infoData":[]},"success":false}}}},"500":{"description":"Erro interno no servidor","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":{"message":"Erro inesperado ao processar a cotação"},"success":false}}}},"503":{"description":"Serviço indisponível","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":{"message":"Serviço temporariamente indisponível"},"success":false}}}}},"security":[{"BearerAuth":[]}]}},"/coverages":{"get":{"summary":"Lista de coberturas para cotação","operationId":"getCoverages","tags":["Coverages"],"responses":{"200":{"description":"Lista de coberturas retornada com sucesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CoveragesResponse"}}}},"400":{"description":"Erro de validação dos dados enviados","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseValidation"},"example":{"error":{"message":"Dados inválidos no request","infoData":[]},"success":false}}}},"422":{"description":"Erro de validação semântica / regra de negócio","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseValidation"},"example":{"error":{"message":"Erro inesperado ao processar a cotação","infoData":[]},"success":false}}}},"500":{"description":"Erro interno no servidor","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":{"message":"Erro inesperado ao processar a cotação"},"success":false}}}},"503":{"description":"Serviço indisponível","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":{"message":"Serviço temporariamente indisponível"},"success":false}}}}},"security":[{"BearerAuth":[]}]}},"/proposals/{quotationNumber}":{"post":{"summary":"Realizar proposta para produto auto","operationId":"postAutoProposal","tags":["Proposals"],"parameters":[{"name":"quotationNumber","in":"path","required":true,"description":"Número da Cotação","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProposalsRequest"},"example":{"data":{"primaryAddress":{"postalCode":"07130-410","address":"Rua joao rossi","number":"234","city":"São Paulo","stateCode":"BR_SP"},"contact":{"cellPhone":{"number":"55912333234"},"emailAddress":"teste@email.com","primaryPhoneType":"mobile"},"customers":{"typeCustomers":"PF","salaryRangeCode":"NotInformed","presumedIncome":"NotInformed"},"vehicle":{"licensePlate":"STV9H59","chassis":"LGXC74C41R0020479"},"payments":{"paymentMethod":"bankslip_ext","selectedPaymentPlanId":"InstallmentPlan:bc:SDX4UCVOYGfAOPLmhVpcn"}}}}}},"responses":{"200":{"description":"Proposta realizada com sucesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProposalResponse"},"example":{"success":true,"data":{"proposalNumber_Ext":"11446","proposalSubStatus_Ext":"Pendente","jobNumber":"0002326423","policyTerm":{"periodStart":"2026-01-12T03:01:00.000Z","periodEnd":"2027-01-12T03:01:00.000Z"},"primaryInsuredName":"Adremes Millani Correa","primaryLocationDisplayName":"1: Rua joao rossi, São Paulo - SP","emailAddress":"emailPrimario@test.com","primaryPhone":"(55) 91233-3234","totalPremium":"1768.38","taxesAndSurcharges":"130.50","totalCost":"1898.88","payments":{"paymentMethod":"Boleto","installmentValue":0,"total":"1898.88"},"vehicle":{"model":"RANGER XLT 3.0 V6 4X4 CD TB DIE. AUT.","licensePlate":"STV9H59"}}}}}},"400":{"description":"Erro de validação dos dados enviados","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseValidation"},"example":{"error":{"message":"Erro inesperado ao processar a cotação","infoData":[]},"success":false}}}},"422":{"description":"Erro de validação semântica / regra de negócio","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseValidation"},"example":{"error":{"message":"Erro inesperado ao processar a cotação","infoData":[]},"success":false}}}},"500":{"description":"Erro interno no servidor","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":{"message":"Erro inesperado ao processar a proposta"},"success":false}}}},"503":{"description":"Serviço indisponível","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":{"message":"Serviço temporariamente indisponível"},"success":false}}}}},"security":[{"BearerAuth":[]}]}},"/proposals/{proposalNumber}/documents":{"get":{"summary":"Download do pdf de proposta.","parameters":[{"name":"proposalNumber","in":"path","required":true,"description":"Número da proposta","schema":{"type":"string"}},{"name":"producerCode","in":"query","required":true,"description":"Código do corretor","schema":{"type":"string"}},{"name":"x-signature","in":"header","required":true,"description":"Código de assinatura","schema":{"type":"string"}}],"tags":["Proposals"],"responses":{"200":{"description":"Arquvivo gerado de cotação","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Download"}}}},"400":{"description":"Erro de validação dos dados enviados","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseValidation"},"example":{"error":{"message":"Dados inválidos no request","infoData":[]},"success":false}}}},"422":{"description":"Erro de validação semântica / regra de negócio","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseValidation"},"example":{"error":{"message":"Erro inesperado ao processar a cotação","infoData":[]},"success":false}}}},"500":{"description":"Erro interno no servidor","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":{"message":"Erro inesperado ao processar a cotação"},"success":false}}}},"503":{"description":"Serviço indisponível","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":{"message":"Serviço temporariamente indisponível"},"success":false}}}}},"security":[{"BearerAuth":[]}]}},"/proposals/{proposalNumber}":{"get":{"summary":"Consulta de dados da Proposta","description":"Consulta dos dados de Proposta aonde será retornado: status, link de Pagamento e status de pagamento","tags":["Proposals"],"parameters":[{"name":"proposalNumber","in":"path","required":true,"description":"Número da proposta","schema":{"type":"string"}}],"responses":{"200":{"description":"Consulta de status da Proposta com sucesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataProposals"}}}},"400":{"description":"Erro de validação dos dados enviados","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseValidation"},"example":{"error":{"message":"Dados inválidos no request","infoData":[]},"success":false}}}},"422":{"description":"Erro de validação semântica / regra de negócio","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseValidation"},"example":{"error":{"message":"Erro inesperado ao processar a emissão","infoData":[]},"success":false}}}},"500":{"description":"Erro interno no servidor","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":{"message":"Erro inesperado ao processar a emissão"},"success":false}}}},"503":{"description":"Serviço indisponível","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":{"message":"Serviço temporariamente indisponível"},"success":false}}}}},"security":[{"BearerAuth":[]}]}},"/proposals/{id}/issue":{"post":{"summary":"Realizar a emissão de uma apólice","operationId":"postProposalEmission","tags":["Proposals"],"parameters":[{"name":"id","in":"path","required":true,"description":"Número da proposta","schema":{"type":"string"}},{"name":"x-signature","in":"header","required":true,"description":"Código de assinatura","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IssueRequest"}}}},"responses":{"201":{"description":"Emissão realizada com sucesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProposalEmissionResponse"},"example":{"data":{"message":"Emissão realizada com sucesso"},"success":true}}}},"400":{"description":"Erro de validação dos dados enviados","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseValidation"},"example":{"error":{"message":"Dados inválidos no request","infoData":[]},"success":false}}}},"422":{"description":"Erro de validação semântica / regra de negócio","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseValidation"},"example":{"error":{"message":"Erro inesperado ao processar a emissão","infoData":[]},"success":false}}}},"500":{"description":"Erro interno no servidor","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":{"message":"Erro inesperado ao processar a emissão"},"success":false}}}},"503":{"description":"Serviço indisponível","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":{"message":"Serviço temporariamente indisponível"},"success":false}}}}},"security":[{"BearerAuth":[]}]}},"/payment-methods":{"get":{"summary":"Obter meios de pagamento","tags":["Payments methods"],"responses":{"200":{"description":"Lista de coberturas retornada com sucesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentMethod"}}}},"400":{"description":"Erro de validação dos dados enviados","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseValidation"},"example":{"error":{"message":"Dados inválidos no request","infoData":[]},"success":false}}}},"422":{"description":"Erro de validação semântica / regra de negócio","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseValidation"},"example":{"error":{"message":"Erro inesperado ao processar a emissão","infoData":[]},"success":false}}}},"500":{"description":"Erro interno no servidor","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":{"message":"Erro inesperado ao processar a emissão"},"success":false}}}},"503":{"description":"Serviço indisponível","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":{"message":"Serviço temporariamente indisponível"},"success":false}}}}},"security":[{"BearerAuth":[]}]}},"/bankslips/{proposalNumber}/documents":{"get":{"summary":"Download do pdf boleto bancário.","parameters":[{"name":"proposalNumber","in":"path","required":true,"description":"Número da proposta","schema":{"type":"string"}},{"name":"producerCode","in":"query","required":true,"description":"Código do corretor","schema":{"type":"string"}},{"name":"x-signature","in":"header","required":true,"description":"Código de assinatura","schema":{"type":"string"}}],"tags":["Bank Slips"],"responses":{"200":{"description":"Arquvivo gerado de Boleto Bancário","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Download"}}}},"400":{"description":"Erro de validação dos dados enviados","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseValidation"},"example":{"error":{"message":"Dados inválidos no request","infoData":[]},"success":false}}}},"422":{"description":"Erro de validação semântica / regra de negócio","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseValidation"},"example":{"error":{"message":"Erro inesperado ao processar a cotação","infoData":[]},"success":false}}}},"500":{"description":"Erro interno no servidor","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":{"message":"Erro inesperado ao processar a cotação"},"success":false}}}}}}},"/policy/{proposalNumber}/documents":{"get":{"summary":"Download do pdf apólice.","parameters":[{"name":"proposalNumber","in":"path","required":true,"description":"Número da proposta","schema":{"type":"string"}},{"name":"producerCode","in":"query","required":true,"description":"Código do corretor","schema":{"type":"string"}},{"name":"x-signature","in":"header","required":true,"description":"Código de assinatura","schema":{"type":"string"}}],"tags":["Policies"],"responses":{"200":{"description":"Arquvivo gerado de Boleto Bancário","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Download"}}}},"400":{"description":"Erro de validação dos dados enviados","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseValidation"},"example":{"error":{"message":"Dados inválidos no request","infoData":[]},"success":false}}}},"422":{"description":"Erro de validação semântica / regra de negócio","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseValidation"},"example":{"error":{"message":"Erro inesperado ao processar a cotação","infoData":[]},"success":false}}}},"500":{"description":"Erro interno no servidor","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":{"message":"Erro inesperado ao processar a cotação"},"success":false}}}}}}}},"components":{"schemas":{"ProposalsRequest":{"type":"object","description":"Dados necessários para converter uma cotação em proposta do produto Auto.","required":["data"],"properties":{"data":{"type":"object","description":"Objeto principal com os dados complementares da proposta vinculada à cotação informada.","required":["primaryAddress","contact","vehicle","payments"],"properties":{"primaryAddress":{"type":"object","description":"Endereço principal do segurado utilizado na proposta.","required":["postalCode","address","city","stateCode"],"properties":{"postalCode":{"type":"string","description":"CEP do endereço principal do segurado.","example":"07130-410"},"address":{"type":"string","description":"Logradouro do endereço principal, como rua, avenida ou alameda.","example":"Rua joao rossi"},"number":{"type":"string","description":"Complemento do endereço, como número, bloco, apartamento ou ponto de referência.","example":"Apto 101"},"city":{"type":"string","description":"Cidade do endereço principal.","example":"São Paulo"},"stateCode":{"type":"string","description":"Código do estado brasileiro no padrão adotado pela API.","example":"BR_SP"}}},"contact":{"type":"object","description":"Informações de contato do proponente para a proposta.","required":["cellPhone","primaryPhoneType"],"properties":{"cellPhone":{"type":"object","description":"Dados do telefone celular principal do segurado ou proponente.","required":["countryCode","number","emailAddress"],"properties":{"countryCode":{"type":"object","description":"Código do país do telefone informado.","required":["code","name"],"properties":{"code":{"type":"string","description":"Sigla do país do telefone.","example":"BR"},"name":{"type":"string","description":"Nome do país com o código de discagem.","example":"Brasil (55)"}}},"number":{"type":"string","description":"Número do celular com DDD.","example":"55912333234"}}},"primaryPhoneType":{"type":"string","description":"Tipo do telefone principal informado no contato.","example":"mobile"},"emailAddress":{"type":"string","nullable":false,"description":"E-mail principal de contato dproponente.","example":"cliente@email.com"}}},"customers":{"type":"object","properties":{"typeCustomers":{"type":"string","description":"Tipo de pessoa","enum":["PF","PJ"]},"salaryRangeCode":{"type":"string","description":"Preencher campo quanto for PF. Opções disponíveis:\n  - `NotInformed`: Não informado\n  - `Until500`: De R$ 0,00 a R$ 500,00\n  - `Until1500`: De R$ 500,01 a R$ 1.500,00\n  - `Until3000`: De R$ 1.500,01 a R$ 3.000,00\n  - `Until6000`: De R$ 3.000,01 a R$ 6.000,00\n  - `Until10000`: De R$ 6.000,01 a R$ 10.000,00\n  - `Over10000`: Acima de R$ 10.000,00","enum":["NotInformed","Until500","Until1500","Until3000","Until6000","Until10000","Over10000"]},"presumedIncome":{"type":"string","enum":["NOT_INFORMED","UNTIL_40000","UNTIL_50000","UNTIL_60000","UNTIL_75000","UNTIL_200000","UNTIL_500000","OVER_500000"],"description":"Preencher o campo quando for PJ. Opções disponiveis:\n- NOT_INFORMED: Not informed\n- UNTIL_40000: Up to 40,000\n- UNTIL_50000: 40,000.01 to 50,000\n- UNTIL_60000: 50,000.01 to 60,000\n- UNTIL_75000: 60,000.01 to 75,000\n- UNTIL_200000: 75,000.01 to 200,000\n- UNTIL_500000: 200,000.01 to 500,000\n- OVER_500000: Above 500,000"}}},"vehicle":{"type":"object","description":"Dados de identificação do veículo associado à proposta.","required":["licensePlate","chassis"],"properties":{"licensePlate":{"type":"string","description":"Placa do veículo no padrão Mercosul.","example":"STV9H59"},"chassis":{"type":"string","description":"Número do chassi do veículo com 17 caracteres.","example":"LGXC74C41R0020479"}}},"payments":{"type":"object","description":"Dados do meio de pagamento escolhido para a proposta.","required":["paymentMethod","selectedPaymentPlanId"],"properties":{"paymentMethod":{"type":"string","description":"Os métodos de pagamento é encontrado no endpoint /payment-methods","example":"bankslip_ext"},"selectedPaymentPlanId":{"type":"string","description":"Identificador do plano de parcelamento ou cobrança escolhido na cotação.","example":"InstallmentPlan:bc:SDX4UCVOYGfAOPLmhVpcn"}}}}}}},"AutoQuoteRequest":{"type":"object","required":["accountHolder","submission","vehicle","conductorVehicle","coverages"],"properties":{"accountHolder":{"$ref":"#/components/schemas/AccountHolder"},"submission":{"$ref":"#/components/schemas/Submission"},"vehicle":{"$ref":"#/components/schemas/Vehicle"},"conductorVehicle":{"$ref":"#/components/schemas/ConductorVehicle"},"vehicleAccessories":{"type":"array","items":{"$ref":"#/components/schemas/VehicleAccessories"}},"coverages":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Id da cobertura"},"info":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","description":"Chave para identificação de termos de cobertura"},"value":{"type":"string","description":"Valores para preencher de key"}}}}}}},"commercialConditionCode":{"type":"string","description":"Opções disponíveis:\n  - `SAICommDiscMod`: Desconto Comercial","enum":["SAICommDiscMod"]},"overridePrimaryCommissionRate":{"type":"string"}}},"Submission":{"type":"object","required":["policyTypeCode","effectiveStartDate","termTypeCode"],"properties":{"policyTypeCode":{"type":"string","description":"Opções disponíveis:\n  - `New`: Novo\n  - `RenewalSura`: Renovação Sura\n  - `RenewalCongeneral`: Renovação Congenere","enum":["New","RenewalSura","RenewalCongeneral"]},"effectiveStartDate":{"type":"string","description":"Início de vigência - Data no formato YYYY-MM-DD","example":"2023-07-30","pattern":"^\\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])$"},"termTypeCode":{"type":"string","description":"Opções disponíveis:\n  - `Annual`: Anual","enum":["Annual"]}}},"Vehicle":{"type":"object","required":["yearModel","overnightZipCode","useTypeCode","fipe","isArmored","hasGas","isZeroKm"],"properties":{"yearModel":{"type":"integer"},"brand":{"type":"string"},"model":{"type":"string"},"overnightZipCode":{"type":"string"},"isZeroKm":{"type":"boolean","description":"Indicador se é 0 km. Caso positivo, campo departureDate se torna obrigatório"},"isArmored":{"type":"boolean"},"hasGas":{"type":"boolean"},"dealershipExitDate":{"type":"string","description":"Data e hora de saída da Concessionária no formato ISO 8601 com milissegundos e UTC (Z)","example":"2025-11-27T14:10:01.909Z","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$"},"fipe":{"type":"string","description":"Código fipe"},"licensePlate":{"type":"string","description":"Placa do veículo no padrão Mercosul (AAA0A00)","example":"QJQ0A63","pattern":"^[A-Z]{3}[0-9][A-Z][0-9]{2}$"},"chassis":{"type":"string","description":"Número do chassi (VIN) do veículo com 17 caracteres alfanuméricos","example":"988591233RKR62739","pattern":"^[A-HJ-NPR-Z0-9]{17}$"},"useTypeCode":{"type":"string","description":"Opções disponíveis:\n  - `Private`: Particular – lazer / ida e volta ao trabalho\n  - `Commercial`: Comercial – atividade profissional\n  - `Taxi`: Táxi\n  - `RideHailingService`: Transporte de pessoas por aplicativo\n  - `OfficialVehicle`: Veículo oficial / Órgão público\n  - `DrivingSchool`: Auto escola\n  - `RentalTestDrive`: Locadora / Test Drive","enum":["Private","Commercial","Taxi","RideHailingService","OfficialVehicle","DrivingSchool","RentalTestDrive"]},"previousPolicyNumber":{"type":"string","description":"Número da apólice anterior","example":"11111"},"previousCongenereCode":{"type":"string","description":"Código congênere","enum":["6467","5177","5819","2119","2852","5355","5274","1546","5312","6181","5631","5690","4537","1490","3646","1481","6572","5843","6238","6602","5886","2950","5070","1015","6751","5720","4952","1091","5118","6190","3671","5185","1121","5495","2241","3263"]},"endPreviousPolicy":{"type":"string","format":"date-time","description":"Data e hora de término da apólice anterior (ISO 8601 – UTC)","example":"2025-11-26T14:10:01.917Z"},"bonusClass":{"type":"string","description":"BonusClass se torna obrigatório para seguro renovação"},"ci":{"type":"string"}}},"ConductorVehicle":{"type":"object","required":["driverSame","maritalStatusCode","addCovForDriversCode"],"properties":{"driverSame":{"type":"boolean","description":" Condutor é o mesmo que o segurado? Regra: Se sim → não é necessário informar documento Se não → CPF do condutor torna-se obrigatório"},"document":{"type":"string"},"maritalStatusCode":{"type":"string","description":"Opções disponíveis:\n  - `C`: Domestic partner\n  - `D`: Divorced\n  - `M`: Married\n  - `P`: Separated\n  - `S`: Single\n  - `U`: Unknown\n  - `W`: Widowed","enum":["C","D","M","P","S","U","W"]},"addCovForDriversCode":{"type":"boolean","description":"Deseja contratar cobertura para condutores entre 18 e 25 anos que residam com o Condutor Principal?"}}},"VehicleAccessories":{"type":"object","properties":{"code":{"type":"string","description":"Opções disponíveis:\n  - `BikeRack`: Rack de Bike\n  - `SpeciaWheels`: Rodas Especiais\n  - `MultimediaKit`: Kit Multimídia\n  - `HeadrestScreen`: Tela no encosto de cabeça\n  - `Amplifiers`: Amplificadores\n  - `Speakers`: Alto-falantes\n  - `Equalizers`: Equalizadores","enum":["BikeRack","SpeciaWheels","MultimediaKit","HeadrestScreen","Amplifiers","Speakers","Equalizers"]},"limitAccessories":{"type":"string","example":"500.00"}}},"Address":{"type":"object","properties":{"postalCode":{"type":"string"},"addressLine1":{"type":"string"},"addressLine2":{"type":"string"},"addressLine3":{"type":"string"},"neighborHood":{"type":"string"},"addressType":{"type":"object","properties":{"code":{"type":"string","example":"home"},"name":{"type":"string","example":"Residencial"}}},"stateCode":{"type":"string","description":"Opções disponíveis:\n  - `BR_AC`: Acre\n  - `BR_AL`: Alagoas\n  - `BR_AP`: Amapá\n  - `BR_AM`: Amazonas\n  - `BR_BA`: Bahia\n  - `BR_CE`: Ceará\n  - `BR_DF`: Distrito Federal\n  - `BR_ES`: Espírito Santo\n  - `BR_GO`: Goiás\n  - `BR_MA`: Maranhão\n  - `BR_MT`: Mato Grosso\n  - `BR_MS`: Mato Grosso do Sul\n  - `BR_MG`: Minas Gerais\n  - `BR_PR`: Paraná\n  - `BR_PB`: Paraíba\n  - `BR_PA`: Pará\n  - `BR_PE`: Pernambuco\n  - `BR_PI`: Piauí\n  - `BR_RJ`: Rio de Janeiro\n  - `BR_RN`: Rio Grande do Norte\n  - `BR_RS`: Rio Grande do Sul\n  - `BR_RO`: Rondônia\n  - `BR_RR`: Roraima\n  - `BR_SC`: Santa Catarina\n  - `BR_SE`: Sergipe\n  - `BR_SP`: São Paulo\n  - `BR_TO`: Tocantins","enum":["BR_AC","BR_AL","BR_AP","BR_AM","BR_BA","BR_CE","BR_DF","BR_ES","BR_GO","BR_MA","BR_MT","BR_MS","BR_MG","BR_PR","BR_PB","BR_PA","BR_PE","BR_PI","BR_RJ","BR_RN","BR_RS","BR_RO","BR_RR","BR_SC","BR_SE","BR_SP","BR_TO"]},"city":{"type":"string"},"country":{"type":"string"}}},"AccountHolder":{"type":"object","required":["contactSubtype","document"],"properties":{"contactSubtype":{"type":"string","description":"Tipo do contato. Opções disponíveis:\n  - `company`: Pessoa jurídica\n  - `person`: Pessoa física","enum":["company","person"]},"document":{"type":"string","description":"CPF ou CNPJ"},"company":{"$ref":"#/components/schemas/Company"},"person":{"$ref":"#/components/schemas/Person"}}},"Company":{"type":"object","required":["companyName"],"description":"Objeto a ser enviado caso o cálculo for para pessoa jurídica","properties":{"companyName":{"type":"string","description":"Razão social da empresa."}}},"Person":{"type":"object","required":["firstName","lastName","dateOfBirth","genderCode"],"description":"Objeto a ser enviado caso o cálculo for para pessoa física","properties":{"firstName":{"type":"string"},"lastName":{"type":"string"},"socialName":{"type":"string"},"genderCode":{"description":"Sexo do segurando","type":"string","example":"M"},"dateOfBirth":{"type":"string","format":"date"},"cellPhone":{"$ref":"#/components/schemas/CellPhone"}}},"CellPhone":{"type":"object","properties":{"number":{"type":"string"}}},"QuotationResponse":{"type":"object","additionalProperties":false,"required":["success","installments","data"],"properties":{"success":{"type":"boolean","example":true},"installments":{"type":"boolean","description":"Indica se a cotação possui opções de parcelamento disponíveis.","example":true},"data":{"$ref":"#/components/schemas/QuotationData"}}},"QuotationData":{"type":"object","additionalProperties":true,"required":["quotationNumber","totalPremium","taxesAndSurcharges","totalCost","commercialDiscount","coverages"],"properties":{"quotationNumber":{"type":"string","example":"0003131306"},"totalPremium":{"type":"string","example":"1906.43","description":"Valor do prêmio (string numérica, conforme retorno da origem)."},"taxesAndSurcharges":{"type":"string","example":"140.69","description":"Taxas e adicionais (string numérica, conforme retorno da origem)."},"totalCost":{"type":"string","example":"2047.12","description":"Custo total (string numérica, conforme retorno da origem)."},"commercialDiscount":{"$ref":"#/components/schemas/CommercialDiscount"},"coverages":{"type":"array","description":"Lista de coberturas retornadas na cotação, contendo limite, franquia e composição de prêmio por cobertura.","items":{"$ref":"#/components/schemas/QuotationCoverage"}},"SAICoFiRoThCoCovLimit":{"type":"string","example":"Limite"},"SAICoFiRoThCoCovDeductibleValue":{"type":"string","example":"Valor Franquia"},"installments":{"type":"array","description":"Opções de parcelamento. Este campo só virá preenchido quando o campo raiz `installments` = true. Quando `installments` (root) = false, este campo pode vir ausente ou vazio.","items":{"$ref":"#/components/schemas/InstallmentOption"}}}},"QuotationCoverage":{"type":"object","additionalProperties":false,"description":"Cobertura calculada na cotação.","required":["coverageType","details"],"properties":{"coverageType":{"$ref":"#/components/schemas/QuotationCoverageType"},"details":{"$ref":"#/components/schemas/QuotationCoverageDetails"}}},"QuotationCoverageType":{"type":"object","additionalProperties":false,"description":"Identificação da cobertura retornada na cotação.","required":["code","name"],"properties":{"code":{"type":"string","description":"Código técnico da cobertura retornado pela API de coberturas.","example":"SAICoFiRoThCoCov"},"name":{"type":"string","description":"Nome de exibição da cobertura. Mapeado de `data[].attributes.pattern.displayName` da resposta de `/coverages`.","example":"Colisão, incêndio, Roubo ou Furto (Compreensiva)"}}},"QuotationCoverageDetails":{"type":"object","additionalProperties":false,"description":"Detalhes financeiros e termos da cobertura.","properties":{"limit":{"type":"string","nullable":true,"description":"Limite máximo de indenização da cobertura.","example":"R$ 275.121,00"},"deductible":{"$ref":"#/components/schemas/QuotationCoverageDeductible"},"netPremium":{"type":"string","nullable":true,"description":"Prêmio líquido da cobertura ou serviço.","example":"1410"},"iof":{"type":"string","nullable":true,"description":"Valor de IOF da cobertura ou serviço.","example":"104.06"},"totalPremium":{"type":"string","nullable":true,"description":"Prêmio total da cobertura, calculado pela soma do prêmio líquido (`netPremium`) com o IOF (`iof`).","example":"1514.06"}}},"QuotationCoverageDeductible":{"type":"object","additionalProperties":false,"description":"Dados de franquia da cobertura, quando aplicável. Pode retornar vazio para coberturas sem franquia.","properties":{"type":{"type":"string","description":"Tipo ou nome da franquia.","example":"Majorada 50%"},"value":{"type":"string","nullable":true,"description":"Valor da franquia.","example":"13.590"}}},"CommercialDiscount":{"type":"object","additionalProperties":false,"required":["eligible","id","modifierType","pattern","rateModifier"],"properties":{"eligible":{"type":"boolean","example":true},"id":{"type":"string","example":"SAICommDiscMod"},"modifierType":{"$ref":"#/components/schemas/ModifierType"},"pattern":{"$ref":"#/components/schemas/Pattern"},"rateModifier":{"type":"string","example":"6.0000"}}},"ModifierType":{"type":"object","additionalProperties":false,"required":["code","name"],"properties":{"code":{"type":"string","example":"rate"},"name":{"type":"string","example":"taxa"}}},"Pattern":{"type":"object","additionalProperties":false,"required":["displayName","id"],"properties":{"displayName":{"type":"string","example":"Desconto Comercial"},"id":{"type":"string","example":"SAICommDiscMod"}}},"InstallmentOption":{"type":"object","additionalProperties":false,"required":["PaymentPlans_Ext","paymentMethod_Ext"],"properties":{"PaymentPlans_Ext":{"type":"array","items":{"$ref":"#/components/schemas/PaymentPlanExt"}},"paymentMethod_Ext":{"$ref":"#/components/schemas/PaymentMethodExt"}}},"PaymentPlanExt":{"type":"object","additionalProperties":false,"required":["billingId","downPayment","firstInvoiceDue","installment","juros_Ext","maxNumberOfInstallments_Ext","name","secondInvoiceDue","total"],"properties":{"billingId":{"type":"string","example":"bc:SnIod20Ocq6iI97A75dcu"},"downPayment":{"type":"string","example":"-"},"firstInvoiceDue":{"type":"string","example":"-"},"installment":{"type":"string","example":"R$ 2.047,12"},"juros_Ext":{"type":"string","example":"Sem Juros"},"maxNumberOfInstallments_Ext":{"type":"string","example":"10"},"name":{"type":"string","example":"Parcela: 1+9 c/ adic. frac. FM"},"secondInvoiceDue":{"type":"string","example":"-"},"total":{"type":"string","example":"R$ 2.231,42"}}},"PaymentMethodExt":{"type":"object","additionalProperties":false,"required":["code","name"],"properties":{"code":{"type":"string","example":"bankslip_ext"},"name":{"type":"string","example":"Boleto"}}},"CoveragesResponse":{"type":"object","required":["data","success"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Coverage"}},"success":{"type":"boolean","example":true}}},"Coverage":{"type":"object","description":"Representa uma cobertura do produto.","required":["id","description","terms"],"properties":{"id":{"type":"string","description":"Identificador único da cobertura.","example":"SAICoFiRoThCoCov"},"description":{"type":"string","description":"Descrição da cobertura.","example":"Colisão, Incêndio, Roubo e Furto"},"terms":{"type":"array","description":"Lista de termos configuráveis da cobertura.","items":{"$ref":"#/components/schemas/CoverageTerm"}}}},"CoverageTerm":{"type":"object","description":"Representa um termo ou parâmetro de uma cobertura.","required":["id","description","required","rules","valueType"],"properties":{"id":{"type":"string","description":"Identificador único do termo da cobertura.","example":"SAICoFiRoThCoCovDeductibleValueEdit"},"description":{"type":"string","description":"Descrição do termo da cobertura.","example":"Valor da franquia"},"required":{"type":"boolean","description":"Indica se o preenchimento do termo é obrigatório.","example":true},"rules":{"type":"array","description":"Regras aplicáveis ao termo da cobertura.","items":{"$ref":"#/components/schemas/CoverageTermRule"}},"allowedValues":{"type":"array","description":"Valores aceitos para cobertura.","items":{"$ref":"#/components/schemas/allowedValues"}},"valueType":{"$ref":"#/components/schemas/ValueType"}}},"allowedValues":{"type":"object","properties":{"code":{"type":"string","description":"Valor para preencher na cotação"},"description":{"type":"string","description":"Descrição dos valores"}}},"CoverageTermRule":{"type":"object","description":"Regra aplicável ao termo da cobertura.","required":["editionCode","staticValue"],"properties":{"editionCode":{"type":"string","description":"Código da edição ou regra aplicada ao termo.","example":"EDITABLE"},"staticValue":{"type":"string","description":"Valor estático associado à regra.","example":"13590"}}},"ValueType":{"type":"object","description":"Tipo de valor esperado para o termo.","required":["code","name"],"properties":{"code":{"type":"string","description":"Código do tipo de valor.","example":"string"},"name":{"type":"string","description":"Nome descritivo do tipo de valor.","example":"Texto"}}},"Download":{"type":"object","properties":{"data":{"type":"object","properties":{"base64":{"type":"string","example":"VBERi0xLjcKJeLjz9MNCjQgMCBvYmoKPDwKL1R5cGUvWE9iamVjdAovU3VidHlwZS9JbWFnZQovV2lkdGggMTMwCi9IZWlnaHQgMTU0Ci9CaXRzUGVyQ29tcG9uZW50IDgKL0NvbG9yU3BhY2UvRGV2aWNlR3JheQovRmlsdGVyL0ZsYXRlRGVjb2RlCi9MZW5ndGggODMwCj4+CnN0cmVhbQp4nO3bzZGjMBAFYEIgAyuBrSIEQnAICsEhKASHoAD24BAIgdOcCUGHrdnLbM0iGGwQWEN3v2F2q/qdbFOCz/y2JLsoNBqNRqPRaDQaDStn1xBzhm6/7t7psUCAZWwfSmACcAQT4toaWxPSQgmesa4GuhfiLnDENg3yQ"}}}}},"DataProposals":{"type":"object","properties":{"data":{"type":"object","properties":{"jobId":{"type":"string","example":"pc:SY0Hi3_NuumsqThWOB29n"},"quotationNumber":{"type":"string","example":"0019908896","description":"Número da cotação"},"proposalNumber":{"type":"string","example":"11523","description":"Número da Proposta"},"proposalStatus":{"type":"string","example":"Pendente","description":"Status da Proposta"},"proposalSubStatus":{"type":"string","example":"Transmitida com Pendência","description":"Substatus da Proposta"},"insuredName":{"type":"string","example":"Juan Perez","description":"Nome do segurado"},"paymentURL":{"type":"string","example":"https://payments.insurance.com/pay/2342343464563456","description":"Url de Pagamento"}}},"success":{"type":"boolean","example":true}}},"IssueRequest":{"type":"object","required":["data","producerCode"],"properties":{"data":{"type":"object","properties":{"producerCode":{"type":"string","example":"0709643"}}}}},"ErrorResponse":{"type":"object","additionalProperties":false,"required":["error","success"],"properties":{"error":{"type":"object","additionalProperties":false,"required":["message"],"properties":{"message":{"type":"string"}}},"success":{"type":"boolean","example":false}}},"ErrorResponseValidation":{"type":"object","additionalProperties":false,"required":["error","success"],"properties":{"error":{"type":"object","additionalProperties":false,"required":["message","infoData"],"properties":{"message":{"type":"string"},"infoData":{"type":"array","items":{}}}},"success":{"type":"boolean","example":false}}},"ProposalResponse":{"type":"object","additionalProperties":false,"required":["success","data"],"properties":{"success":{"type":"boolean","example":true},"data":{"$ref":"#/components/schemas/ProposalData"}}},"ProposalData":{"type":"object","additionalProperties":true,"required":["proposalNumber_Ext","proposalSubStatus_Ext","jobNumber","policyTerm","primaryInsuredName","primaryLocationDisplayName","emailAddress","primaryPhone","totalPremium","taxesAndSurcharges","totalCost","payments","vehicle"],"properties":{"proposalNumber_Ext":{"type":"string","example":"11446"},"proposalSubStatus_Ext":{"type":"string","example":"Pendente"},"jobNumber":{"type":"string","example":"0002326423"},"policyTerm":{"$ref":"#/components/schemas/PolicyTerm"},"primaryInsuredName":{"type":"string","example":"Adremes Millani Correa"},"primaryLocationDisplayName":{"type":"string","example":"1: Rua joao rossi, São Paulo - SP"},"emailAddress":{"type":"string","format":"email","example":"emailPrimario@test.com"},"phone":{"type":"string","example":"(55) 91233-3234"},"totalPremium":{"type":"string","example":"1768.38"},"taxesAndSurcharges":{"type":"string","example":"130.50"},"totalCost":{"type":"string","example":"1898.88"},"payments":{"$ref":"#/components/schemas/ProposalPayments"},"vehicle":{"$ref":"#/components/schemas/ProposalVehicle"}}},"PolicyTerm":{"type":"object","additionalProperties":false,"required":["periodStart","periodEnd"],"properties":{"periodStart":{"type":"string","format":"date-time","example":"2026-01-12T03:01:00.000Z"},"periodEnd":{"type":"string","format":"date-time","example":"2027-01-12T03:01:00.000Z"}}},"ProposalPayments":{"type":"object","additionalProperties":true,"required":["paymentMethod","installmentValue","total"],"properties":{"paymentMethod":{"type":"string","example":"Boleto"},"installmentValue":{"type":"number","example":0},"total":{"type":"string","example":"1898.88"}}},"ProposalVehicle":{"type":"object","additionalProperties":true,"required":["model","licensePlate"],"properties":{"model":{"type":"string","example":"RANGER XLT 3.0 V6 4X4 CD TB DIE. AUT."},"licensePlate":{"type":"string","example":"STV9H59"}}},"ProposalEmissionRequest":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["jobNumber"],"properties":{"jobNumber":{"type":"string"}}}}},"ProposalEmissionResponse":{"type":"object","additionalProperties":false,"required":["data","success"],"properties":{"data":{"type":"object","additionalProperties":false,"required":["message"],"properties":{"message":{"type":"string","example":"Emissão realizada com sucesso"}}},"success":{"type":"boolean","example":true}}},"PaymentMethod":{"type":"object","properties":{"success":{"type":"boolean","description":"Indicador de sucesso da requisição"},"data":{"type":"array","items":{"type":"object","description":"Objeto que representa um método de pagamento disponível.","properties":{"code":{"type":"string","description":"Código identificador do método de pagamento.","example":"bankslip_ext"},"description":{"type":"string","description":"Descrição detalhada do método de pagamento.","example":"Um boleto bancário é gerado para pagamento"},"name":{"type":"string","description":"Nome do método de pagamento.","example":"Boleto"}}}}}}},"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}}}}