---
title: "proposal"
method: POST
path: "/proposal"
tags: ["effective-controller"]
---

# proposal

`POST /proposal`

Effect an offer

## Headers

- `X-Application-Id` string, required
- `X-Company-Id` string, required
- `X-Track-Id` string, required
- `X-User-Id` string, required
- `Content-Type` string, required

## Request body

- EffectiveRequest — EffectiveRequest Entity
  - `businessItem` BusinessItem — Business Item Offer.
    - `offerId` number, required
    - `insurance` InsuranceBusinessItem — Insurace Component of Offer Item
      - `brokers` Broker[], required
        - `id` number — Broker id
        - `code` string — Broker Code
        - `type` BrokerType — Broker Type
          - `description` string — Description type
        - `name` string — Broker name
        - `sucursalCode` string — Sucursal Code
        - `susepCode` string — Susep Code
        - `documents` Documents — Broker document
          - `type` Type — Type Document
            - `id` number — Document type ID
            - `description` string — Document description
          - `number` string — CNPJ
      - `welcomeKitSentTo` DomainData — Data of Domain structure
        - `id` integer — Id of Data
        - `code` string — Code of Data
        - `description` string — Description of Data
      - `properties` PropertiertApplication[]
        - `address` Address — Address of the risk location.
          - `street` string
          - `complement` string
          - `city` City — city name
            - `name` string — city name
            - `state` State — State
              - …
          - `referencePoint` string
          - `postalCode` string
        - `beneficiary` Beneficiary
          - `name` string
          - `socialName` string
          - `documents` BeneficiaryDocument[]
            - `number` string
            - `type` DocumentType
              - …
          - `assetGrant` number
          - `value` BeneficiaryValue
            - `amount` number, double
      - `installments` Installments, required — Instalments of Proposed Offer
        - `sequenceGroup` number — Id of Instalment
        - `bankData` BankData — Bank Entity
          - `bankBranch` BankBranch — Branch Entity
            - `branchCode` string — branch Code of Bank
            - `branchDigit` string — branch Digit Code of Bank
          - `bankCode` string — Bank Code of Federation
          - `checkingAccount` string — Account Number of Bank
          - `checkingAccountDigit` string — Account Digiti Number of Bank
          - `document` DocumentBankData[]
            - `mainName` string — The main name of document
            - `number` string, required — Document Data of person
            - `type` DocumentType, required
              - …
        - `installmentDueDate` string, date — Payment due date, use format [yyyy-MM-dd]
  - `prospect` Prospect[]
    - `name` string — Name
    - `socialName` string — Name
    - `occupationClassificationCode` integer — Occupation ClassificationCode
    - `salaryRangeCode` integer — salary Range Code
    - `isAwareName` boolean — is Aware Name * true * false
    - `isAwareAddress` boolean — is Aware Address * true * false
    - `isPoliticallyExposedPerson` boolean — is Aware Address * true * false
    - `birthday` string, date — YYYY-MM-DD
    - `gender` '1' | '2' — Person Gender: * `1` - Male * `2` - Female
    - `documents` Document[] — Document Identification (CPF, RG, CNPJ, RNE)
      - `documentType` DocumentType
        - `description` string
        - `id` integer
      - `number` string
    - `contacts` Contact[] — contacts (e-mail e phones)
      - `data` string — Value Data of Contact, Ex: email, cellphone...
      - `isAllowCampaing` boolean — Marketing campaigns allowed
      - `isInspectionAccountable` true | false — is Inspection Accountable * true * false
      - `responsibleName` string — Responsible name
      - `type` ContactType — Contact type definitions
        - `id` 1 | 2 | 3 | 4 — 1 - Home Phone, 2 - Company Phone, 3 - CellPhone, 4 - Email
        - `description` string
    - `address` Address[] — Addresss (Payment, home, business, etc)
      - `street` string
      - `complement` string
      - `city` City — city name
        - `name` string — city name
        - `state` State — State
          - `code` string — state abbreviation
      - `referencePoint` string
      - `postalCode` string
    - `complementaryData` ComplementaryData — Complementary Data
      - `customer` Customer — Abstraction for every party (Customer, Counterpart, Broker, etc)
        - `isPoliticallyExposedPerson` boolean — is the customer a politically exposed person?
        - `netPromoterScore` integer — Customer's net promoter score, to represent how satisfied he/she is with company's services
        - `marketingScore` string — Customer internal score for marketing usage, in segmenting for product offers, etc
        - `customershipEffectiveDate` string, date — The date this person became a customer, the format YYYY-MM-DD. Ex.: 2018-11-14
        - `occupationClassification` string — Occupation Classification Code, as defined by local regulators (In Brazil, CBO is used)
        - `bankAccountTypeCode` integer — Bank account type code
      - `customerAttorneys` CustomerAttorneys[]
        - `cpf` string — The issuer Date of document
        - `name` string — The issuer name of document
      - `customerAdministrators` CustomerAdministrators[]
        - `cpf` string — The issuer Date of document
        - `name` string — The issuer name of document
      - `customerControllers` CustomerControllers[]
        - `cpf` string — The issuer Date of document
        - `name` string — The issuer name of document

## Response `201`

Created

- ProposedResponse — ProposedResponse Entity
  - `links` Link[]
    - `dataURL` string — Data URL Link
    - `type` 'VISTORIA' | 'RASTREADOR' | 'BOLETO' — Type Link

## Other responses

- `401` — Unauthorized
- `403` — Forbidden
- `404` — Not Found

---

[API](https://skmtc.dev/hdi/apis/api-authentication-and-authorization.md) · [All operations](https://skmtc.dev/hdi/apis/api-authentication-and-authorization/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/hdi/api-authentication-and-authorization/revisions/216d39155ad4/schema)