Consulta de Check-in¶
Após registrar um check-in, você pode consultar seu status e detalhes a qualquer momento.
Consultar check-in por ID¶
| Parâmetro | Tipo | Descrição |
|---|---|---|
id |
Guid | ID do check-in retornado pelo POST /api/v1/checkins |
Exemplo¶
Respostas¶
200 OK¶
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"tenantId": "1a2b3c4d-0000-0000-0000-000000000001",
"source": "Internal",
"status": "PUBLISHED",
"partnerTransactionId": "TXN-2026-07-03-001",
"correlationId": "2b3c4d5e-aaaa-bbbb-cccc-000000000002",
"occurredAt": "2026-07-03T08:30:00Z",
"receivedAt": "2026-07-03T08:30:01.234Z",
"rejectionReason": null
}
| Campo | Tipo | Descrição |
|---|---|---|
id |
Guid | Identificador do check-in |
tenantId |
Guid | Identificador do seu tenant |
source |
string | Origem (Internal, Wellhub, TotalPass) |
status |
string | Status atual do check-in (ver tabela abaixo) |
partnerTransactionId |
string | O ID que você enviou no registro |
correlationId |
string | ID de rastreabilidade da requisição original |
occurredAt |
DateTime UTC | Momento do check-in (conforme enviado) |
receivedAt |
DateTime UTC | Momento em que a plataforma recebeu o check-in |
rejectionReason |
string ou null | Motivo de rejeição, se aplicável |
404 Not Found¶
Retornado quando o id não existe ou não pertence ao seu tenant.
Status possíveis¶
| Status | Descrição |
|---|---|
RECEIVED |
Recebido, processamento em andamento |
PUBLISHED |
Aprovado e registrado com sucesso |
REJECTED |
Rejeitado (ver rejectionReason) |
Motivos de rejeição (rejectionReason)¶
Quando status é REJECTED, o campo rejectionReason indica o motivo:
| Valor | Significado |
|---|---|
STUDENT_NOT_FOUND |
O externalStudentId não foi encontrado. O aluno não foi sincronizado ou o ID está incorreto. |
STUDENT_INACTIVE |
O aluno foi desativado via sincronização. |
STUDENT_SUSPENDED |
O aluno está suspenso (bloqueio temporário de autorização). |
AUTHORIZATION_EXPIRED |
A autorização do aluno venceu. |
Quando consultar¶
A consulta é útil para:
- Confirmar o resultado do processamento após receber
201 Created - Verificar o motivo de rejeição quando o aluno não consegue fazer check-in
- Depurar integrações durante homologação
- Auditar registros históricos
O check-in fica disponível para consulta indefinidamente após o registro.