Consultar Solicitação por Documento

Obter consulta por UUID

get

Parâmetros de rota

uuidstringObrigatório

Respostas

200

Consulta encontrada

application/json

404

Consulta não encontrada

application/json

get

HTTPcURLJavaScriptPython

GET /api/scr/{uuid} HTTP/1.1
Host: api.staging.scr.gtbanker.com.br
Accept: */*

{
  "uuid": "text",
  "status": "PENDING",
  "webhookType": "SCR",
  "data": {
    "consentTerm": "text",
    "consultedAt": "2025-07-06",
    "createdAt": "2025-07-06",
    "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": "2025-07-06T00:23:45.601Z",
  "updatedAt": "2025-07-06T00:23:45.601Z"
}

Consultar solicitação por documento

get

Parâmetros de consulta

documentNumberstringObrigatório

Número do documento (CPF/CNPJ)

personTypestring · enumObrigatório

Tipo de pessoa

Valores possíveis:

Respostas

200

Consultas encontradas

application/json

404

Nenhuma consulta encontrada

application/json

get

HTTPcURLJavaScriptPython

GET /api/scr/document HTTP/1.1
Host: api.staging.scr.gtbanker.com.br
Accept: */*

[
  {
    "uuid": "text",
    "status": "PENDING",
    "webhookType": "SCR",
    "data": {
      "consentTerm": "text",
      "consultedAt": "2025-07-06",
      "createdAt": "2025-07-06",
      "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": "2025-07-06T00:23:45.601Z",
    "updatedAt": "2025-07-06T00:23:45.601Z"
  }
]

Central de Atendimento | Giro.TechGiro.Tech