Pular para o conteúdo principal
GET
cURL
Veja também:

Autorizações

​
Authorization
string
header
obrigatório

API key criada no portal do parceiro.

Parâmetros de caminho

​
protocol_id
string
obrigatório

Identificador do protocolo, devolvido ao criar. Formato CPR_ seguido de 26 caracteres.

Pattern: ^CPR_[0-9A-HJKMNP-TV-Z]{26}$

Resposta

Protocolo com o status atual e, se a última ação falhou, o error.

​
status
enum<string>
obrigatório

Status do protocolo.

Opções disponíveis:
creating,
protocol_generated,
appointment_scheduled,
certificate_issued,
cancelled,
creation_failed
​
protocol_id
string
obrigatório

Identificador do protocolo. Use nas chamadas de consulta, agendamento e cancelamento.

Pattern: ^CPR_[0-9A-HJKMNP-TV-Z]{26}$
Exemplo:

"CPR_01K7Q3ZB8M4N6P2R5T9V1W3X5Y"

​
certificate
object
obrigatório

Certificado do protocolo.

​
customer
Pessoa física · object
obrigatório

Titular pessoa física.

​
created_at
string<date-time>
obrigatório

Data e hora de criação do protocolo, em UTC.

Exemplo:

"2026-10-21T13:00:00.000Z"

​
updated_at
string<date-time>
obrigatório

Data e hora da última atualização do protocolo, em UTC.

Exemplo:

"2026-10-21T13:00:30.000Z"

​
error
object

Falha da última ação (criar, agendar ou cancelar). Só aparece quando a ação falhou.

​
external_id
string

Seu identificador do pedido, se você enviou um ao criar.

Exemplo:

"PEDIDO_12345"

​
protocol_number
string

Número do protocolo. Compartilhe com o titular para emitir o certificado. Disponível depois que o protocolo é gerado.

Exemplo:

"7800"

​
protocol_url
string<uri>

Link da fila da videoconferência. Compartilhe com o titular. Aparece só em protocol_generated, quando o link está disponível.

Exemplo:

"https://sistemas.gestaocd.com.br/fila/Xk3pQ9vT2a/52998224725/7800"

​
appointment
object

Videoconferência agendada. Aparece depois que o horário é confirmado. Ao reagendar, mantém o horário anterior até a confirmação do novo.

​
valid_until
string<date-time> | null

Fim da validade do certificado, em UTC. Aparece quando o certificado é emitido.

Exemplo:

"2027-10-20T14:10:00.000Z"