Menu
Documentation

Cadastrar Face ID no dispositivo

Endpoint: POST multi-access/device-management/devices/faceid/register

Aviso de habilitacao obrigatoria

Este fluxo de Multi Acesso depende de aprovacao interna e reuniao tecnica com o time de tecnologia. Somente apos o alinhamento devem ser enviados/configurados IDs, chaves e secrets necessarios da integracao.

Formato padrao de resposta

Envelope de sucesso (interceptor global):

{
  "status_code": 200,
  "success": true,
  "message": "OK",
  "data": {}
}

Envelope de erro (filtro global):

{
  "status_code": 400,
  "code": "VALIDATION_ERROR",
  "message": "Erro de validacao",
  "timestamp": "2026-02-13T00:00:00.000Z",
  "path": "/exemplo",
  "details": []
}

POST multi-access/device-management/devices/faceid/register

  • Autenticacao: Bearer JWT obrigatorio
  • Contexto de conta: Exige conta ativa quando aplicavel
  • Roles: Nao declarado
  • Scopes: Nao declarado

Request

Path params

Nao possui.

Query params

Nao possui.

Body

DTO: RegisterFaceIdDeviceDto

CampoTipoObrigatorioDetalhes
deviceIdentifierstringSim-
deviceSecretstringSim-
allowLoginBiometricbooleanNao-
allowTransactionBiometricbooleanNao-
platformstringNao-
modelstringNao-
osVersionstringNao-
appVersionstringNao-

Headers

  • Authorization: Bearer <jwt>: obrigatorio.

Exemplos de requisicao

bash
curl -X POST "https://api.seudominio.com/multi-access/device-management/devices/faceid/register" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer SEU_JWT" \
  -H "Content-Type: application/json" \
  -d '{
  "deviceIdentifier": "string_exemplo",
  "deviceSecret": "string_exemplo"
}'

Response

Data (schema)

Nao tipado no retorno do controller. Informe um tipo de retorno para documentar automaticamente.

Sucesso (201):

{
  "status_code": 201,
  "success": true,
  "message": "Created",
  "data": "<resultado da operacao>"
}

Erro (contrato padrao):

{
  "status_code": 400,
  "code": "VALIDATION_ERROR",
  "message": "Erro de validacao",
  "timestamp": "2026-02-13T00:00:00.000Z",
  "path": "multi-access/device-management/devices/faceid/register",
  "details": []
}