API Apólices
Para ir direto para a documentação da API clique em swagger. Abaixo o índice dos serviços disponíveis.
Premissa
Para consumir as APIs da Sompo é preciso seguir os passos a abaixo.
Cadastro: O primeiro passo é fazer o cadastro no Portal Developers Sompo, este cadastro passará por uma aprovação interna.
Seleção dos Serviços: O segundo passo é criar um APP e adicionar as APIs que você deseja consumir neste APP.
Autenticação na plataforma de APIs da Sompo: Agora que você já tem um username, password e client-id, você precisa fazer a autenticação na API de Access-Token para receber uma credencial de acesso as APIs da Sompo.
A descrição completa do processo está descrita na página Autenticação na plataforma de API da Sompo.
Consulta Apólice
Descrição de Negócio
Serviço para consulta dos dados da apólice.
Para maiores informações, documentação (swagger) da API Consulta Apólice
Endpoint: https://api.sompo.com.br/[inserir-sandbox|dev|qa|]/policies/policy
Método: GET
Parâmetros:
- Seção Header
- auth: [inserir-token]
- Authorization: [inserir-access-token]
- cliente_id: [inserir-client_id]
- device:
- WEB
- MOBILE
- channel:
- CORRETOR
- SEGURADO
- CONCESSIONARIO
- ADM_PORTAL
- CONDICOES_GERAIS
- ADM_ASSESSORIA
- ASSESSORIA
- SAC_PORTAL-SEGURADO
- documentNumber: [inserir-cpf-ou-cnpj]
Exemplos de requisição:
curl --location 'https://api.sompo.com.br/[inserir-sandbox|dev|qa|]/policies/policy' \
--header 'auth: [inserir-token]' \
--header 'client_id: [inserir-client_id]' \
--header 'Authorization: [inserir-access-token]' \
--header 'channel: CORRETOR' \
--header 'device: WEB' \
--header 'documentNumber: [inserir-cpf-ou-cnpj]'
Exemplo do JSON de resposta:
{
"result": [
{
"system": "9",
"coBroker2Name": "-",
"brokerCodeMaritima": "123456789012",
"brokerState": "RJ",
"policyCancellationDateFormatted": "01/01/2023",
"brokerEmployeeMaritima": "99999",
"policyEndDateFormatted": "01/01/2026",
"policyStartDateFormatted": "01/01/2025",
"unitName": "-",
"policyBranch": "RISCOS DIVERSOS",
"brokerNumberMaritima": "12345",
"phoneAreaCode": "21",
"stateAbbreviation": "RJ",
"addressTypeCode": "RUA",
"personIdentificationCode": "1",
"policyCancelled": "S",
"policyholderDocumentNumberFormatted": "123.456.789-00",
"policyStartDate": "20250101",
"brokerCity": "RIO DE JANEIRO",
"neighborhoodName": "CENTRO",
"brokerName": "CORRETORA DE SEGUROS LTDA",
"expiryDate": "01/01/2026",
"insuranceObjectSap": "X1234567890",
"policyNumberFormatted": "1234567890",
"brokerPhoneAreaCode": "21",
"issueDateFormatted": "01/01/2025",
"phoneNumber": "99999-9999",
"policyBranchYasuda": "123",
"effectiveDateFormatted": "De 24hs 01/01/2025",
"quoteType": "9",
"addressComplementDescription": "101",
"insuredCodeMaritima": "123456",
"registrationCode": "9",
"brokerBranchMaritima": "02",
"generalPolicyStartDateFormatted": "01/01/2025",
"riskAddress": "RUA FXXXXXXX",
"zipCode": "12345678",
"brokerEmail": "contato@seguros.com.br",
"noItems": "1",
"policyCancellationDate": "20230101",
"insuredCodeMaritima": "654321",
"brokerZipCode": "12345-678",
"divisionCode": "9",
"unitCode": "9001",
"policyEndDate": "20260101",
"cityName": "RIO DE JANEIRO",
"brokerCodeYasuda": "987654",
"coBroker3CodeYasuda": "1",
"brokerBp": "9876543210",
"policyNumber": "1234567890",
"origin": "Z",
"brokerDocumentNumber": "12345678000100",
"divisionDescription": "DIV.",
"policyBranchOffice": "-",
"policyholderDocumentNumber": "12345678900",
"insuredName": "MARIA FXXXXXXX",
"generalPolicyIssueDateFormatted": "01/01/2025",
"referenceDate": "01/01/2025",
"producerCode": "9876",
"issueDate": "20250101",
"version": "1.0",
"effectiveDate": "01/01/2025",
"brokerSusep": "98765432",
"generalPolicyIssueDate": "20250101",
"endorsement": "1",
"completeSusepNumber": "1234567890",
"generalPolicyStartDate": "20250101",
"policyBranchMaritima": "123",
"brokerAddress": "RUA FXXXXXXX, 123",
"insuredNickname": "-",
"producerName": "-",
"policyEndorsement": "1",
"brokerPhoneNumber": "99999-9999",
"insuredIdSap": "1234567890",
"coBroker3Name": "-",
"coBroker2CodeYasuda": "1"
}
]
}
Valida Segurado
Descrição de Negócio
Serviço para validação dos dados do segurado.
Para maiores informações, documentação (swagger) da API Valida Segurado
Endpoint: https://api.sompo.com.br/[inserir-sandbox|dev|qa|]/policies/policyholder/validate
Método: GET
Parâmetros:
- Seção Header
- auth: [inserir-access-token]
- cliente_id: [inserir-client_id]
- device:
- WEB
- MOBILE
- channel:
- CORRETOR
- SEGURADO
- CONCESSIONARIO
- ADM_PORTAL
- CONDICOES_GERAIS
- ADM_ASSESSORIA
- ASSESSORIA
- SAC_PORTAL-SEGURADO
- documentNumber: [inserir-cpf-ou-cnpj]
Exemplo de requisição:
curl --location 'https://api.sompo.com.br/[inserir-sandbox|dev|qa|]/policies/policyholder/validate' \
--header 'auth: [inserir-token]' \
--header 'client_id: [inserir-client_id]' \
--header 'Authorization: [inserir-access-token]' \
--header 'channel: CORRETOR' \
--header 'device: WEB' \
--header 'documentNumber: [inserir-cpf-ou-cnpj]'
Exemplo do JSON de resposta:
{
"result": [
{
"isValid": true,
"policyFound": true,
"message": "Sucesso"
}
]
}