Detalhe do ato

GET

/notices/{id}

const url = 'https://api.emmaos.com.br/notices/019928f4-3c21-7a4b-8f0e-6c2d5b1a9f77';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.emmaos.com.br/notices/019928f4-3c21-7a4b-8f0e-6c2d5b1a9f77 \
  --header 'Authorization: Bearer <token>'

Devolve o ato completo, sempre limitado ao tribunal do token. Um id que exista em outro tribunal responde 404, não 403.

Authorizations

bearerAuth

Parameters

Path Parameters

required

string format: uuid

UUIDv7 do ato.

Example

019928f4-3c21-7a4b-8f0e-6c2d5b1a9f77

Responses

200

O ato

application/json

object

required

string format: uuid

protocol

required

string

noticeType

required

Natureza do ato a comunicar.

string

Allowed values: SUMMONS NOTICE NOTIFICATION

status

required

Progresso operacional do ato.

string

Allowed values: PENDING SENT VIEWED CONFIRMED IDENTITY_STARTED COMPLETED FAILED TIMED_OUT CANCELLED RECIPIENT_MISMATCH

recipient

required

object

name

required

Nome do destinatário.

string

cpf

required

CPF, só dígitos (11), com os dígitos verificadores corretos. Um CPF com dígito errado ou de dígitos repetidos (00000000000) é recusado com INVALID_REQUEST em recipient.cpf.

string

phone

required

Telefone em E.164 brasileiro, só dígitos: 55 + DDD existente + número. Celular tem 9 dígitos e começa em 9 (5571999998888); fixo tem 8 dígitos e começa de 2 a 5 (557132345678). Número estrangeiro é recusado. Por compatibilidade, a API aceita o número nacional de 10 ou 11 dígitos, com ou sem máscara e +, e acrescenta o 55; o que não fecha o formato é recusado com INVALID_REQUEST em recipient.phone.

string

/^55(?:11|12|13|14|15|16|17|18|19|21|22|24|27|28|31|32|33|34|35|37|38|41|42|43|44|45|46|47|48|49|51|53|54|55|61|62|63|64|65|66|67|68|69|71|73|74|75|77|79|81|82|83|84|85|86|87|88|89|91|92|93|94|95|96|97|98|99)(?:9[0-9]{8}|[2-5][0-9]{7})$/

email

E-mail do destinatário, para a cópia do documento por e-mail. Opcional. Só é gravado se o tribunal estiver com a cópia ligada; com ela desligada o campo é aceito e descartado sem conferir, e o ato nasce com null. Ligada, o endereço é conferido (ASCII, sem espaço, vírgula, ponto e vírgula nem <>()"\) e um endereço inválido é recusado com INVALID_REQUEST em recipient.email. A resposta de GET /notices/{id} devolve o endereço; a listagem nunca devolve.

string | null

<= 254 characters

case

required

object

number

required

Número do processo.

string

courtDivision

required

Vara. É propriedade do ato, não do usuário.

string

subjectMatter

string | null

plaintiffName

string | null

plaintiffLawyer

string | null

defendantName

string | null

defendantLawyer

string | null

deadlineAt

required

string | null format: date-time

createdAt

required

string format: date-time

customFields

required

Campos personalizados, indexados pelo nome do campo. A chave que o tribunal definiu (GET /custom-field-definitions) é conferida e leva o rótulo da definição; a chave que ninguém definiu passa como veio.

object

key

additional properties

Campo específico do tribunal, congelado no ato no momento do registro: mudar o formulário depois não altera atos já criados.

object

label

required

string

type

required

Tipo de um campo personalizado do tribunal.

string

Allowed values: TEXT DATE CPF SELECT

value

required

string | number | boolean | null

optionLabel

Só em campo SELECT definido pelo tribunal: o rótulo da opção cujo value o ato guardou, carimbado pelo servidor a partir da definição do dia. Ignorado no pedido. Ato antigo pode não tê-lo; a tela então mostra o value.

string

sourceDocument

required

O documento que o tribunal manda comunicar.

A key não é escolhida pelo cliente: ela vem de POST /source-documents, que a cunha no servidor. Enviar uma chave que não veio de lá é recusado com 400.

object

key

required

Chave do objeto, na forma tenants/{tenant}/notices/{ano}/{uuidv7}.pdf, devolvida por POST /source-documents. O tenant na chave tem que ser o do token.

string

/^tenants/([a-z0-9-]{1,32})/notices/([0-9]{4})/[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}\.pdf$/

sha256

required

Digest SHA-256 do arquivo, em hexadecimal minúsculo. Conferido contra o que o armazenamento calculou na gravação: se divergir, o ato não é criado.

string

/^[0-9a-f]{64}$/

issuedBy

required

One of:

null
object

null

confirmationWindow

required

One of:

null
object

null

Example

{
  "protocol": "2026.0000.0001",
  "noticeType": "SUMMONS",
  "status": "PENDING",
  "recipient": {
    "cpf": "52998224725",
    "phone": "5571999998888",
    "email": "destinatario@example.com"
  },
  "customFields": {
    "additionalProperty": {
      "type": "TEXT"
    }
  },
  "confirmationWindow": {
    "counting": "BUSINESS_DAYS"
  }
}

400

Requisição inválida

application/json

object

error

required

Código estável do erro. É por ele que se programa.

string

Allowed values: INVALID_REQUEST INVALID_JSON NOT_FOUND NOT_IMPLEMENTED TIMELINE_TOO_LONG DATABASE_RESUMING INTERNAL_ERROR SEALED_DOCUMENT_MISSING DISPATCH_IN_PROGRESS IDEMPOTENCY_KEY_CONFLICT SEALED_DOCUMENT_TOO_LARGE SOURCE_DOCUMENT_TOO_MANY_PAGES SOURCE_DOCUMENT_UNREADABLE STORAGE_LIMIT_REACHED TENANT_NOT_CONFIGURED

field

Campo que causou a recusa, quando aplicável.

string

message

Texto em português para diagnóstico. Não programe contra ele: pode mudar sem aviso.

string

missing

Só com TENANT_NOT_CONFIGURED: o que falta na configuração do tribunal.

Array<string>

Allowed values: displayName publicPhone whatsappSender

Examples

Campo obrigatório ausente ou malformado

{
  "error": "INVALID_REQUEST",
  "field": "noticeType",
  "message": "noticeType é obrigatório"
}

Corpo não é JSON válido

{
  "error": "INVALID_JSON",
  "message": "corpo JSON inválido"
}

401

Sem header Authorization. Recusado pelo API Gateway antes de chegar à aplicação.

403

Token inválido, expirado, ou de um emissor que não é tribunal conhecido neste stage. Recusado pelo authorizer.

404

Não existe neste tribunal

application/json

object

error

required

Código estável do erro. É por ele que se programa.

string

field

Campo que causou a recusa, quando aplicável.

string

message

Texto em português para diagnóstico. Não programe contra ele: pode mudar sem aviso.

string

missing

Só com TENANT_NOT_CONFIGURED: o que falta na configuração do tribunal.

Array<string>

Allowed values: displayName publicPhone whatsappSender

Example

{
  "error": "NOT_FOUND"
}

500

Erro interno

application/json

object

error

required

Código estável do erro. É por ele que se programa.

string

field

Campo que causou a recusa, quando aplicável.

string

message

Texto em português para diagnóstico. Não programe contra ele: pode mudar sem aviso.

string

missing

Só com TENANT_NOT_CONFIGURED: o que falta na configuração do tribunal.

Array<string>

Allowed values: displayName publicPhone whatsappSender

Example

{
  "error": "INTERNAL_ERROR"
}

503

O banco do tribunal estava pausado e não retomou dentro do orçamento da requisição. Repita.

application/json

object

error

required

Código estável do erro. É por ele que se programa.

string

field

Campo que causou a recusa, quando aplicável.

string

message

Texto em português para diagnóstico. Não programe contra ele: pode mudar sem aviso.

string

missing

Só com TENANT_NOT_CONFIGURED: o que falta na configuração do tribunal.

Array<string>

Allowed values: displayName publicPhone whatsappSender

Example

{
  "error": "DATABASE_RESUMING",
  "message": "Banco de dados está retomando. Tente novamente."
}

Headers

Retry-After

integer

Segundos a esperar antes de repetir.