← Todas as APIs Documentação Massificados - Sancor Seguros
Logo da Sancor Seguros
API docs by Redocly

Documentação Massificados - Sancor Seguros (v2.14.0)

Download OpenAPI specification:

Conjunto de endpoints de produtos massificados da Sancor Seguros.

Dih

DihController

header Parameters
x-api-key
required
string
Request Body schema: application/json
required
identifier
required
string

Campo Identificador do produto

policyId
required
string^\d{15}$

Código da Apólice com 15 digitos

required
object

Dados da pessoa

required
object

Dados do prêmio

saleDate
required
string <date>

Data de Venda

cuttingDate
required
string <date>

Data de Corte

dueDate
required
string <date>

Data de Vencimento

startDate
required
string <date>

Início da Vigência

endDate
required
string <date>

Fim da Vigência

numberHospitalNights
required
number [ 0 .. 12 ]

Número de diárias hospitalar

required
object

Dados da capitalização

accountBearerId
required
string <= 30 characters

Identificador do Cliente

Responses

Request samples

Content type
application/json
{
  • "identifier": "string",
  • "policyId": "string",
  • "person": {
    },
  • "premium": {
    },
  • "saleDate": "2024-01-01",
  • "cuttingDate": "2024-01-01",
  • "dueDate": "2024-01-01",
  • "startDate": "2024-01-01",
  • "endDate": "2024-01-01",
  • "numberHospitalNights": 0,
  • "capitalization": {
    },
  • "accountBearerId": "string"
}

DihController

path Parameters
policyId
required
string
header Parameters
x-api-key
required
string
Request Body schema: application/json
required
reason
required
number
Enum: 1 2 3 4 7 10 11 12 13 14 15 16

Opções:
1 - Solicitação da Seguradora
2 - Solicitação do Segurado
3 - Falta de pagamento
4 - Devolução de apólice
7 - Sinistro
10 - Substituição de Veículo
11 - Substituição de Condutor
12 - Erro de Emissão
13 - Alteração de Risco
14 - Reemissão a pedido do Segurado
15 - Erro de sistema
16 - Alteração de subvenção

date
required
string <date>

Data de cancelamento

Responses

Request samples

Content type
application/json
{
  • "reason": 1,
  • "date": "1990-01-01"
}

Response samples

Content type
application/json
{
  • "protocol": "string",
  • "refund": 0,
  • "charge": 0,
  • "premiumGrossPaid": 0,
  • "totalPremiumGross": 0,
  • "premiumDue": 0,
  • "refundablePremium": 0
}

Massificado Coletivo

Incluir Itens Prestamista em Grupo

Cria itens de Prestamista em Grupo para efetivação assíncrona

header Parameters
x-api-key
required
string
Request Body schema: application/json
required
Array
productId
required
string

Identificador da contratação ou produto.
1- PLANO I
2- PLANO II

required
object

Dados da pessoa

insuredAmount
required
number <decimal> >= 1

Valor da Importância Segurada.

required
object

Dados do prêmio

saleDate
required
string <date>

Data de Venda

startDate
required
string <date>

Data de Início da Vigência

endDate
required
string <date>

Data de Fim da Vigência

externalProtocol
string <= 30 characters

Protocolo de identificação do Cliente, usado para rastreabilidade

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "protocol": "string"
}

Buscar Itens Prestamista em Grupo

Busca itens de Prestamista em Grupo conforme filtros

query Parameters
productId
string
protocol
string
externalProtocol
string
status
string
Enum: "SUCCESS" "ERROR" "PENDING"
skip
required
number >= 0
Default: 0
limit
required
number [ 1 .. 100 ]
Default: 10

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "totalCount": 100
}

Relatório de Faturamento Prestamista em Grupo

Gera relatório de faturamento de Prestamista em Grupo conforme filtros

query Parameters
productId
required
string
Example: productId=1

Identificador da contratação ou produto.

billingMonth
required
string/^\d{4}-(0[1-9]|1[0-2])$/
Example: billingMonth=2026-01

Mês de faturamento no formato AAAA-MM.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Incluir Itens Vida em Grupo

Cria itens de Vida em Grupo para efetivação assíncrona

header Parameters
x-api-key
required
string
Request Body schema: application/json
required
Array
productId
required
string

Identificador da contratação ou produto.
1- INSS
2- SIAPE
3- DEMAIS CONVÊNIOS

required
object

Dados da pessoa

saleDate
required
string <date>

Data de Venda

externalProtocol
string <= 30 characters

Protocolo de identificação do Cliente, usado para rastreabilidade

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "protocol": "string"
}

Buscar Itens Vida em Grupo

Busca itens de Vida em Grupo conforme filtros

query Parameters
productId
string
protocol
string
externalProtocol
string
status
string
Enum: "SUCCESS" "ERROR" "PENDING"
skip
required
number >= 0
Default: 0
limit
required
number [ 1 .. 100 ]
Default: 10

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "totalCount": 100
}

Relatório de Faturamento Vida em Grupo

Gera relatório de faturamento de Vida em Grupo conforme filtros

query Parameters
productId
required
string
Example: productId=1

Identificador da contratação ou produto.

billingMonth
required
string/^\d{4}-(0[1-9]|1[0-2])$/
Example: billingMonth=2026-01

Mês de faturamento no formato AAAA-MM.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Prestamista

PrestamistaController

header Parameters
x-api-key
required
string
Request Body schema: application/json
required
identifier
required
string

Campo Identificador do produto

policyId
required
string^\d{15}$

Código da Apólice com 15 digitos

required
object

Dados da pessoa

required
object

Dados do prêmio

saleDate
required
string <date>

Data de Venda

cuttingDate
required
string <date>

Data de Corte

dueDate
required
string <date>

Data de Vencimento

startDate
required
string <date>

Início da Vigência

endDate
required
string <date>

Fim da Vigência

numberInstallments
required
number >= 0

Número de parcelas

required
object

Dados da capitalização

accountBearerId
required
string <= 30 characters

Identificador do Cliente

Responses

Request samples

Content type
application/json
{
  • "identifier": "string",
  • "policyId": "string",
  • "person": {
    },
  • "premium": {
    },
  • "saleDate": "2024-01-01",
  • "cuttingDate": "2024-01-01",
  • "dueDate": "2024-01-01",
  • "startDate": "2024-01-01",
  • "endDate": "2024-01-01",
  • "numberInstallments": 0,
  • "capitalization": {
    },
  • "accountBearerId": "string"
}

PrestamistaController

path Parameters
policyId
required
string
header Parameters
x-api-key
required
string
Request Body schema: application/json
required
reason
required
number
Enum: 1 2 3 4 7 10 11 12 13 14 15 16

Opções:
1 - Solicitação da Seguradora
2 - Solicitação do Segurado
3 - Falta de pagamento
4 - Devolução de apólice
7 - Sinistro
10 - Substituição de Veículo
11 - Substituição de Condutor
12 - Erro de Emissão
13 - Alteração de Risco
14 - Reemissão a pedido do Segurado
15 - Erro de sistema
16 - Alteração de subvenção

date
required
string <date>

Data de cancelamento

Responses

Request samples

Content type
application/json
{
  • "reason": 1,
  • "date": "1990-01-01"
}

Response samples

Content type
application/json
{
  • "protocol": "string"
}