curl --request GET 'https://gyra-core.gyramais.com.br/v1/collections/6612a7f30000000000000001' \
--header 'Authorization: Bearer <token>'
const resposta = await fetch("https://gyra-core.gyramais.com.br/v1/collections/6612a7f30000000000000001", {
method: "GET",
headers: { Authorization: `Bearer ${token}` },
});
const dados = await resposta.json();
import requests
resposta = requests.get(
"https://gyra-core.gyramais.com.br/v1/collections/6612a7f30000000000000001",
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/collections/{id}",
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/collections/{id}"
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/collections/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://gyra-core.gyramais.com.br/v1/collections/{id}")
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{
"id": "6612a7f30000000000000051",
"registryId": "6612a7f30000000000000001",
"templateId": "6612a7f30000000000000041",
"templateSlug": "onboarding-pj",
"templateName": "Onboarding PJ",
"templateVersion": 3,
"status": "SENT",
"responseMode": "REVIEW",
"channel": "BOTH",
"reminders": [
2,
5
],
"behavior": {
"acceptPartial": false,
"requestResendOnReject": true,
"notifyOnComplete": true,
"skipItemsAlreadyOnFile": true
},
"message": "Precisamos destes documentos para liberar seu limite.",
"dueAt": "2026-09-15T23:59:59.000Z",
"sentAt": "2026-09-05T14:20:00.000Z",
"completedAt": null,
"canceledAt": null,
"subjectName": "AURORA COMPONENTES INDUSTRIAIS LTDA",
"subjectDocument": "11444777000161",
"items": [
{
"id": "6612a7f30000000000000071",
"collectionId": "6612a7f30000000000000051",
"recipientId": "6612a7f30000000000000061",
"order": 1,
"kind": "DOCUMENT",
"documentType": "CONTRATO_SOCIAL",
"label": "Contrato social consolidado",
"instructions": "Envie a última alteração consolidada, com a chancela da Junta.",
"required": true,
"rules": {
"maxAgeDays": 365,
"allowMultipleFiles": true,
"maxFiles": 5
},
"status": "PENDING",
"registryDocumentId": null,
"attempt": null,
"verdict": null,
"score": null,
"rejectionReason": null,
"submittedAt": null,
"resendCount": 0,
"files": [],
"signatureMode": "INDIVIDUAL",
"signaturePackage": null,
"resolvedAt": null
}
],
"recipients": [
{
"id": "6612a7f30000000000000061",
"collectionId": "6612a7f30000000000000051",
"name": "Ana Souza",
"document": "52998224725",
"email": "ana@exemplo.com.br",
"phone": 5551999998888,
"role": "Sócia administradora · 60%",
"registryPersonId": "6612a7f30000000000000021",
"status": "DELIVERED",
"emailDelivery": "DELIVERED",
"whatsappDelivery": "SENT",
"deliveryError": null,
"tokenExpiresAt": "2026-09-15T23:59:59.000Z",
"lastSentAt": "2026-09-05T14:20:03.000Z",
"openedAt": null,
"completedAt": null,
"remindersSent": 0,
"lastReminderAt": null,
"revoked": false
}
],
"createdAt": "2026-09-05T14:19:58.000Z",
"updatedAt": "2026-09-05T14:20:03.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": "Solicitação não encontrada."
}{
"code": 500,
"message": "Internal server error"
}Consultar Solicitação
Para acompanhar item a item e ver o estado de entrega de cada destinatário.
curl --request GET 'https://gyra-core.gyramais.com.br/v1/collections/6612a7f30000000000000001' \
--header 'Authorization: Bearer <token>'
const resposta = await fetch("https://gyra-core.gyramais.com.br/v1/collections/6612a7f30000000000000001", {
method: "GET",
headers: { Authorization: `Bearer ${token}` },
});
const dados = await resposta.json();
import requests
resposta = requests.get(
"https://gyra-core.gyramais.com.br/v1/collections/6612a7f30000000000000001",
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/collections/{id}",
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/collections/{id}"
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/collections/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://gyra-core.gyramais.com.br/v1/collections/{id}")
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{
"id": "6612a7f30000000000000051",
"registryId": "6612a7f30000000000000001",
"templateId": "6612a7f30000000000000041",
"templateSlug": "onboarding-pj",
"templateName": "Onboarding PJ",
"templateVersion": 3,
"status": "SENT",
"responseMode": "REVIEW",
"channel": "BOTH",
"reminders": [
2,
5
],
"behavior": {
"acceptPartial": false,
"requestResendOnReject": true,
"notifyOnComplete": true,
"skipItemsAlreadyOnFile": true
},
"message": "Precisamos destes documentos para liberar seu limite.",
"dueAt": "2026-09-15T23:59:59.000Z",
"sentAt": "2026-09-05T14:20:00.000Z",
"completedAt": null,
"canceledAt": null,
"subjectName": "AURORA COMPONENTES INDUSTRIAIS LTDA",
"subjectDocument": "11444777000161",
"items": [
{
"id": "6612a7f30000000000000071",
"collectionId": "6612a7f30000000000000051",
"recipientId": "6612a7f30000000000000061",
"order": 1,
"kind": "DOCUMENT",
"documentType": "CONTRATO_SOCIAL",
"label": "Contrato social consolidado",
"instructions": "Envie a última alteração consolidada, com a chancela da Junta.",
"required": true,
"rules": {
"maxAgeDays": 365,
"allowMultipleFiles": true,
"maxFiles": 5
},
"status": "PENDING",
"registryDocumentId": null,
"attempt": null,
"verdict": null,
"score": null,
"rejectionReason": null,
"submittedAt": null,
"resendCount": 0,
"files": [],
"signatureMode": "INDIVIDUAL",
"signaturePackage": null,
"resolvedAt": null
}
],
"recipients": [
{
"id": "6612a7f30000000000000061",
"collectionId": "6612a7f30000000000000051",
"name": "Ana Souza",
"document": "52998224725",
"email": "ana@exemplo.com.br",
"phone": 5551999998888,
"role": "Sócia administradora · 60%",
"registryPersonId": "6612a7f30000000000000021",
"status": "DELIVERED",
"emailDelivery": "DELIVERED",
"whatsappDelivery": "SENT",
"deliveryError": null,
"tokenExpiresAt": "2026-09-15T23:59:59.000Z",
"lastSentAt": "2026-09-05T14:20:03.000Z",
"openedAt": null,
"completedAt": null,
"remindersSent": 0,
"lastReminderAt": null,
"revoked": false
}
],
"createdAt": "2026-09-05T14:19:58.000Z",
"updatedAt": "2026-09-05T14:20:03.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": "Solicitação não encontrada."
}{
"code": 500,
"message": "Internal server error"
}Quando usar
Para acompanhar item a item e ver o estado de entrega de cada destinatário.O estado que mais importa
recipients[].status em FAILED quer dizer que a mensagem não chegou. É o caso de ligar para o cliente, e é por isso que vale assinar collection.message.failed.
items[].files[] traz o parecer de cada arquivo, quando o item aceita mais de um. Item com signedDocumentAvailable: true tem via assinada para baixar.
O link de cada destinatário não volta aqui: ele só existe na resposta de criação e na de envio.
Authorizations
Enter JWT token
Path Parameters
Id da solicitacao.
Response
Solicitacao com itens, destinatarios, links e trilha.
Uma solicitacao de coleta com itens, destinatarios e trilha.
DRAFT, SENT, IN_PROGRESS, COMPLETED, EXPIRED, CANCELED AUTOMATIC, REVIEW NONE: a plataforma nao avisou ninguem e quem entrega o link e voce.
WHATSAPP, EMAIL, BOTH, NONE Dias apos o envio.
O comportamento herdado do modelo.
Recado do operador ao destinatario.
Resumo do cadastro alvo, para evitar uma segunda chamada.
Hide child attributes
Hide child attributes
DOCUMENT, IDENTITY, CONSENT, SIGNATURE, FORM, CUSTOM 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, null O que o destinatario le.
Regras da coleta para este item (recencia, formatos, metodos de identidade).
PENDING, ALREADY_ON_FILE, SUBMITTED, PROCESSING, VALIDATED, REJECTED, MANUAL_REVIEW, AWAITING_OPERATOR, WAIVED, EXPIRED O documento que este item gerou no cadastro.
VALIDO, INVALIDO, INCONCLUSIVO, ANALISE_MANUAL, null Motivo tecnico, para o operador.
Um por arquivo enviado, com o parecer de cada um. Vazio no item que ainda nao recebeu nada.
Hide child attributes
Hide child attributes
PENDING, ALREADY_ON_FILE, SUBMITTED, PROCESSING, VALIDATED, REJECTED, MANUAL_REVIEW, AWAITING_OPERATOR, WAIVED, EXPIRED VALIDO, INVALIDO, INCONCLUSIVO, ANALISE_MANUAL, null SCR, null O formulario pedido.
O que a extracao sugeriu.
O que a pessoa respondeu.
A avaliacao da verificacao em portugues (veredito, similaridade, prova de vida, sinais de antifraude). O payload cru do provedor NAO vem aqui.
Quantas imagens estao guardadas. Os enderecos saem por acao explicita, que fica na trilha.
INDIVIDUAL, JOINT SIGNATURE, SIGNATURE_AND_IDENTITY, null "2 de 4 assinaram", ja pronto.
Hide child attributes
Hide child attributes
Nome das partes obrigatorias que faltam.
Assinaram o texto e esperam a verificacao de identidade.
Partes sem contato para receber o link.
true quando a via em PDF pode nascer.
APPROVED, RESEND_REQUESTED, WAIVED, null Por que o item nasceu ALREADY_ON_FILE, em portugues.
true quando ha via assinada para baixar em GET /v1/collections/{id}/items/{itemId}/signed-document.
Quantos e-mails foram oferecidos para a verificacao por e-mail (nunca quais).
Hide child attributes
Hide child attributes
E.164.
FAILED quer dizer que a MENSAGEM nao chegou. NO_ITEMS: nao sobrou item para essa pessoa.
PENDING, DELIVERED, OPENED, IN_PROGRESS, COMPLETED, FAILED, NO_ITEMS PENDING, SENT, DELIVERED, FAILED PENDING, SENT, DELIVERED, FAILED So volta na criacao e na reemissao. O token cru nunca e persistido.
A trilha, append-only. O detalhe traz os 100 eventos mais recentes.
Itens esperando decisao humana (AWAITING_OPERATOR ou MANUAL_REVIEW).

