> For the complete documentation index, see [llms.txt](https://docs.giro.tech/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.giro.tech/desenvolvedores/api-gtscr/webhooks/chamada-do-webhook.md).

# Chamada do Webhook

## Estrutura do Payload de Callback (Exemplo)

> Este endpoint não existe na API. Ele serve apenas para documentar o formato do JSON que a API enviará para a \`payloadUrl\` configurada pelo cliente quando uma consulta for concluída.<br>

```json
{"openapi":"3.0.0","info":{"title":"API de Consultas GTSCR","version":"1.0.0"},"servers":[{"url":"https://api.staging.scr.gtbanker.com.br/api","description":"Servidor de Homologação"},{"url":"https://api.scr.gtbanker.com.br/api","description":"Servidor de Produção"}],"paths":{"/webhook-callback-example":{"post":{"tags":["Exemplo de Callback"],"summary":"Estrutura do Payload de Callback (Exemplo)","description":"Este endpoint não existe na API. Ele serve apenas para documentar o formato do JSON que a API enviará para a `payloadUrl` configurada pelo cliente quando uma consulta for concluída.\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","description":"Resposta de uma consulta ao SCR","properties":{"uuid":{"type":"string","description":"Identificador único da consulta"},"status":{"type":"string","enum":["PENDING","PROCESSING","COMPLETED","ERROR","EXPIRED","CANCELED"],"description":"Status atual da consulta"},"webhookType":{"type":"string","enum":["SCR","DOCUMENT_EXPIRED","DOCUMENT_SIGNED"],"description":"Tipo de webhook que gerou a resposta"},"data":{"description":"Dados da consulta ao SCR","type":"object","properties":{"consentTerm":{"type":"string","description":"Termo de consentimento fornecido pelo cliente para consulta ao SCR"},"consultedAt":{"type":"string","format":"date","description":"Data em que a consulta ao SCR foi realizada"},"createdAt":{"type":"string","format":"date","description":"Data de criação do registro da consulta"},"originUuid":{"type":"string","description":"Identificador único universal da origem da consulta"},"reportEndDate":{"type":"string","description":"Data final do período consultado no SCR"},"reportStartDate":{"type":"string","description":"Data inicial do período consultado no SCR"},"resultDocument":{"type":"string","description":"Documento resultante da consulta ao SCR"},"scrKey":{"type":"string","description":"Chave única de identificação da consulta no SCR"},"scrStatus":{"type":"string","description":"Status atual da consulta no SCR"},"subjectDocumentNumber":{"type":"string","description":"Número do documento (CPF/CNPJ) do cliente consultado"},"subjectName":{"type":"string","description":"Nome ou razão social do cliente consultado"},"subjectPersonType":{"type":"string","description":"Tipo de pessoa do cliente (Pessoa_Fisica ou Pessoa_Juridica)"},"scrData":{"type":"array","description":"Lista dos dados obtidos do SCR para cada período consultado","items":{"type":"object","description":"Dados consolidados de uma consulta ao SCR (Sistema de Informações de Crédito) do Banco Central","properties":{"referenceDate":{"type":"string","description":"Data base de referência das informações consultadas no SCR"},"financialInstitutionCount":{"type":"string","description":"Quantidade total de instituições financeiras que enviaram informações do cliente ao SCR"},"operationCount":{"type":"string","description":"Quantidade total de operações do cliente reportadas ao SCR"},"assumedCoobligation":{"type":"string","description":"Valor total das coobrigações assumidas pelo cliente como avalista, fiador ou coobrigado em operações de crédito"},"receiveCoobligation":{"type":"string","description":"Valor total das operações de crédito do cliente que possuem coobrigados (avalistas ou fiadores)"},"startRelationship":{"type":"string","description":"Data mais antiga de início de relacionamento do cliente com instituições financeiras reportado ao SCR"},"disagreementOperationCount":{"type":"string","description":"Quantidade de operações que o cliente registrou manifestação de discordância junto ao Banco Central"},"disagreementOperationValue":{"type":"string","description":"Valor total das operações com manifestação de discordância registrada pelo cliente"},"subjudiceOperationsCount":{"type":"string","description":"Quantidade de operações com decisão judicial que impacta seu registro no SCR"},"subjudiceOperationsValue":{"type":"string","description":"Valor total das operações com decisão judicial que impacta seu registro no SCR"},"indirectRisk":{"type":"string","description":"Valor total de operações onde o cliente consta como coobrigado (avalista, fiador) - risco indireto assumido"},"error":{"type":"array","description":"Lista de erros identificados durante a consulta ao SCR","items":{"type":"object","description":"Representa um erro ocorrido durante a consulta","properties":{"errorCode":{"type":"string","description":"Código do erro"},"description":{"type":"string","description":"Descrição detalhada do erro"}}}},"operationItems":{"type":"array","description":"Lista detalhada das operações de crédito reportadas ao SCR","items":{"type":"object","description":"Representa uma operação de crédito registrada no SCR do Banco Central","properties":{"dueValue":{"type":"string","description":"Valor a vencer da operação de crédito, conforme registrado no SCR"},"exchangeVariation":{"type":"string","description":"Valor da variação cambial da operação, quando aplicável em operações em moeda estrangeira"},"categorySub":{"description":"Classificação e subclassificação da modalidade da operação de crédito conforme tabela do BACEN","type":"object","properties":{"category":{"description":"Modalidade principal da operação conforme tabela do BACEN","type":"object","properties":{"category_code":{"type":"integer","description":"Código da modalidade conforme tabela de domínio do BACEN"},"category_description":{"type":"string","description":"Descrição da modalidade de crédito conforme definido pelo BACEN"}}},"categorySubCode":{"type":"integer","description":"Código da submodalidade da operação conforme tabela do BACEN"},"description":{"type":"string","description":"Descrição da submodalidade da operação de crédito"}}},"dueType":{"description":"Tipo e característica do vencimento da operação conforme classificação do SCR","type":"object","properties":{"code":{"type":"string","description":"Código do tipo de vencimento"},"description":{"type":"string","description":"Descrição do tipo de vencimento"}}}}}}}}},"signers":{"type":"array","description":"Lista dos responsáveis pela assinatura/autorização da consulta ao SCR","items":{"type":"object","properties":{"uuid":{"type":"string","description":"Identificador único do signatário"},"name":{"type":"string","description":"Nome do signatário"},"email":{"type":"string","format":"email","description":"Email do signatário"},"documentNumber":{"type":"string","description":"CPF/CNPJ do signatário"},"signatureType":{"type":"string","enum":["PART","WITNESS","CONTRACTOR","HIRED","ADMINISTRATOR","LEGAL_REPRESENTATIVE"],"description":"Tipo de assinatura"},"status":{"type":"string","enum":["PENDING","SIGNED","EXPIRED","CANCELED"],"description":"Status da assinatura"}},"required":["uuid","name","email","documentNumber","signatureType","status"]}}}},"pdf":{"type":"string","format":"binary","description":"Documento PDF com o resultado da consulta"},"createdAt":{"type":"string","format":"date-time","description":"Data e hora de criação da consulta"},"updatedAt":{"type":"string","format":"date-time","description":"Data e hora da última atualização da consulta"}},"required":["uuid","status","webhookType","data","createdAt","updatedAt"]}}}},"responses":{"200":{"description":"O cliente deve retornar 200 OK para confirmar o recebimento."}}}}}}
```

<figure><img src="https://978140111-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FF6l1W0qI0y7eF7f0QRDC%2Fuploads%2Fgit-blob-f5d2064d02c970341ca52b2c083eb1f585bc436a%2Fimage.png?alt=media" alt=""><figcaption></figcaption></figure>

{% embed url="<https://giro.tech/central-de-atendimento/>" %}
