Criar Consulta

Criar nova solicitação de consulta SCR

post

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

/scr

Inicia o processo de consulta ao SCR. Dependendo da configuração needsToSign, este endpoint pode iniciar um fluxo de assinatura digital (via e-mail/token) antes de efetivamente consultar o Bacen. A resposta retorna um UUID que deve ser usado para acompanhar o status ou configurar o webhook.

Autorizações

bearerAuth

Corpo

application/json

namestringObrigatório

Nome da pessoa física ou Razão Social da empresa.

Example: João da Silva

personTypestring · enumObrigatório

Tipo de pessoa.

Example: Pessoa_FisicaValores possíveis:

documentNumberstringObrigatório

CPF (11 dígitos) ou CNPJ (14 dígitos) apenas números.

Example: 12345678901

startDatestringObrigatório

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

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

endDatestringObrigatório

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

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

checkRepresentativesbooleanOpcional

Se verdadeiro, é obrigatorio fazer o envio do contrato social.

Default: false

needsToSignbooleanOpcional

Define se é necessário coletar assinatura. Se false, a API assume que a organização já possui o consentimento e fará a consulta direta (Requer permissão especial).

Default: true

Respostas

201

Solicitação criada com sucesso. O processo continuará de forma assíncrona.

application/json

400

Dados inválidos (ex formato de data incorreto, documento inválido).

application/json

401

Não autorizado (Token ausente ou inválido).

403

Proibido (Usuário não possui a role ORGANIZATION).

post

/scr

HTTPcURLJavaScriptPython

POST /api/scr HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 573

{
  "name": "João da Silva",
  "personType": "Pessoa_Fisica",
  "documentNumber": "12345678901",
  "startDate": "2023-01",
  "endDate": "2023-06",
  "signers": [
    {
      "name": "text",
      "email": "[email protected]",
      "documentNumber": "text",
      "signatureType": "PART"
    }
  ],
  "checkRepresentatives": false,
  "needsToSign": true,
  "socialContract": {
    "file": "binary",
    "name": "text",
    "mimeType": "text"
  },
  "powersOfAttorney": [
    {
      "file": "binary",
      "name": "text",
      "mimeType": "text"
    }
  ],
  "documentSign": {
    "file": "binary",
    "name": "text",
    "externalIdentification": "text",
    "notificationType": "NOTIFY",
    "deadline": "2026-02-04"
  },
  "signatureMethods": [
    "TOKEN"
  ]
}

{
  "uuid": "text"
}

Central de Atendimento | Giro.TechGiro.Tech