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 tipos de equipamentos

Permite listar tipos de equipamentos do produto Riscos Diversos.

O endpoint recebe o product_key como parâmetro. Caso esse parâmetro esteja vazio, por padrão será retornado equipamentos para o produto maquinas-equipamentos.

Requisição (Request)

Url	https://api-sandbox.pottencial.com.br/riskobject/v1/equipmentstype
Method	Get
Query	product_key	Máquinas e Equipamentos maquinas-equipamentos Benfeitorias benfeitorias Penhor Rural penhor-rural	Padrão: maquinas-equipamentos
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.	equipments
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": 1,
    "nome": "RETROESCAVADEIRA",
    "categoria": "Movel",
    "codigoCategoria": "5",
    "autopropelido": "true"
  },
  {
    "id": 2,
    "nome": "MINIESCAVADEIRA",
    "categoria": "Movel",
    "codigoCategoria": "5",
    "autopropelido": "true"
  },
  {
    "id": 3,
    "nome": "CONTADOR DE LÍQUIDO",
    "categoria": "Estacionario",
    "codigoCategoria": "6",
    "autopropelido": "false"
  }
]

Listar atividades

Permite Listar as atividades dos produtos da Pottencial.

Permite Lista tipos de equipamentos produto Riscos Empresariais.

Requisição (Request)

Url	https://api-sandbox.pottencial.com.br/riskobject/v1/{product_key}/activities
Method	Get
Query	product_key	Residencial residencial Riscos Empresariais empresarial Vida 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.	activities
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

Exemplos lista de atividades

Exemplo de atividades do Empresarial

Resposta da lista de atividades

[
  {
    "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"
  },
  {
    "id": "111ccccccddd-2222-1111-aaaa-bbbbbb0002",
    "activityName": "Café – Cafeteria",
    "groupName": "Serviço",
    "enabled": "true",
    "susepRiskActivityType": "Business",
    "susepRiskActivityClassType": "Services"
  }
]

Exemplo de atividades do Residencial

Resposta da lista de atividades Residenciais

[
  {
    "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  "
  }
]

Serviço de Assistencia

Permite Obter serviços de assistências dos produtos da Pottencial.

Permite Obter serviços de assistências 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	Residencial residencial Riscos Empresariais empresarial Vida 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.	assistencias
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

Exemplos Serviço de Assistencia

[
  {
    "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"
  }
]

Obter tribunais e Vara

lista de tribunais cadastrados na Pottencial.

Permite Obter lista de 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 Civel
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 localizado a Vara.
Query	courtState	Sigla do Estado localizado a Vara.
Query	courtZipCode	CEP da localização da Vara.

Respostas (Response)

Status	Descrição	Tipo
200	de tribunais cadastrados na Pottencial	courtSearch
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"
      }
    }
  ]
}

Dicionario

Equipment

Contém informações do equipamento

Campo	Tipo	Regras	Descrição
id	number	Opcional	Identificador do tipo de equipamento.
nome	string	Opcional	Nome do tipo de equipemento
categoria	string	Opcional	Categoria do equipemento
codigoCategoria	string	Opcional	codigo da Categoria do equipemento
autopropelido	boolean	Opcional	Equipamentos que possuem motores de propulsão (se locomovem)

Assistencia

Assistencia

Contém informações da assistencia service

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

ActivitieEmpresarial

ActivitieEmpresarial

Contém informações das atividades do produto Riscos Empresariais.

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	atividade valida
susepRiskActivityType	string	Opcional	Tipo de atividade Susep
susepRiskActivityClassType	string	Opcional	classe de atividade Sussep

ActivitieResidencial

ActivitieResidencial

Contém informações das atividades do produto Residencial.

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. MEI ou LIBERAL

ProfessionalType

Lista os possíveis tipo de profissional. MEI ou LIBERAL

• IndividualMicroentrepreneur: Micro empreendedor individual MEI
• LiberalProfessional : Profissional Liberal.

courtSearch

Contém informações do Tribunais e Vara.

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

CourtRiskObject

Contém informações da Vara

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

address

Representa uma localidade com endereço.

Campo	Tipo	Regras	Descrição
city	string	Obrigatório	Nome da cidade da localidade, conforme cadastrado nos Correios.
statename	string	Opcional	Sigla do estado da localidade
zipCode	string	Obrigatório	CEP da localidade. Devem ser informados somente os dígitos.