Pesquisar histórico de consultas por Documento e Data

Pesquisar histórico de consultas por Documento e Data

get

https://api.staging.scr.gtbanker.com.br/apihttps://api.scr.gtbanker.com.br/api

/scr

Lista as consultas realizadas para um determinado documento dentro de um período específico.

Autorizações

bearerAuth

Parâmetros de consulta

documentNumberstringObrigatório

Número do documento (CPF ou CNPJ sem formatação).

startDatestringObrigatório

Mês inicial da pesquisa (Formato YYYY-MM).

Example: 2023-01Pattern: ^\d{4}-(0[1-9]|1[0-2])$

endDatestringObrigatório

Mês final da pesquisa (Formato YYYY-MM).

Example: 2023-06Pattern: ^\d{4}-(0[1-9]|1[0-2])$

generatePdfbooleanOpcional

Define se o binário do PDF deve ser retornado na resposta (Default = true).

Default: true

Respostas

200

Lista de consultas encontradas.

application/json

Resposta de uma consulta ao SCR

uuidstringObrigatório

Identificador único da consulta

statusstring · enumObrigatório

Status atual da consulta

Valores possíveis:

webhookTypestring · enumObrigatório

Tipo de webhook que gerou a resposta

Valores possíveis:

pdfstring · binaryOpcional

Documento PDF com o resultado da consulta

createdAtstring · date-timeObrigatório

Data e hora de criação da consulta

updatedAtstring · date-timeObrigatório

Data e hora da última atualização da consulta

400

Parâmetros inválidos (ex datas fora do padrão).

404

Nenhuma consulta encontrada.

application/json

get

/scr

HTTPcURLJavaScriptPython

GET /api/scr?documentNumber=text&startDate=2023-01&endDate=2023-06 HTTP/1.1
Accept: */*

[
  {
    "uuid": "text",
    "status": "PENDING",
    "webhookType": "SCR",
    "data": {
      "consentTerm": "text",
      "consultedAt": "2026-04-03",
      "createdAt": "2026-04-03",
      "originUuid": "text",
      "reportEndDate": "text",
      "reportStartDate": "text",
      "resultDocument": "text",
      "scrKey": "text",
      "scrStatus": "text",
      "subjectDocumentNumber": "text",
      "subjectName": "text",
      "subjectPersonType": "text",
      "scrData": [
        {
          "referenceDate": "text",
          "financialInstitutionCount": "text",
          "operationCount": "text",
          "assumedCoobligation": "text",
          "receiveCoobligation": "text",
          "startRelationship": "text",
          "disagreementOperationCount": "text",
          "disagreementOperationValue": "text",
          "subjudiceOperationsCount": "text",
          "subjudiceOperationsValue": "text",
          "indirectRisk": "text",
          "error": [
            {
              "errorCode": "text",
              "description": "text"
            }
          ],
          "operationItems": [
            {
              "dueValue": "text",
              "exchangeVariation": "text",
              "categorySub": {
                "category": {
                  "category_code": 1,
                  "category_description": "text"
                },
                "categorySubCode": 1,
                "description": "text"
              },
              "dueType": {
                "code": "text",
                "description": "text"
              }
            }
          ]
        }
      ],
      "signers": [
        {
          "uuid": "text",
          "name": "text",
          "email": "[email protected]",
          "documentNumber": "text",
          "signatureType": "PART",
          "status": "PENDING"
        }
      ]
    },
    "pdf": "binary",
    "createdAt": "2026-04-03T20:08:29.505Z",
    "updatedAt": "2026-04-03T20:08:29.505Z"
  }
]

Central de Atendimento | Giro.TechGiro.Tech