Obter token Previred

Serviço que recupera o Token de autenticação TVI e a URL de download do documento de evidência PDF gerado durante o processo de verificação com a Previred.

Endpoint

GET /services/previred/{transactionId}

Cabeçalhos

Nome	Tipo	Obrigatório	Descrição
x-api-key	string	Sim	API key de autorização de acesso.

Parâmetros de rota

Parâmetro	Tipo	Obrigatório	Descrição
transactionId	string	Sim	ID da transação retornado pelo Endpoint de criação de transação.

Respostas

200 Sucesso

Parâmetros de resposta

Parâmetro	Tipo	Descrição
timestamp	integer	Marca de tempo Unix da resposta em segundos.
transactionId	string	ID de transação vinculado ao processo de geração de evidência.
token	string	Token de autenticação TVI.
url	string	URL para baixar o documento de evidência PDF de verificação.

Exemplo de resposta

{
  "timestamp": 1709708084,
  "transactionId": "0fec0e8d-3ef3-477f-ae9e-e350cda74b33",
  "token": "VI19:yCQAnOEPolfgPg5rSG8Px1Ism2DMKgyaWc1pqvYsz5vTx1E7nEAfh1oOrOa59...",
  "url": "https://api.identity-platform.io/services/custody/download?token=eyJhbG..."
}

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"
}

404 Não encontrado

{
  "status": 404,
  "title": "Not Found",
  "detail": "Transaction not found.",
  "type": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/404"
}

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 Tempo esgotado no gateway

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