Criar Consulta

Criar nova consulta SCR

post

Body

namestringRequired

Nome da pessoa

personTypestring · enumRequired

Tipo de pessoa (Pessoa_Fisica ou Pessoa_Juridica)

Possible values:

documentNumberstringRequired

Número do documento

startDatestring · dateRequired

Data de início no formato YYYY-MM

endDatestring · dateRequired

Data de término no formato YYYY-MM

checkRepresentativesbooleanOptionalDefault: false

needsToSignbooleanOptionalDefault: true

Responses

201

Consulta criada com sucesso

application/json

400

Dados inválidos

application/json

post

HTTPcURLJavaScriptPython

POST /api/consultations HTTP/1.1
Host: api.staging.scr.gtbanker.com.br
Content-Type: application/json
Accept: */*
Content-Length: 562

{
  "name": "text",
  "personType": "Pessoa_Fisica",
  "documentNumber": "text",
  "startDate": "2025-05-16",
  "endDate": "2025-05-16",
  "signers": [
    {
      "name": "text",
      "email": "[e-mail]",
      "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": "2025-05-16"
  },
  "signatureMethods": [
    "TOKEN"
  ]
}

{
  "uuid": "text"
}