API do Segurado
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.
Fluxo de Login do Segurado
Descrição de Negócio
Um segurado, corretor ou prestador fará autenticação (login) na Sompo com usuário e senha, o usuário deverá digitar este usuário e senha em uma tela e chamar a API Login para fazer a autenticação. O serviço autenticará o usuário na Sompo. Em caso de sucesso, o serviço retornará uma mensagem dizendo "Login efetuado com sucesso!" e o SessionAuth para consulta do perfil do usuário autenticado
O usuário poderá ter o perfil (campo channel): segurado, corretor e prestador. E o device padrão é do tipo WEB. Serão dois passos, primeiro login da aplicação no API Gateway, segundo autenticação (login) com usuário e senha na API de Login método /authenticate.
Documentação (swagger) do serviço Login do Segurado.
Passo 1 (Premissa): A aplicação deve estar autenticada na plataforma de APIs da Sompo. Mais detalhes em Autenticação na plataforma de API da Sompo.
Passo 2: Chamar a API de Login Segurado.
Campo da chamada (Request)
Endpoint: https://api.sompo.com.br/[inserir-sandbox|dev|qa|]/login/authenticate
Método: POST
Parâmetros:
- Seção Header
- Authorization: [inserir-access-token].
- Content-Type: application/json
- cliente_id: [inserir-client_id]
- device:
- WEB
- MOBILE
- channel:
- CORRETOR
- SEGURADO
- CONCESSIONARIO
- ADM_PORTAL
- CONDICOES_GERAIS
- ADM_ASSESSORIA
- ASSESSORIA
- SAC_PORTAL-SEGURADO
- Seção Body:
- username: [inserir-usuario]
- password: [inserir-senha]
Exemplo de requisição:
curl --location 'https://api.sompo.com.br/[inserir-sandbox|dev|qa|]/login/authenticate' \
--header 'Authorization: [inserir-access-token]' \
--header 'client_id: [inserir-client-id]' \
--header 'channel: CORRETOR' \
--header 'device: WEB' \
--header 'Content-Type: application/json' \
--data-raw '{
"username": "[inserir-usuario]",
"password": "[inserir-senha]"
}'
Exemplo do JSON de resposta:
{
"result": true,
"message": "Login efetuado com sucesso!",
"session": "b981679b-de45-4dcf-8494-327c25379bdb-MDExMDAxNTAwMDAw"
}
Fluxo Consulta Perfil
Descrição de Negócio
Um segurado, corretor ou prestador autenticado na Sompo com usuário e senha, usando o SessionAuth consultará o perfil do usuário autenticado. Em caso de sucesso, o serviço retornará os dados do usuário logado, e as permissões que ele terá acesso.
Documentação (swagger) do serviço Consulta do Perfil.
Passo 1 (Premissa): A aplicação deve estar autenticada na plataforma de APIs da Sompo. Mais detalhes em Autenticação na plataforma de API da Sompo.
Passo 2: Chamar a API de login do segurado, e receber o SessionAuth. Mais detalhes em Fluxo Login Segurado
Campo da chamada (Request)
Endpoint: https://api.sompo.com.br/[inserir-sandbox|dev|qa|]/login/authenticate/profile
Método: GET
Parâmetros:
- Seção Header
- SessionAuth: Atributo SessionAuth retornado no serviço de autenticação (login) com usuário e senha.
- Authorization: [inserir-access-token].
- Content-Type: application/json
- cliente_id: [inserir-client_id]
- device:
- WEB
- MOBILE
- channel:
- CORRETOR
- SEGURADO
- CONCESSIONARIO
- ADM_PORTAL
- CONDICOES_GERAIS
- ADM_ASSESSORIA
- ASSESSORIA
- SAC_PORTAL-SEGURADO
Exemplo de requisição:
curl --location 'https://api.sompo.com.br/[inserir-sandbox|dev|qa|]/login/authenticate/profile' \
--header 'Authorization: [inserir-access-token]' \
--header 'client_id: [inserir-client_id]'
--header 'auth: [inserir-sessionAuth]' \
--header 'channel: CORRETOR' \
--header 'device: WEB'
Exemplo do JSON de resposta:
{
"lastAccess": 1.685974405914E12,
"userStatus": null,
"brokerData": null,
"userId": 1,
"documentNumber": "60874872000100",
"email": "email@company.com.br",
"accessType": "MARINE",
"userName": "NAME OF USER",
"fullSusep": "202059045",
"userTypeCode": 1,
"expiresMilliseconds": 1.723744701386E12,
"channel": "CORRETOR",
"branchCodeM": "1",
"brokerState": "SP",
"uu": "011001500000",
"brokerName": "CORRETORA NAME",
"brokerCodeMar": "011001500000",
"inclusionDate": 1.418958E12,
"parentHierarchyCode": null,
"device": "WEB",
"brokerCity": "SAO PAULO",
"clientCode": 0,
"permissions": [
{
"functionalityCode": 3,
"functionalityName": "Cotador Transporte"
},
{
"functionalityCode": 5,
"functionalityName": "Consultar Inspeção"
},
{
"functionalityCode": 6,
"functionalityName": "Cotador Agro"
}
],
"brokerAddress": "AV NOME n. 1 Conj 1",
"userCode": "code01",
"cookie": "MDExMDAxNTAwMDAwXjAyMDU5MDQ1ICAgICAgICAgIF5TRUdVUkFURUMgQyBTRUdec2VndXJhdGVjQHNlZ3VyYXRlYy5jb20uYnJeMTYwMV4wXjEwMDE3MjYyMzleMV4xMDAxNV4wXk5eMyw1LDYsOCw5LDExLDEyLDE2LDE3LDE4LDE5LDIwLDIxLDIyLDIzLDI1LDI2LDI4LDI5LDMwLDMyLDM2LDM4LDM5LDQwLDQyLDQzLDQ0LDQ1LDQ2LDQ5LDUxLDUyLDUzLDU0LDYwLDY5LDcwLDczLDg1LDg2LDg3LDg4LDkwLDkxLDkyLDkzLDk0LDk1LDk4LDExMiwxMTMsMTE4LDExOSwxMjEsMTIyLDEyMywxMjQsMTI1LDEyNiwxMjgsMTI5LDEzMSwxNDAsMTQxLDE0OCwxNDksMTUwLDE1MiwxNjMsMTY0LDE2NiwxNjgsMTc4LDE5MCwxOTEsMjAwLDIwNCwyMDUsMjE5LDIyMSwyMjUsMjI2LDIyNywyMjgsMjI5LDIzMCwyMzQsMjM1LDIzNiwyMzcsMjM4LDIzOSwyNDEsMjQyLDI0NCwyNDUsMjQ2LDI0NywyNDgsMjUwLDI1MSwyNTIsMjUzLDI1NCwyNTUsMjU2LDI1NywyNTgsMjU5XjYwODc0ODcyMDAwMTAwXjFeMDExMDAxNTAwMDAwXjIwMjA1OTA0NQ==",
"phoneNumber": "123456789",
"fullSusepEncrypted": "nepLiLHaKCdL+kzrGqenf8jxsE1z91XFBwKv5RTfyuJo2YI5H3oYHl5t3VkA6Wdy",
"reducedSusep": "12345678",
"mainUserCode": "code01",
"branchCode": null,
"fullBrokerName": "CORRETORA NAME",
"hierarchicalCode": null,
"isTransport": false,
"userTypeDescription": "CORRETOR",
"personType": "J",
"brokerCodeM": "10015",
"authentication": "c2VnaTAxLTIwMjQwODE1",
"expires": "Thu Aug 15 17:58:21 GMT-03:00 2023",
"parentUserCode": null,
"typeCode": "PRINCIPAL",
"sapId": 1234567890,
"consCode": null,
"brokerZipCode": "00000-000",
"groupBrokerFullSusep": "123456789",
"producerCode": null,
"superBroker": null;
"loggedUserDocumentNumber": "12345678901234",
"brokerCode": 1234,
"activeCode": 1,
"brokerList": [
{
"brokerCode": 1234,
"susepNumber": "12345678",
"brokerName": "CORRETORA NAME",
"fullSusep": "123456789",
"status": "ATIVO",
"documentNumber": 1.2345678901E23
}
],
"auxiliaryCode": 1,
"collaboratorCodeM": "0",
"isDealership": false,
"susepEncrypted": "EDhLXYxP1imUqj3gbhG/w79nhUIyuBaXzlQ6RYl+/59o2YI5H3oYHl5t3VkA6Wdy",
"labelCode": "1"
}
Fluxo Dados Cadastrais
Descrição de Negócio
Serviço de consulta de dados cadastrais. Retorna informações sobre o cadastro na Sompo de acordo com CPF / CNPJ.
Documentação (swagger) do serviço Consulta de dados cadastrais.
Passo 1 (Premissa): A aplicação deve estar autenticada na plataforma de APIs da Sompo. Mais detalhes em Autenticação na plataforma de API da Sompo.
Passo 2: Chamar a API de Consulta de Dados Cadastrais
Exemplo do JSON de request:
curl -X 'GET' 'https://api.sompo.com.br/[inserir-sandbox|dev|qa|]/policyholders/v1/123456789'
-H 'accept: application/json'
Exemplo do JSON de resposta:
{
"emails": [
{
"ordem": "001",
"email": "teste2@teste.com.br"
}
],
"endereços": [
{
"cidade": "INDEFINIDA",
"bairro": "CENTRO",
"numero": "100",
"cep": "99999999",
"uf": "SP",
"logradouro": "AVENIDA INDEFINIDA"
},
{
"cidade": "EXEMPLO",
"bairro": "BAIRRO EXEMPLO",
"numero": "150",
"cep": "99999999",
"uf": "XX",
"logradouro": "RUA INDEFINIDA"
},
{
"cidade": "CIDADE EXEMPLO",
"bairro": "CENTRO",
"numero": "3000",
"cep": "99999999",
"uf": "SP",
"logradouro": "R INDEFINIDA"
},
{
"cidade": "SAO PAULO",
"bairro": "EXEMPLO",
"numero": "250",
"cep": "09999999",
"uf": "SP",
"logradouro": "RUA INDEFINIDA"
}
],
"telefones": [
{
"ordem": "001",
"telefone": "1122999999",
"telefoneCompleto": "+551122999999"
},
{
"ordem": "002",
"telefone": "4133888888",
"telefoneCompleto": "+554133888888"
},
{
"ordem": "003",
"telefone": "1122569999",
"telefoneCompleto": "+551122569999"
}
],
"dadosCadastrais": {
"dataNascimento": "1948-11-21",
"naturalidade": "SAO PAULO",
"genero": "F",
"nome": "MARIA JOSE DA SILVA",
"nacionalidade": "BR"
},
"dadosFiscais": [
{
"tipoDocumentoFiscal": "BR2",
"documentoFiscal": "03333627464"
}
]
}
Fluxo Redefinir Senha
Descrição de Negócio
Serviço para redefinir senha dos usuários na Plataforma Digital de Relacionamentos para os perfis de Segurado, Corretor e Prestador. Retorna senha recuperada.
Documentação (swagger) do serviço API Geração/Recuperação de senha.
Passo 1 (Premissa): A aplicação deve estar autenticada na plataforma de APIs da Sompo. Mais detalhes em Autenticação na plataforma de API da Sompo.
Passo 2: Chamar a API de Geração/Recuperação de senha.
Endpoint: https://api.sompo.com.br/[inserir-sandbox|dev|qa|]/login/password/reset
Método: POST
Parâmetros:
- Seção Header
- authorization: [inserir-access-token]
- cliente_id: [inserir-client_id]
- channel:
- CORRETOR
- SEGURADO
- CONCESSIONARIO
- ADM_PORTAL
- CONDICOES_GERAIS
- ADM_ASSESSORIA
- ASSESSORIA
- SAC_PORTAL-SEGURADO
- Seção Body:
- newPassword: [inserir-nova-senha]
- userId: [inserir-user-id]
Exemplo de requisição:
curl --location 'https://api.sompo.com.br/[inserir-sandbox|dev|qa|]/login/password/reset' \
--header 'client_id: [inserir-client_id]' \
--header 'authorization: [inserir-access-token]' \
--header 'channel: SEGURADO' \
--data-raw '{
"newPassword": "[inserir-nova-senha]"
"userId": "[inserir-user-id]"
}'
Exemplo do JSON de resposta:
{
"code": "200",
"message": "Senha alterada"
}
Fluxo de Primeiro Acesso do Segurado
Descrição de Negócio
Fluxo para validação do Primeiro Acesso dos usuários na Plataforma Digital de Relacionamentos para os perfis de Segurado, Corretor e Prestador.
Serão quatro passos:
Passo 1 (Premissa): A aplicação deve estar autenticada na plataforma de APIs da Sompo. Mais detalhes em Autenticação na plataforma de API da Sompo.
Passo 2: Chamar a API de Consulta dos dados do usuário com CPF/CNPJ ou e-mail.
Passo 3: Chamar a API de Consulta de apólice (para verificar a vigência).
Passo 4: Chamar a API de Consulta para validação do segurado/corretor/prestador.
Passo 5: Chamar a API de Cadastro do segurado.
Passo 2 - API de Consulta dos dados do usuário com CPF/CNPJ ou e-mail
Descrição de Negócio
Na tela de cadastro para o primeiro acesso, após a confirmação dos dados do segurado, o serviço de LDAP é acionado. Esse processo garante a verificação e autenticação das informações, permitindo a criação segura da conta no portal.
Para maiores informações, documentação (swagger) da API de Consulta dos dados do usuário com CPF/CNPJ ou e-mail
Endpoint: https://api.sompo.com.br/[inserir-sandbox|dev|qa|]/login/policyholder/profile
Método: GET
Parâmetros:
- Seção Header
- Authorization: [inserir-access-token]
- cliente_id: [inserir-client_id]
- Parâmetros GET (informar apenas um dos parâmetros):
- documentNumber: [inserir-cpf-ou-cnpj]
- email: [inserir-email]
Exemplo de requisição:
curl --location 'https://api.sompo.com.br/[inserir-sandbox|dev|qa|]/login/policyholder/profile?documentNumber=12345678901' \
--header 'Authorization: [inserir-access-token]' \
--header 'client_id: [inserir-client-id]'
Exemplo do JSON de resposta:
{
"entity": {
"documentNumber": 12345678901,
"partnerName": "CARXXXXXXXXX ",
"sapId": "1234567890",
"statusCode": 1,
"policyholderStatus": 0,
"email": null,
"phoneNumber": null,
"origin": "Y",
"partnerNickname": "ZezXXXXXXXXXho"
},
"documentNumber": "12345678901",
"partnerName": "CXXXXS AXXXXXO PXXXXO",
"phoneNumber": "11987654321",
"email": "CXXXXS3400000181@malinator.com.br"
}
Passos 3 - API Consulta de apólice (para verificar a vigência)
Descrição de Negócio
Na tela de cadastro para o primeiro acesso, após a confirmação dos dados do segurado, o serviço de consulta de apólice é acionado para verificar a vigência da mesma. O acesso ao portal do segurado é permitido apenas para aqueles que possuem apólices vigentes.
Para maiores informações, documentação (swagger) da API Consulta de apólice (para verificar a vigência)
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"
}
]
}
Passo 4 - API de Consulta para validação do segurado/corretor/prestador
Descrição de Negócio
Na tela de cadastro para o primeiro acesso, após a confirmação dos dados do segurado, o serviço de validação de segurado é acionado. Esse serviço garante que as informações fornecidas estejam corretas e que o segurado esteja devidamente registrado antes de concluir o cadastro e obter acesso ao portal.
Para maiores informações, documentação (swagger) da API de Consulta para validação do segurado/corretor/prestador
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"
}
]
}
Passo 5 - API de Cadastro do Segurado
Descrição de Negócio
Na tela de cadastro para o primeiro acesso, após a validação dos dados do segurado, o serviço de cadastro do segurado é acionado.
Para maiores informações, documentação (swagger) da API de Cadastro do Segurado
Endpoint: https://api.sompo.com.br/[inserir-sandbox|dev|qa|]/login/policyholder/register
Método: GET
Parâmetros:
- Seção Header
- Authorization: [inserir-access-token]
- cliente_id: [inserir-client_id]
- Content-Type: application/json
- device:
- WEB
- MOBILE
- Seção Body:
- registerType: [inserir-tipo-registro]
- policeholderType: [inserir-tipo-segurado]
- policeholderName: [inserir-nome-segurado]
- documentNumber: [inserir-cpf-cnpj]
- birthdate: [inserir-data-nascimento]
- email: [inserir-email]
- mobile: [inserir-celular]
- bpNumber: [inserir-numero-bp]
- password: [inserir-senha]
- phone: [inserir-telefone]
Exemplo de requisição:
curl --location 'https://api.sompo.com.br/[inserir-sandbox|dev|qa|]/login/policyholder/register' \
--header 'client_id: [inserir-client_id]' \
--header 'Authorization: [inserir-access-token]' \
--header 'device: WEB' \
--header 'Content-Type: application/json' \
--data-raw '{
"registerType": " ",
"policeholderType": "1",
"policeholderName": "John Doe",
"documentNumber": "12345678901",
"birthdate": "20000101",
"email": "john.doe@sompo.com.br",
"mobile": "11987654321",
"bpNumber": " ",
"password": "pass123",
"phone": "11 987654321"
}'
Exemplo do JSON de resposta:
{
"codeResponse": "0",
"errorMessage": ""
}
