curl --request GET 'https://gyra-core.gyramais.com.br/v1/registry/6612a7f30000000000000001/documents' \
--header 'Authorization: Bearer <token>'const resposta = await fetch("https://gyra-core.gyramais.com.br/v1/registry/6612a7f30000000000000001/documents", {
method: "GET",
headers: { Authorization: `Bearer ${token}` },
});
const dados = await resposta.json();
import requests
resposta = requests.get(
"https://gyra-core.gyramais.com.br/v1/registry/6612a7f30000000000000001/documents",
headers={"Authorization": f"Bearer {token}"},
)
dados = resposta.json()
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://gyra-core.gyramais.com.br/v1/registry/{id}/documents",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://gyra-core.gyramais.com.br/v1/registry/{id}/documents"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://gyra-core.gyramais.com.br/v1/registry/{id}/documents")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://gyra-core.gyramais.com.br/v1/registry/{id}/documents")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"documents": [
{
"id": "6612a7f30000000000000031",
"registryId": "6612a7f30000000000000001",
"personId": null,
"type": "CONTRATO_SOCIAL",
"expectedType": "CONTRATO_SOCIAL",
"status": "VALIDATED",
"version": 2,
"isCurrent": true,
"supersedesId": "6612a7f30000000000000030",
"fileUrl": "https://<bucket>.s3.amazonaws.com/presigned/contrato-social-3f6c2a9e-8b1d-4c7a-9e2f-5a1b7c3d9e40.pdf",
"fileName": "contrato-social.pdf",
"mimeType": "application/pdf",
"sizeBytes": 1843200,
"pageCount": 12,
"parentDocumentId": null,
"classification": {
"type": "CONTRATO_SOCIAL",
"confidence": 0.94
},
"yearReference": null,
"attempt": 1,
"lastError": null,
"statusReason": null,
"verdict": "VALIDO",
"createdAt": "2026-09-05T13:02:11.000Z",
"updatedAt": "2026-09-05T13:07:44.000Z"
}
]
}{
"code": 400,
"message": "O identificador informado em \"id\" não é válido."
}{
"code": 401,
"message": "Token de acesso inválido."
}{
"code": 403,
"message": "Você não tem permissão para acessar este recurso."
}{
"code": 404,
"message": "Cadastro não encontrado."
}{
"code": 500,
"message": "Internal server error"
}Listar Documentos do Cadastro
Para saber o que o dossiê já tem antes de pedir de novo.
curl --request GET 'https://gyra-core.gyramais.com.br/v1/registry/6612a7f30000000000000001/documents' \
--header 'Authorization: Bearer <token>'const resposta = await fetch("https://gyra-core.gyramais.com.br/v1/registry/6612a7f30000000000000001/documents", {
method: "GET",
headers: { Authorization: `Bearer ${token}` },
});
const dados = await resposta.json();
import requests
resposta = requests.get(
"https://gyra-core.gyramais.com.br/v1/registry/6612a7f30000000000000001/documents",
headers={"Authorization": f"Bearer {token}"},
)
dados = resposta.json()
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://gyra-core.gyramais.com.br/v1/registry/{id}/documents",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://gyra-core.gyramais.com.br/v1/registry/{id}/documents"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://gyra-core.gyramais.com.br/v1/registry/{id}/documents")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://gyra-core.gyramais.com.br/v1/registry/{id}/documents")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"documents": [
{
"id": "6612a7f30000000000000031",
"registryId": "6612a7f30000000000000001",
"personId": null,
"type": "CONTRATO_SOCIAL",
"expectedType": "CONTRATO_SOCIAL",
"status": "VALIDATED",
"version": 2,
"isCurrent": true,
"supersedesId": "6612a7f30000000000000030",
"fileUrl": "https://<bucket>.s3.amazonaws.com/presigned/contrato-social-3f6c2a9e-8b1d-4c7a-9e2f-5a1b7c3d9e40.pdf",
"fileName": "contrato-social.pdf",
"mimeType": "application/pdf",
"sizeBytes": 1843200,
"pageCount": 12,
"parentDocumentId": null,
"classification": {
"type": "CONTRATO_SOCIAL",
"confidence": 0.94
},
"yearReference": null,
"attempt": 1,
"lastError": null,
"statusReason": null,
"verdict": "VALIDO",
"createdAt": "2026-09-05T13:02:11.000Z",
"updatedAt": "2026-09-05T13:07:44.000Z"
}
]
}{
"code": 400,
"message": "O identificador informado em \"id\" não é válido."
}{
"code": 401,
"message": "Token de acesso inválido."
}{
"code": 403,
"message": "Você não tem permissão para acessar este recurso."
}{
"code": 404,
"message": "Cadastro não encontrado."
}{
"code": 500,
"message": "Internal server error"
}Quando usar
Para saber o que o dossiê já tem antes de pedir de novo.O que some por padrão
Nada é sobrescrito: a alteração contratual nova não apaga a antiga, vira a versão vigente. Por padrão some só a versão aprovada que já foi substituída por uma vigente do mesmo tipo. Documento reprovado, inconclusivo ou ainda em análise aparece sempre. ComincludeHistory, vem tudo; com type, só um tipo.
A lista vem em documents, e cada documento traz verdict: o veredito que vale hoje, já com a decisão do operador quando houver.
Authorizations
Enter JWT token
Path Parameters
Id do cadastro.
Query Parameters
So os documentos deste tipo.
CONTRATO_SOCIAL, ALTERACAO_CONTRATUAL, ESTATUTO_SOCIAL, REQUERIMENTO_EMPRESARIO, PROCURACAO_PJ, IRPJ_ECF, DECLARACAO_FATURAMENTO, CERTIDAO_JUNTA, ATA_ASSEMBLEIA, DOC_IDENTIDADE, COMPROVANTE_RESIDENCIA, DIRPF, COMPROVANTE_RENDA, CERTIDAO_PF, PROCURACAO_PF, FORA_DE_ESCOPO, NAO_IDENTIFICADO, CERTIDAO_PGFN_PJ, CERTIDAO_FGTS, CADIN_FEDERAL, CADIN_ESTADUAL, CERTIDAO_QSA, CERTIFICADO_SIMPLES_NACIONAL, ESOCIAL_PJ, COMPROVACAO_ESTADO_CIVIL, DEMONSTRACOES_FINANCEIRAS, EXTRATO_BANCARIO true traz tambem as versoes aprovadas que ja foram substituidas por uma mais nova do mesmo tipo.
Response
Documentos com tipo, versao, status, veredito e data, dentro de documents.
Hide child attributes
Hide child attributes
Pessoa da arvore societaria a que o documento foi anexado.
CONTRATO_SOCIAL, ALTERACAO_CONTRATUAL, ESTATUTO_SOCIAL, REQUERIMENTO_EMPRESARIO, ATA_ASSEMBLEIA, PROCURACAO_PJ, CERTIDAO_JUNTA, CERTIDAO_QSA, IRPJ_ECF, DECLARACAO_FATURAMENTO, CERTIFICADO_SIMPLES_NACIONAL, DEMONSTRACOES_FINANCEIRAS, EXTRATO_BANCARIO, CERTIDAO_PGFN_PJ, CERTIDAO_FGTS, CADIN_FEDERAL, CADIN_ESTADUAL, ESOCIAL_PJ, DOC_IDENTIDADE, COMPROVANTE_RESIDENCIA, DIRPF, COMPROVANTE_RENDA, CERTIDAO_PF, PROCURACAO_PF, COMPROVACAO_ESTADO_CIVIL, FORA_DE_ESCOPO, NAO_IDENTIFICADO RECEIVED, CLASSIFYING, CLASSIFIED, EXTRACTING, EXTRACTED, VALIDATING, VALIDATED, FAILED, MANUAL_REVIEW, OUT_OF_SCOPE, REJECTED_QUALITY Versao dentro do tipo. Nada e sobrescrito.
true na versao vigente daquele tipo.
URL assinada, com validade.
Preenchido quando o arquivo trazia varias pecas e foi dividido.
O que a classificacao concluiu, com as alternativas consideradas.
Hide child attributes
Hide child attributes
CONTRATO_SOCIAL, ALTERACAO_CONTRATUAL, ESTATUTO_SOCIAL, REQUERIMENTO_EMPRESARIO, ATA_ASSEMBLEIA, PROCURACAO_PJ, CERTIDAO_JUNTA, CERTIDAO_QSA, IRPJ_ECF, DECLARACAO_FATURAMENTO, CERTIFICADO_SIMPLES_NACIONAL, DEMONSTRACOES_FINANCEIRAS, EXTRATO_BANCARIO, CERTIDAO_PGFN_PJ, CERTIDAO_FGTS, CADIN_FEDERAL, CADIN_ESTADUAL, ESOCIAL_PJ, DOC_IDENTIDADE, COMPROVANTE_RESIDENCIA, DIRPF, COMPROVANTE_RENDA, CERTIDAO_PF, PROCURACAO_PF, COMPROVACAO_ESTADO_CIVIL, FORA_DE_ESCOPO, NAO_IDENTIFICADO 0 a 1.
Hide child attributes
Hide child attributes
CONTRATO_SOCIAL, ALTERACAO_CONTRATUAL, ESTATUTO_SOCIAL, REQUERIMENTO_EMPRESARIO, ATA_ASSEMBLEIA, PROCURACAO_PJ, CERTIDAO_JUNTA, CERTIDAO_QSA, IRPJ_ECF, DECLARACAO_FATURAMENTO, CERTIFICADO_SIMPLES_NACIONAL, DEMONSTRACOES_FINANCEIRAS, EXTRATO_BANCARIO, CERTIDAO_PGFN_PJ, CERTIDAO_FGTS, CADIN_FEDERAL, CADIN_ESTADUAL, ESOCIAL_PJ, DOC_IDENTIDADE, COMPROVANTE_RESIDENCIA, DIRPF, COMPROVANTE_RENDA, CERTIDAO_PF, PROCURACAO_PF, COMPROVACAO_ESTADO_CIVIL, FORA_DE_ESCOPO, NAO_IDENTIFICADO Ano-calendario, nos tipos que tem (DIRPF, IRPJ/ECF).
Veredito do parecer vigente, para a coluna da listagem.
VALIDO, INVALIDO, INCONCLUSIVO, ANALISE_MANUAL, null 
