curl --request POST 'https://gyra-core.gyramais.com.br/v1/registry/6612a7f30000000000000001/documents' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{"key":"presigned/contrato-social-3f6c2a9e-8b1d-4c7a-9e2f-5a1b7c3d9e40.pdf","fileName":"contrato-social.pdf","expectedType":"CONTRATO_SOCIAL","callbackUrl":"https://api.suaempresa.com/gyra/kyc"}'const resposta = await fetch("https://gyra-core.gyramais.com.br/v1/registry/6612a7f30000000000000001/documents", {
method: "POST",
headers: {
Authorization: `Bearer ${token}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"key": "presigned/contrato-social-3f6c2a9e-8b1d-4c7a-9e2f-5a1b7c3d9e40.pdf",
"fileName": "contrato-social.pdf",
"expectedType": "CONTRATO_SOCIAL",
"callbackUrl": "https://api.suaempresa.com/gyra/kyc"
}),
});
const dados = await resposta.json();
import requests
resposta = requests.post(
"https://gyra-core.gyramais.com.br/v1/registry/6612a7f30000000000000001/documents",
headers={"Authorization": f"Bearer {token}"},
json={
"key": "presigned/contrato-social-3f6c2a9e-8b1d-4c7a-9e2f-5a1b7c3d9e40.pdf",
"fileName": "contrato-social.pdf",
"expectedType": "CONTRATO_SOCIAL",
"callbackUrl": "https://api.suaempresa.com/gyra/kyc"
},
)
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 => "POST",
CURLOPT_POSTFIELDS => json_encode([
'key' => 'presigned/contrato-social-3f6c2a9e-8b1d-4c7a-9e2f-5a1b7c3d9e40.pdf',
'fileName' => 'contrato-social.pdf',
'expectedType' => 'CONTRATO_SOCIAL',
'callbackUrl' => 'https://api.suaempresa.com/gyra/kyc'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://gyra-core.gyramais.com.br/v1/registry/{id}/documents"
payload := strings.NewReader("{\n \"key\": \"presigned/contrato-social-3f6c2a9e-8b1d-4c7a-9e2f-5a1b7c3d9e40.pdf\",\n \"fileName\": \"contrato-social.pdf\",\n \"expectedType\": \"CONTRATO_SOCIAL\",\n \"callbackUrl\": \"https://api.suaempresa.com/gyra/kyc\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://gyra-core.gyramais.com.br/v1/registry/{id}/documents")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"key\": \"presigned/contrato-social-3f6c2a9e-8b1d-4c7a-9e2f-5a1b7c3d9e40.pdf\",\n \"fileName\": \"contrato-social.pdf\",\n \"expectedType\": \"CONTRATO_SOCIAL\",\n \"callbackUrl\": \"https://api.suaempresa.com/gyra/kyc\"\n}")
.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::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"key\": \"presigned/contrato-social-3f6c2a9e-8b1d-4c7a-9e2f-5a1b7c3d9e40.pdf\",\n \"fileName\": \"contrato-social.pdf\",\n \"expectedType\": \"CONTRATO_SOCIAL\",\n \"callbackUrl\": \"https://api.suaempresa.com/gyra/kyc\"\n}"
response = http.request(request)
puts response.read_body{
"documentId": "6612a7f30000000000000031",
"status": "RECEIVED"
}{
"code": 400,
"message": "key should not be empty,key must be a string"
}{
"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": 409,
"message": "Este arquivo já existe neste cadastro."
}{
"code": 500,
"message": "Internal server error"
}{
"code": 502,
"message": "Não foi possível registrar o documento."
}Confirmar Upload e Analisar
Segundo passo do envio assíncrono: o arquivo já está no armazenamento e você dispara a análise.
curl --request POST 'https://gyra-core.gyramais.com.br/v1/registry/6612a7f30000000000000001/documents' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{"key":"presigned/contrato-social-3f6c2a9e-8b1d-4c7a-9e2f-5a1b7c3d9e40.pdf","fileName":"contrato-social.pdf","expectedType":"CONTRATO_SOCIAL","callbackUrl":"https://api.suaempresa.com/gyra/kyc"}'const resposta = await fetch("https://gyra-core.gyramais.com.br/v1/registry/6612a7f30000000000000001/documents", {
method: "POST",
headers: {
Authorization: `Bearer ${token}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"key": "presigned/contrato-social-3f6c2a9e-8b1d-4c7a-9e2f-5a1b7c3d9e40.pdf",
"fileName": "contrato-social.pdf",
"expectedType": "CONTRATO_SOCIAL",
"callbackUrl": "https://api.suaempresa.com/gyra/kyc"
}),
});
const dados = await resposta.json();
import requests
resposta = requests.post(
"https://gyra-core.gyramais.com.br/v1/registry/6612a7f30000000000000001/documents",
headers={"Authorization": f"Bearer {token}"},
json={
"key": "presigned/contrato-social-3f6c2a9e-8b1d-4c7a-9e2f-5a1b7c3d9e40.pdf",
"fileName": "contrato-social.pdf",
"expectedType": "CONTRATO_SOCIAL",
"callbackUrl": "https://api.suaempresa.com/gyra/kyc"
},
)
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 => "POST",
CURLOPT_POSTFIELDS => json_encode([
'key' => 'presigned/contrato-social-3f6c2a9e-8b1d-4c7a-9e2f-5a1b7c3d9e40.pdf',
'fileName' => 'contrato-social.pdf',
'expectedType' => 'CONTRATO_SOCIAL',
'callbackUrl' => 'https://api.suaempresa.com/gyra/kyc'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://gyra-core.gyramais.com.br/v1/registry/{id}/documents"
payload := strings.NewReader("{\n \"key\": \"presigned/contrato-social-3f6c2a9e-8b1d-4c7a-9e2f-5a1b7c3d9e40.pdf\",\n \"fileName\": \"contrato-social.pdf\",\n \"expectedType\": \"CONTRATO_SOCIAL\",\n \"callbackUrl\": \"https://api.suaempresa.com/gyra/kyc\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://gyra-core.gyramais.com.br/v1/registry/{id}/documents")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"key\": \"presigned/contrato-social-3f6c2a9e-8b1d-4c7a-9e2f-5a1b7c3d9e40.pdf\",\n \"fileName\": \"contrato-social.pdf\",\n \"expectedType\": \"CONTRATO_SOCIAL\",\n \"callbackUrl\": \"https://api.suaempresa.com/gyra/kyc\"\n}")
.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::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"key\": \"presigned/contrato-social-3f6c2a9e-8b1d-4c7a-9e2f-5a1b7c3d9e40.pdf\",\n \"fileName\": \"contrato-social.pdf\",\n \"expectedType\": \"CONTRATO_SOCIAL\",\n \"callbackUrl\": \"https://api.suaempresa.com/gyra/kyc\"\n}"
response = http.request(request)
puts response.read_body{
"documentId": "6612a7f30000000000000031",
"status": "RECEIVED"
}{
"code": 400,
"message": "key should not be empty,key must be a string"
}{
"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": 409,
"message": "Este arquivo já existe neste cadastro."
}{
"code": 500,
"message": "Internal server error"
}{
"code": 502,
"message": "Não foi possível registrar o documento."
}Quando usar
Segundo passo do envio assíncrono: o arquivo já está no armazenamento e você dispara a análise.Os dois campos de tipo
expectedType pede um tipo e a conferência roda. typeHint afirma o tipo e a classificação é pulada. Enviando os dois, typeHint vence.
O resultado chega pelo callbackUrl, pelo webhook da organização, ou por Status do documento.
Authorizations
Enter JWT token
Path Parameters
Id do cadastro.
Body
A key devolvida pelo presign, exatamente como veio.
Nome do arquivo que fica no dossie.
Afirma o tipo documental do arquivo: o pipeline ADOTA este tipo e PULA a etapa de classificação. Use quando a origem do arquivo já garante o tipo (o operador escolheu na tela, o formulário só aceita aquele documento). Como a classificação não roda, não existe leitura automática a confrontar e a verificação EXPECTED_TYPE_MATCH sai SKIP. Não use typeHint para dizer "eu pedi este documento": para isso existe o expectedType.
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 Tipo documental que a solicitação PEDIU. Não força nada e não pula etapa alguma: a classificação roda normalmente e o tipo lido é confrontado com este valor na verificação EXPECTED_TYPE_MATCH. Tipo lido igual ao pedido, a verificação passa; diferente, reprova o documento (ou vira ressalva quando a leitura do tipo está com pouca confiança). É o campo que pega o arquivo legítimo enviado no campo errado (uma declaração de IR subida como comprovante de residência), que sem ele seria classificado, validado e aprovado como o tipo que de fato é. Omitir significa envio livre no dossiê: sem pedido, a verificação sai SKIP. Combinado com typeHint no mesmo envio, o typeHint vence e a verificação sai SKIP (não há classificação a confrontar).
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 CPF ou CNPJ de uma pessoa do quadro deste cadastro, para anexar o documento a ela. Precisa estar na arvore societaria.
URL chamada quando o documento terminar de processar.

