AI - Intelligence

A API de Intelligence permite que os parceiros enviem documentos para a análise de IA.

Atualmente, apenas os seguintes produtos estão habilitados nesse fluxo:
Performance - Recursal - Trabalhista - Fiscal - Cível

Lista de produtos disponíveis para listar cobranças existentes para o parceiro.

• Garantia Performance
• Garantia Recursal
• Garantia Trabalhista
• Garantia Fiscal
• Garantia Cível

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.

Consultar documento submetido

Permite consultar um documento enviado para o serviço de IA pelo submittedDocumentId.

Requisição (Request)

Url	https://api-sandbox.pottencial.com.br/financial/v1/submitted-documents/{submittedDocumentId}
Method	Get
Path	submittedDocumentId	ID do documento submetido para análise de IA.
Query	includes	Informações para incluir na resposta. Valores permitidos: (ExternalSources)
Headers	client_id	Client ID da App.
	access_token	Token de acesso gerado para a App.

Respostas (Response)

Status	Descrição	Tipo
200	Retorna o documento submetido.	AIDocumentResponse
401	Parceiro não autorizado a realizar a operação.	ErrorResult
404	Recurso não encontrado.	ErrorResult
429	Muitas requisições – limite de 5 rpm.	ErrorResult
500	Erro interno da API. Por favor tente novamente mais tarde ou contate o suporte técnico da Pottencial.	ErrorResult

Upload e extração de documento

Permite enviar um arquivo para extração de dados pela IA.

Requisição (Request)

Url	https://api-sandbox.pottencial.com.br/financial/v1/documents/upload-and-extract
Method	Post
Headers	client_id	Client ID da App.
	access_token	Token de acesso gerado para a App.
Body	UploadDocumentRequest

Respostas (Response)

Status	Descrição	Tipo
200	Retorna o documento submetido após processamento.	AIDocumentResponse
400	Os dados da requisição estão inválidos.	ErrorResult
401	Parceiro não autorizado a realizar a operação.	ErrorResult
429	Muitas requisições – limite de 5 rpm.	ErrorResult
500	Erro interno da API. Por favor tente novamente mais tarde ou contate o suporte técnico da Pottencial.	ErrorResult

UploadDocumentRequest

Requisição para upload e extração de documento.

Campo	Tipo	Regras	Descrição
productKey	string	Obrigatório	Chave do produto para análise.
fileName	string	Obrigatório	Nome do arquivo enviado.
file	string (base64)	Obrigatório	Arquivo em base64.

Schemas

AIDocumentResponse

Resposta contendo os dados extraídos do documento pela IA.

Campo	Tipo	Regras	Descrição
submittedDocumentId	string	Obrigatório	Identificador do documento enviado na base de dados.
status	string	Obrigatório	Status do processamento do documento.
fines	object	Opcional	Multas existentes no contrato.
effectivePeriod	string (date-time)	Opcional	Modalidades do contrato.
deadLine	string (date-time)	Opcional	Prazo de execução do contrato.
contractValue	string	Opcional	Valor monetário ou custo do contrato.
updatedContractValue	string	Opcional	Valor monetário ou custo atualizado do contrato.
processNumber	string	Opcional	Número do processo.
policyHolders	object	Opcional	Titulares da apólice.
insureds	object	Opcional	Segurados.
objectiveContract	string	Opcional	Objetivo do contrato.
insuranceGuarantee	object	Opcional	Garantias do seguro.
contractorObligations	array (string)	Opcional	Obrigações do contratante.
socialSecurityLaborObligations	array (string)	Opcional	Obrigações trabalhistas e previdenciárias.
assignor	string	Opcional	Cedente do contrato.
assignee	string	Opcional	Cessionário do contrato.
consentingTriumph	string	Opcional	Consentimento de triunfo.
court	string	Opcional	Tribunal responsável.
product	array (string)	Opcional	Produtos associados.
uploadDate	string (date-time)	Obrigatório	Data de upload do documento.
user	string	Opcional	Usuário que fez o upload.
reasonError	string	Opcional	Motivo do erro, se houver.
type	string	Opcional	Tipo do documento.
productType	string	Opcional	Tipo de produto.
laborActionStepRecursal	string	Opcional	Fase da ação trabalhista recursal.
resourceTypeRecursal	string	Opcional	Tipo de recurso.
overallAverage	number	Obrigatório	Média geral de confiança do processamento.
confidences	object	Opcional	Níveis de confiança dos campos extraídos.
contractNumber	string	Opcional	Número do contrato.
noticeNumber	string	Opcional	Número do aviso.
cdaNumber	string	Opcional	Número da CDA (Certidão de Dívida Ativa).
caseFileNumber	string	Opcional	Número do processo.
administrativeProcessNumber	string	Opcional	Número do processo administrativo.
hasContractorObligations	string	Opcional	Indica se possui obrigações do contratante.
onlyProcessNumber	string	Opcional	Número único do processo.
policyHolderIHasBeenEdited	boolean	Opcional	Indica se o titular foi editado.
insuredHasBeenEdited	boolean	Opcional	Indica se o segurado foi editado.
taxCharged	string	Opcional	Tributo cobrado.
deadlineDays	string	Opcional	Dias de prazo.
nameActionProposal	string	Opcional	Nome da proposta de ação.
startDatePeriodOfValidity	string (date-time)	Opcional	Data de início do período de validade.
endDatePeriodOfValidity	string (date-time)	Opcional	Data de fim do período de validade.
sources	object	Opcional	Fontes das imagens extraídas do documento.

Exemplos

Resposta condição de pagamento

{
  "submittedDocumentId": "string",
  "status": "Submitted",
  "fines": [
    {
      "contractId": "string",
      "value": "string",
      "condition": "string",
      "additionalInformation": [
        "string"
      ]
    }
  ],
  "effectivePeriod": [
    "string"
  ],
  "deadLine": [
    "string"
  ],
  "contractValue": "string",
  "updatedContractValue": "string",
  "processNumber": "string",
  "policyHolders": [
    {
      "name": "string",
      "document": "string",
      "createdAt": "2025-12-19T20:57:22.567Z",
      "updatedAt": "2025-12-19T20:57:22.567Z",
      "address": {
        "street": "string",
        "number": "string",
        "district": "string",
        "zipCode": "string",
        "cityName": "string",
        "stateCode": "string",
        "complement": "string"
      }
    }
  ],
  "insureds": [
    {
      "name": "string",
      "document": "string",
      "createdAt": "2025-12-19T20:57:22.567Z",
      "updatedAt": "2025-12-19T20:57:22.567Z",
      "address": {
        "street": "string",
        "number": "string",
        "district": "string",
        "zipCode": "string",
        "cityName": "string",
        "stateCode": "string",
        "complement": "string"
      }
    }
  ],
  "objectiveContract": "string",
  "insuranceGuarantee": [
    {
      "contractId": "string",
      "descriptionType": "string",
      "insuredAmount": "string",
      "additionalInformation": [
        "string"
      ],
      "descriptionModality": [
        "string"
      ]
    }
  ],
  "contractorObligations": [
    "string"
  ],
  "socialSecurityLaborObligations": [
    "string"
  ],
  "assignor": "string",
  "assignee": "string",
  "consentingTriumph": "string",
  "court": "string",
  "product": [
    "string"
  ],
  "uploadDate": "2025-12-19T20:57:22.567Z",
  "user": "string",
  "reasonError": "string",
  "type": "Contract",
  "productType": "Performance",
  "laborActionStepRecursal": "string",
  "resourceTypeRecursal": "string",
  "overallAverage": 0,
  "confidences": {
    "effectivePeriod": 0,
    "objectiveContract": 0,
    "contractValue": 0,
    "processNumber": 0,
    "court": 0,
    "insureds": [
      {
        "contractInsuredId": "string",
        "name": 0,
        "document": 0,
        "address": {
          "street": 0,
          "number": 0,
          "district": 0,
          "zipCode": 0,
          "cityName": 0,
          "stateCode": 0,
          "complement": 0
        }
      }
    ],
    "policyHolders": [
      {
        "contractPolicyHolderId": "string",
        "name": 0,
        "document": 0,
        "address": {
          "street": 0,
          "number": 0,
          "district": 0,
          "zipCode": 0,
          "cityName": 0,
          "stateCode": 0,
          "complement": 0
        }
      }
    ],
    "descriptionType": 0,
    "insuredAmount": 0,
    "descriptionModality": 0,
    "additionalInformation": 0,
    "contractorObligations": 0,
    "socialSecurityLaborObligations": 0,
    "contractNumber": 0,
    "noticeNumber": 0,
    "cdaNumber": 0,
    "caseFileNumber": 0,
    "administrativeProcessNumber": 0,
    "hasContractorObligations": 0,
    "onlyProcessNumber": 0,
    "laborActionStepRecursal": 0,
    "resourceTypeRecursal": 0,
    "taxCharged": 0,
    "deadlineDays": 0,
    "nameActionProposal": 0,
    "startDatePeriodOfValidity": 0,
    "endDatePeriodOfValidity": 0
  },
  "contractNumber": "string",
  "noticeNumber": "string",
  "cdaNumber": "string",
  "caseFileNumber": "string",
  "administrativeProcessNumber": "string",
  "hasContractorObligations": "string",
  "onlyProcessNumber": "string",
  "policyHolderHasBeenEdited": true,
  "insuredHasBeenEdited": true,
  "taxCharged": "string",
  "deadlineDays": "string",
  "nameActionProposal": "string",
  "startDatePeriodOfValidity": "2025-12-19T20:57:22.567Z",
  "endDatePeriodOfValidity": "2025-12-19T20:57:22.567Z",
  "sources": {
    "guaranteeObject": {
      "imageText": "string",
      "imageUrl": "string"
    },
    "contractObject": {
      "imageText": "string",
      "imageUrl": "string"
    },
    "objectiveContract": {
      "imageText": "string",
      "imageUrl": "string"
    },
    "effectivePeriod": {
      "imageText": "string",
      "imageUrl": "string"
    },
    "processNumber": {
      "imageText": "string",
      "imageUrl": "string"
    },
    "descriptionModality": {
      "imageText": "string",
      "imageUrl": "string"
    },
    "contractValue": {
      "imageText": "string",
      "imageUrl": "string"
    },
    "updatedContractValue": {
      "imageText": "string",
      "imageUrl": "string"
    },
    "insuranceGuarantee": {
      "imageText": "string",
      "imageUrl": "string"
    },
    "fines": {
      "imageText": "string",
      "imageUrl": "string"
    },
    "contractModality": {
      "imageText": "string",
      "imageUrl": "string"
    },
    "onlyProcessNumber": {
      "imageText": "string",
      "imageUrl": "string"
    },
    "contractNumber": {
      "imageText": "string",
      "imageUrl": "string"
    },
    "noticeNumber": {
      "imageText": "string",
      "imageUrl": "string"
    },
    "cdaNumber": {
      "imageText": "string",
      "imageUrl": "string"
    },
    "caseFileNumber": {
      "imageText": "string",
      "imageUrl": "string"
    },
    "administrativeProcessNumber": {
      "imageText": "string",
      "imageUrl": "string"
    },
    "hasContractorObligations": {
      "imageText": "string",
      "imageUrl": "string"
    },
    "policyHolderAddressZipCode": {
      "imageText": "string",
      "imageUrl": "string"
    },
    "policyHolderAddressStreet": {
      "imageText": "string",
      "imageUrl": "string"
    },
    "policyHolderAddressCityName": {
      "imageText": "string",
      "imageUrl": "string"
    },
    "policyHolderAddressStateCode": {
      "imageText": "string",
      "imageUrl": "string"
    },
    "policyHolderAddressDistrict": {
      "imageText": "string",
      "imageUrl": "string"
    },
    "policyHolderAddressNumber": {
      "imageText": "string",
      "imageUrl": "string"
    },
    "policyHolderAddressComplement": {
      "imageText": "string",
      "imageUrl": "string"
    },
    "insuredAddressZipCode": {
      "imageText": "string",
      "imageUrl": "string"
    },
    "insuredAddressStreet": {
      "imageText": "string",
      "imageUrl": "string"
    },
    "insuredAddressCityName": {
      "imageText": "string",
      "imageUrl": "string"
    },
    "insuredAddressStateCode": {
      "imageText": "string",
      "imageUrl": "string"
    },
    "insuredAddressDistrict": {
      "imageText": "string",
      "imageUrl": "string"
    },
    "insuredAddressNumber": {
      "imageText": "string",
      "imageUrl": "string"
    },
    "insuredAddressComplement": {
      "imageText": "string",
      "imageUrl": "string"
    },
    "laborActionStepRecursal": {
      "imageText": "string",
      "imageUrl": "string"
    },
    "resourceTypeRecursal": {
      "imageText": "string",
      "imageUrl": "string"
    },
    "policyHolderName": {
      "imageText": "string",
      "imageUrl": "string"
    },
    "policyHolderDocument": {
      "imageText": "string",
      "imageUrl": "string"
    },
    "insuredName": {
      "imageText": "string",
      "imageUrl": "string"
    },
    "insuredDocument": {
      "imageText": "string",
      "imageUrl": "string"
    },
    "court": {
      "imageText": "string",
      "imageUrl": "string"
    },
    "socialSecurityLaborObligations": {
      "imageText": "string",
      "imageUrl": "string"
    },
    "contractorObligations": {
      "imageText": "string",
      "imageUrl": "string"
    },
    "taxCharged": {
      "imageText": "string",
      "imageUrl": "string"
    },
    "deadlineDays": {
      "imageText": "string",
      "imageUrl": "string"
    },
    "nameActionProposal": {
      "imageText": "string",
      "imageUrl": "string"
    },
    "startDatePeriodOfValidity": {
      "imageText": "string",
      "imageUrl": "string"
    },
    "endDatePeriodOfValidity": {
      "imageText": "string",
      "imageUrl": "string"
    }
  }
}

Estrutura da mensagem de erro

ErrorResult

Representa um resultado de erro na chamada da plataforma.

Campo	Tipo	Regras	Descrição
errors	array 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.