---
title: "Service dedicated to listing policies"
method: GET
path: "/policies/details"
tags: ["Policies"]
---

# Service dedicated to listing policies

`GET /policies/details`

Service dedicated to listing policies

## Query parameters

- `productCode` string
- `startIssueDate` string
- `endIssueDate` string
- `policyCode` string, required
- `customerName` string
- `customerDocument` string
- `skip` integer
- `limit` integer

## Headers

- `X-Company-Id` string, required
- `X-Sucursal-Code` string, required
- `X-Susep-Code` string, required
- `X-User-Id` string, required
- `X-Application-Id` string, required
- `X-Trace-Id` string, required

## Response `200`

Sucesso

- object[]
  - `demonstrative` Demonstrative
    - `statementNum` integer
    - `paymentDate` string
    - `policy` Policy — Policy Entity
      - `code` string — Code policy
      - `congenerCode` string — Congener code policy
      - `endDate` string — End date policy
    - `commissionValue` Amount — Informations of Amount
      - `amount` number — Description about amount
      - `amountFormatted` string — Amount Formatted
      - `currency` string — Amount Currency
    - `advanceValue` Amount — Informations of Amount
      - `amount` number — Description about amount
      - `amountFormatted` string — Amount Formatted
      - `currency` string — Amount Currency
    - `reductionValue` Amount — Informations of Amount
      - `amount` number — Description about amount
      - `amountFormatted` string — Amount Formatted
      - `currency` string — Amount Currency
    - `grossValue` Amount — Informations of Amount
      - `amount` number — Description about amount
      - `amountFormatted` string — Amount Formatted
      - `currency` string — Amount Currency
    - `difference` Amount — Informations of Amount
      - `amount` number — Description about amount
      - `amountFormatted` string — Amount Formatted
      - `currency` string — Amount Currency
    - `netValue` Amount — Informations of Amount
      - `amount` number — Description about amount
      - `amountFormatted` string — Amount Formatted
      - `currency` string — Amount Currency
    - `comissions` Comission
      - `document` Document
        - `documentType` DocumentType
          - `description` string
          - `id` integer
        - `number` string
      - `portfolio` Portifolio — Entity for our Product Portfolio
        - `id` integer — ID of Portifolio
        - `compositionCode` string — Code of Portifolio: 431 - HDI Perfil; 005 - Residencial
        - `name` string — Name of Portifolio
      - `company` Company — Company entity
        - `id` integer — ID of company
        - `code` '01' | '03' | '04' — Code of company: 01 - HDI; 04 - SantanderAuto
        - `name` string — Name of company
      - `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
      - `product` Product — Product Entity
        - `id` integer — Product Id
        - `code` string — Product Code
        - `name` string — Name of Product
      - `statementNumber` integer
      - `paymentDate` string
      - `branchCode` string
      - `endorsementSequence` string
      - `premiumValue` string
      - `commissionPercentage` string
  - `total` object
    - `commissionValue` Amount — Informations of Amount
      - `amount` number — Description about amount
      - `amountFormatted` string — Amount Formatted
      - `currency` string — Amount Currency
    - `advanceValue` Amount — Informations of Amount
      - `amount` number — Description about amount
      - `amountFormatted` string — Amount Formatted
      - `currency` string — Amount Currency
    - `deductionAmount` Amount — Informations of Amount
      - `amount` number — Description about amount
      - `amountFormatted` string — Amount Formatted
      - `currency` string — Amount Currency
    - `grossValue` Amount — Informations of Amount
      - `amount` number — Description about amount
      - `amountFormatted` string — Amount Formatted
      - `currency` string — Amount Currency
    - `differenceValue` Amount — Informations of Amount
      - `amount` number — Description about amount
      - `amountFormatted` string — Amount Formatted
      - `currency` string — Amount Currency
    - `netValue` Amount — Informations of Amount
      - `amount` number — Description about amount
      - `amountFormatted` string — Amount Formatted
      - `currency` string — Amount Currency

## Other responses

- `204` — No content responses
- `400` — Bad request
- `401` — Unauthorized
- `403` — Forbidden
- `404` — Not found
- `453` — Business Exception
- `500` — Exception

---

[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)