Risk Object

A API Risk Object permite que os parceiros possam realizar operações necessárias e consultar dados específicos do objeto de risco.

Pré-requisitos

Antes de começar a utilizar a API, é fundamental compreender os requisitos de autenticação e obter as credenciais necessárias.

Certifique-se de revisar a seção de autenticação para garantir uma integração segura e bem-sucedida.

Listar dados do objeto de risco

Permite listar dados que compõem o objeto de risco.

Requisição (Request)

Url	https://api-sandbox.pottencial.com.br/riskobject/v1/products/{product_key}/risk-object-data
Method	GET
Query	product_key	Chave de identificação do produto maquinas-equipamentos benfeitorias penhor-rural
Headers	client_id	Client ID da App.
	access_token	Token de acesso gerado para a App.

Respostas (Response)

Status	Descrição	Tipo
200	Lista dados que compõem o objeto de risco.	RiskObjectDataResponse
400	Os dados da requisição estão inválidos.	ErrorResult
401	Parceiro não autorizado a realizar a operação.	ErrorResult
403	Parceiro não autorizado a realizar a operação.	ErrorResult
500	Erro interno da API. Por favor tente novamente mais tarde ou contate o suporte técnico da Pottencial.	ErrorResult

Exemplo

{
    "manufacturers": [
        {
            "id": "e6a98888-fc7e-4e23-8097-448d982e262f",
            "name": "Agrale"
        },
        {
            "id": "17862f5d-62be-42fa-a80d-bb5711dc8bb1",
            "name": "Baldan"
        }
    ],
    "utilizations": [
        {
            "id": "baa508d4-70c7-4f99-85e0-39afa2e815fd",
            "name": "Atividades não agrícolas"
        },
        {
            "id": "87bbfcb4-925c-4e98-9018-5a84fd4aa9cf",
            "name": "Comércio"
        }
    ],
    "equipmentTypes": [
        {
            "id": "d1da50ca-64ae-4a26-83a0-d2d9b61e0f30",
            "name": "Abafador (Ruído)",
            "selfPropelled": false
        },
        {
            "id": "e2ddc332-90bf-4b09-a741-41f77eb83846",
            "name": "Wagon-drills (Vagão C/furadeira)",
            "selfPropelled": true
        }
    ]
}

Listar coberturas

Permite listar coberturas disponíveis para o produto Pottencial.

Requisição (Request)

Url	https://api-sandbox.pottencial.com.br/riskobject/v1/products/{product_key}/coverages
Method	GET
Query	product_key	Chave de identificação do produto maquinas-equipamentos benfeitorias penhor-rural
Headers	client_id	Client ID da App.
	access_token	Token de acesso gerado para a App.

Respostas (Response)

Status	Descrição	Tipo
200	Lista coberturas para o produto.	CoverageListResponse
400	Os dados da requisição estão inválidos.	ErrorResult
401	Parceiro não autorizado a realizar a operação.	ErrorResult
403	Parceiro não autorizado a realizar a operação.	ErrorResult
500	Erro interno da API. Por favor tente novamente mais tarde ou contate o suporte técnico da Pottencial.	ErrorResult

Exemplo

{
    "coverages": [
        {
            "key": "rc-maquinas",
            "name": "Responsabilidade Civil Máquinas",
            "insuredAmountEditable": true,
            "includedByDefault": false,
            "insuredAmount": {
                "min": {
                    "value": 0,
                    "percent": 0
                },
                "max": {
                    "value": 1000000,
                    "percent": 1
                }
            }
        },
        {
            "key": "danos-eletricos",
            "name": "Danos Elétricos",
            "insuredAmountEditable": true,
            "includedByDefault": false
        },
        {
            "key": "basica",
            "name": "Cobertura Básica - Riscos Diversos Máquinas e Equipamentos",
            "insuredAmountEditable": false,
            "includedByDefault": true
        }
    ]
}

Listar Motivos de Cancelamento

Permite listar os motivos de cancelamento dos produtos da Pottencial.

Requisição (Request)

Url	https://api-sandbox.pottencial.com.br/riskobject/v1/products/{product_key}/cancellations-reasons
Method	GET
Query	product_key	Chave de identificação do produto maquinas-equipamentos benfeitorias penhor-rural
Headers	client_id	Client ID da App.
	access_token	Token de acesso gerado para a App.

Respostas (Response)

Status	Descrição	Tipo
200	Lista dos motivos de cancelamento.	CancellationReasons
400	Os dados da requisição estão inválidos.	ErrorResult
401	Parceiro não autorizado a realizar a operação.	ErrorResult
403	Parceiro não autorizado a realizar a operação.	ErrorResult
500	Erro interno da API. Por favor tente novamente mais tarde ou contate o suporte técnico da Pottencial.	ErrorResult

Exemplo


[
  {
    "id": "111ccccccddd-2222-1111-aaaa-bbbbbb0000",
    "reason": "Solicitado pelo segurado"
  },
  {
    "id": "111ccccccddd-2222-1111-aaaa-bbbbbb0001",
    "reason": "Falta de pagamento"
  }
]

Listar atividades

Permite listar as atividades dos produtos da Pottencial.

Requisição (Request)

Url	https://api-sandbox.pottencial.com.br/riskobject/v1/{product_key}/activities
Method	GET
Query	product_key	Chave de identificação do produto residencial empresarial vida
Headers	client_id	Client ID da App.
	access_token	Token de acesso gerado para a App.

Respostas (Response)

Status	Descrição	Tipo
200	Lista tipos de equipamentos produto Riscos Diversos.	ActivitiesResponse
400	Os dados da requisição estão inválidos.	ErrorResult
401	Parceiro não autorizado a realizar a operação.	ErrorResult
403	Parceiro não autorizado a realizar a operação.	ErrorResult
500	Erro interno da API. Por favor tente novamente mais tarde ou contate o suporte técnico da Pottencial.	ErrorResult

Exemplo Empresarial


[
  {
    "id": "111ccccccddd-2222-1111-aaaa-bbbbbb0000",
    "activityName": "Agência de emprego",
    "groupName": "Serviço",
    "enabled": "true",
    "susepRiskActivityType": "Business",
    "susepRiskActivityClassType": "Services"
  },
  {
    "id": "111ccccccddd-2222-1111-aaaa-bbbbbb0001",
    "activityName": "Chocolates e cacau e derivados - Loja",
    "groupName": "Comércio",
    "enabled": "true",
    "susepRiskActivityType": "Business",
    "susepRiskActivityClassType": "Commerce"
  }
]

Exemplo Residencial


[
  {
    "id": "111ccccccddd-2222-1111-aaaa-bbbbbb0000",
    "description": "Agência de emprego",
    "professionalType": "IndividualMicroentrepreneur"
  },
  {
    "id": "111ccccccddd-2222-1111-aaaa-bbbbbb0011",
    "description": "Agência de emprego",
    "professionalType": "LiberalProfessional"
  }
]

Listar serviços de assistência

Permite listar os serviços de assistência dos produtos da Pottencial.

Requisição (Request)

Url	https://api-sandbox.pottencial.com.br/riskobject/v1/assists-services/{product_key}
Method	GET
Query	product_key	Chave de identificação do produto residencial empresarial vida
Headers	client_id	Client ID da App.
	access_token	Token de acesso gerado para a App.

Respostas (Response)

Status	Descrição	Tipo
200	Lista serviços de assistências.	AssistanceResponse
400	Os dados da requisição estão inválidos.	ErrorResult
401	Parceiro não autorizado a realizar a operação.	ErrorResult
403	Parceiro não autorizado a realizar a operação.	ErrorResult
500	Erro interno da API. Por favor tente novamente mais tarde ou contate o suporte técnico da Pottencial.	ErrorResult

Exemplo


[
  {
    "id": "111ccccccddd-2222-1111-aaaa-bbbbbb0000",
    "serviceName": "Empresarial - Europ",
    "serviceDescription": "Assistência PME ",
    "linkDescription": "Assistência"
  },
  {
    "id": "233ccccccddd-2222-1111-aaaa-bbbbbb0000",
    "serviceName": "Empresarial -123",
    "serviceDescription": "Assistência Empresarial ",
    "linkDescription": "Assistência 002"
  }
]

Consultar tribunais e varas

Permite listar tribunais cadastrados na Pottencial.

Requisição (Request)

Url	https://api-sandbox.pottencial.com.br/riskobject/v1/court
Method	GET
Headers	client_id	Client ID da App.
Headers	access_token	Token de acesso gerado para a App.
Query	process	Numero do Processo Trabalhista ou Cível.
Query	courtOfLawCnjNumber	Número CNJ do Tribunal.
Query	courtCnjNumber	Número CNJ da Vara.
Query	courtOfLawDocumentNumber	CNPJ do Tribunal.
Query	courtName	Nome da Vara.
Query	courtCity	Nome da Cidade da Vara.
Query	courtState	Sigla do Estado da Vara.
Query	courtZipCode	CEP do endereço da Vara.

Respostas (Response)

Status	Descrição	Tipo
200	Lista de tribunais cadastrados na Pottencial.	CourtSearchResponse
400	Os dados da requisição estão inválidos.	ErrorResult
401	Parceiro não autorizado a realizar a operação.	ErrorResult
403	Parceiro não autorizado a realizar a operação.	ErrorResult
500	Erro interno da API. Por favor tente novamente mais tarde ou contate o suporte técnico da Pottencial.	ErrorResult

Exemplo


{
  "courtOfLawCnjNumber": "11111111111111",
  "courtOfLawDocumentNumber": "22222222222222222222",
  "courts": [
    {
      "id": "233ccccccddd-2222-1111-aaaa-bbbbbb0000",
      "name": "vara 01",
      "courtCnjNumber": "33333333333333",
      "address": {
        "city": "São Paulo",
        "state": "SP",
        "zipCode": "30380403"
      }
    },
    {
      "id": "556ccccccddd-2222-1111-aaaa-bbbbbb0111",
      "name": "vara 02",
      "courtCnjNumber": "44444444444",
      "address": {
        "city": "Belo Horizonte",
        "state": "MG",
        "zipCode": "30380403"
      }
    }
  ]
}

Dicionário

RiskObjectDataResponse

Campo	Tipo	Regras	Descrição
manufacturers	Lista de RiskObjectDataManufacturerResponse	Somente Leitura	Lista de Fabricantes.
utilizations	Lista de RiskObjectDataUtilizationResponse	Somente Leitura	Lista de Tipos de utilização.
equipmentTypes	Lista de RiskObjectDataEquipmentTypeResponse	Somente Leitura	Lista de Tipos de equipamento.

RiskObjectDataManufacturerResponse

Campo	Tipo	Regras	Descrição
id	string	Somente Leitura	Identificador do fabricante.
name	string	Somente Leitura	Nome do fabricante.

RiskObjectDataUtilizationResponse

Campo	Tipo	Regras	Descrição
id	string	Somente Leitura	Identificador da utilização.
name	string	Somente Leitura	Nome da utilização.

RiskObjectDataEquipmentTypeResponse

Campo	Tipo	Regras	Descrição
id	string	Somente Leitura	Identificador do tipo de equipamento.
name	string	Somente Leitura	Nome do tipo de equipamento.
selfPropelled	boolean	Somente Leitura	Flag que indica se o equipamento possui motor.

CoverageListResponse

Campo	Tipo	Regras	Descrição
coverages	Lista de CoverageResponse	Somente Leitura	Lista de Coberturas.

CoverageResponse

Campo	Tipo	Regras	Descrição
key	string	Somente Leitura	Identificador da cobertura.
name	string	Somente Leitura	Nome da cobertura.
insuredAmountEditable	boolean	Somente Leitura	Flag que indica se a importância segurada da cobertura é editável.
includedByDefault	boolean	Somente Leitura	Flag que indica se a cobertura é incluída por padrão.
insuredAmount	CoverageInsuredAmountResponse	Somente Leitura	Detalhes sobre a importância segurada.

CoverageInsuredAmountResponse

Campo	Tipo	Regras	Descrição
min	CoverageInsuredAmountRangeResponse	Somente Leitura	Detalhes sobre o valor mínimo da importância segurada.
max	CoverageInsuredAmountRangeResponse	Somente Leitura	Detalhes sobre o valor máximo da importância segurada.

CoverageInsuredAmountRangeResponse

Campo	Tipo	Regras	Descrição
value	decimal	Somente Leitura	Valor financeiro.
percent	decimal	Somente Leitura	Valor percentual.

AssistanceResponse

Campo	Tipo	Regras	Descrição
serviceId	number	Opcional	Identificador do tipo do serviço.
serviceName	string	Opcional	Nome do tipo de serviço de assistência.
serviceDescription	string	Opcional	Descrição do tipo de serviço de assistência.
linkDescription	string	Opcional	Link de descrição do tipo de serviço de assistência.

ActivityEmpresarial

Campo	Tipo	Regras	Descrição
id	string (guid)	Opcional	Identificador do tipo de atividade.
activityName	string	Opcional	Nome da atividade.
groupName	string	Opcional	Grupo da atividade.
enabled	boolean	Opcional	Flag que indica se a atividade está habilitada.
susepRiskActivityType	string	Opcional	Tipo de atividade Susep.
susepRiskActivityClassType	string	Opcional	Classe de atividade Susep.

ActivityResidencial

Campo	Tipo	Regras	Descrição
id	string (guid)	Opcional	Identificador da atividade.
description	string	Opcional	Descrição da atividade.
professionalType	string (ProfessionalType)	Opcional	Tipo de profissional.

ProfessionalType

IndividualMicroentrepreneur: Micro Empreendedor individual MEI
LiberalProfessional : Profissional Liberal.

CourtSearchResponse

Campo	Tipo	Regras	Descrição
courtOfLawCnjNumber	string	Opcional	Número CNJ da Vara.
courtOfLawDocumentNumber	string	Opcional	CNPJ do Tribunal.
courts	Lista de CourtRiskObject	Opcional	Varas

CourtRiskObject

Campo	Tipo	Regras	Descrição
id	string	Opcional	Identificador da Vara.
name	string	Opcional	Nome da Vara.
courtCnjNumber	string	Opcional	Número CNJ da Vara.
address	CourtAddress	Opcional	Endereço da Vara.

CourtAddress

Campo	Tipo	Regras	Descrição
city	string	Obrigatório	Nome da cidade.
statename	string	Opcional	Sigla do estado.
zipCode	string	Obrigatório	CEP do endereço.

CancellationReasons

Campo	Tipo	Regras	Descrição
id	string (guid)	Obrigatório	Identificador do tipo de atividade.
Reason	string	Obrigatório	Nome da atividade.

Resolução de erros

Código	Erro	Descrição	Solução
400	Bad Request	Invalid secret in Authorization header	O client_secret informado no header é inválido. Verifique se o client_secret informado é o mesmo da APP e se o header Authorization está sendo passado conforme especificado.
401	Unauthorized	Could not find a required APP in the request, identified by HEADER client_id.	O client_id informado no header é inválido. Verifique se o client_id informado é o mesmo da APP e se o header Authorization está sendo passado conforme especificado.
404	Not Found	Not Found	Provavelmente a URL sendo chamado não está correta. Verifique se está conforme especificado.
415	Unsupported Media Type	Content type not supported	O header Content-Type não está sendo informado conforme esperado. O correto é application/json.
429	Too Many Requests	Too Many Requests	O consumidor estourou o limite de requisições por tempo. Aguarde um pouco para tentar novas requisições.
500	Internal Server Error	Internal Server Error	Erro não esperado, algo está quebrado na API. Por favor aguarde ou entre em contato com o time de suporte.

ErrorResult

Representa um resultado de erro na chamada da plataforma.

Campo	Tipo	Regras	Descrição
errors	Lista de ErrorMessage	Opcional	Lista de erros da solicitação.

ErrorMessage

Contém informações de um erro.

Campo	Tipo	Regras	Descrição
code	string	Opcional	Código de identificação do erro.
message	string	Opcional	Descrição do erro.

Idioma

Undefined

Risk Object

Formulário de busca

Risk Object

Pré-requisitos

Listar dados do objeto de risco

Requisição (Request)

Respostas (Response)

Exemplo

Listar coberturas

Requisição (Request)

Respostas (Response)

Exemplo

Listar Motivos de Cancelamento

Requisição (Request)

Respostas (Response)

Exemplo

Listar atividades

Requisição (Request)

Respostas (Response)

Exemplo Empresarial

Exemplo Residencial

Listar serviços de assistência

Requisição (Request)

Respostas (Response)

Exemplo

Consultar tribunais e varas

Requisição (Request)

Respostas (Response)

Exemplo

Dicionário

RiskObjectDataResponse

RiskObjectDataManufacturerResponse

RiskObjectDataUtilizationResponse

RiskObjectDataEquipmentTypeResponse

CoverageListResponse

CoverageResponse

CoverageInsuredAmountResponse

CoverageInsuredAmountRangeResponse

AssistanceResponse

ActivityEmpresarial

ActivityResidencial

ProfessionalType

CourtSearchResponse

CourtRiskObject

CourtAddress

CancellationReasons

Resolução de erros

ErrorResult

ErrorMessage

Menu do rodapé