Integracao

[ESPEC] Consultar pessoa

Especificacao — ainda nao implementado. Este endpoint esta publicado para acordo de contrato; chamadas retornam 404 ate a implementacao.

Retorna o cadastro, a situacao do acesso e o estado de sincronizacao em cada dispositivo do espaco. Use para conferir se a pessoa esta apta a passar no leitor: photoPending: true ou devices[].synced: false indicam que ela ainda nao sera reconhecida.

get/api/v1/integration/persons/{externalId}

Request

Base URL: http://localhost:3000
URL: http://localhost:3000/api/v1/integration/persons/{externalId}
Auth: API key in header X-API-Key

Path parameters

externalIdstring required

Identificador da pessoa no sistema de origem.

Example:EMP-4521

Headers

X-API-Keystring required

Chave de API do espaco, gerada no painel administrativo.

Example:k_9fA3…

X-Tenant-Slugstring required

Identificador do espaco (slug).

Example:matriz-sao-jose

Response

Pessoa encontrada

Example response

{
  "item": {
    "identity": {
      "externalId": "EMP-4521",
      "registration": "4521",
      "badgeCode": "0000004521",
      "companyCode": "1"
    },
    "personType": "employee",
    "access": {
      "validFrom": "2026-03-01T00:00:00.000Z",
      "allowedHours": {
        "start": "07:00",
        "end": "19:00",
        "days": [
          1,
          2,
          3,
          4,
          5
        ]
      }
    },
    "devices": [
      {
        "deviceName": "Catraca Portaria"
      }
    ],
    "attributes": {
      "matriculaInterna": "4521",
      "turno": "A"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.