Finalizar Tracking

Este serviço completa o processo de Tracking e deve ser invocado ao finalizar todas as validações nos Fluxos de Onboarding ou autenticação. Quando este serviço está integrado, não é necessário invocar o método closeSession do SDK Mobile/Web.

Endpoint

POST /services/finishTracking

Cabeçalhos

Nome	Tipo	Obrigatório	Descrição
x-api-key	string	Sim	API Key de autorização de acesso.
family	string	Não	Valor: Onboarding ou Authentication, de acordo com o Fluxo. Requerido com o serviço de Tracking.

Todas as chamadas aos Endpoints para Tracking com Identity Platform devem conter o cabeçalho family.

Corpo da solicitação

Content-Type: application/json

Parâmetros

Parâmetro	Tipo	Obrigatório	Descrição
family	string	Sim	Valores possíveis: Authentication, Onboarding
status	string	Sim	Valores possíveis: SUCCEEDED, DENIED, ERROR, CANCELLED, BLACKLISTED
reason	string	Sim	Motivo do resultado do Tracking. Veja valores possíveis de reason.
extraData	string	Sim	Token gerado pelo SDK Mobile/Web. Contém informações de Tracking tokenizadas.

Valores possíveis de reason

Valor	Descrição
""	Sem motivo específico (operação bem-sucedida)
DOCUMENT_VALIDATION_NOT_PASSED	A validação do documento não foi superada
DOCUMENT_VALIDATION_ERROR	Erro durante a validação do documento
FACIAL_AUTHENTICATION_NOT_PASSED	A autenticação facial não foi superada
FACIAL_LIVENESS_NOT_PASSED	O teste de vida facial não foi superado
FACIAL_AUTHENTICATION_ERROR	Erro durante a autenticação facial
FACIAL_LIVENESS_ERROR	Erro durante o teste de vida facial
BLACKLISTED_FACE_TEMPLATE	A template facial está na blacklist
ALREADY_REGISTERED	O usuário já está registrado
MANUAL_STATUS_CHANGE	Alteração manual de status
SECURITY_SERVICE_ERROR	Erro no serviço de segurança
SELPHID_INTERNAL_ERROR	Erro interno de SelphID
SELPHID_TIMEOUT	Timeout de SelphID
SELPHI_TIMEOUT	Timeout de Selphi

Exemplo de solicitação

{
  "family": "OnBoarding",
  "status": "SUCCEEDED",
  "reason": "MANUAL_STATUS_CHANGE",
  "extraData": "BQABAQG2gBNjuHN4kLmPqYf7R..."
}

Respostas

200 Sucesso

Parâmetros de resposta

Parâmetro	Tipo	Descrição
trackingStatus	integer	Código que indica o resultado da execução do serviço de Tracking. O valor 201 indica serviço processado sem exceções.
trackingMessage	string	Mensagem que indica o resultado da execução do serviço de Tracking. O valor "FinishTrackingEvent: Ok" indica processamento sem exceções.
transactionId	string	Identificador de transação associado à solicitação processada pela API.
timestamp	string	Marca de tempo (UTC) da resposta no formato YYYY-MM-DDThh🇲🇲ss.SSSZ

Exemplo de resposta

{
  "trackingStatus": 201,
  "trackingMessage": "FinishTrackingEvent: Ok",
  "transactionId": "123e4567-e89b-12d3-a456-426614174000",
  "timestamp": "2023-05-01T12:34:56.789Z"
}

400 Requisição inválida

{
  "status": 400,
  "title": "Bad Request",
  "detail": "Invalid request.",
  "type": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/400",
  "errors": []
}

401 Não autorizado

{
  "message": "Unauthorized"
}

403 Proibido

{
  "Message": "User is not authorized to access this resource with an explicit deny"
}

502 Gateway inválido

{
  "status": 502,
  "title": "Bad Gateway",
  "detail": "Server got an invalid response.",
  "type": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/502"
}

504 Gateway Timeout

{
  "message": "Endpoint request timed out"
}