Obter Conjunto de Evidências
Retorna o pacote de evidências gerado durante a captura biométrica — um pacote contendo as imagens capturadas, metadados e artefatos de captura usados para comprovar que a detecção de prova de vida foi realizada sob condições controladas.
Disponível apenas para processos concluídos (state = PROCESS_STATE_FINISHED).
Endpoint
| Ambiente | URL |
|---|---|
| Produção | GET https://api.idcloud.unico.app/client/v1/process/{processId}/evidenceset |
| Sandbox | GET https://api.idcloud.uat.unico.app/client/v1/process/{processId}/evidenceset |
Requisição
| Cabeçalho | Valor |
|---|---|
Authorization | Bearer <access_token> (veja Autenticação) |
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
processId | string (UUID) | sim | Identificador do processo retornado por Criar Processo. |
Exemplo
- cURL
- Node.js
curl -X GET https://api.idcloud.unico.app/client/v1/process/$PROCESS_ID/evidenceset \
-H "Authorization: Bearer $TOKEN" \
| jq -r .fileContents | base64 --decode > evidence-set.pdf
import { writeFile } from 'node:fs/promises';
async function getEvidenceSet(processId) {
const response = await fetch(
`https://api.idcloud.unico.app/client/v1/process/${processId}/evidenceset`,
{ headers: { Authorization: `Bearer ${accessToken}` } }
);
if (!response.ok) throw new Error(`Get Evidence Set failed with ${response.status}`);
const { fileContents } = await response.json();
// fileContents é o arquivo PDF, codificado em base64
return Buffer.from(fileContents, 'base64');
}
// Salvar o PDF no disco
await writeFile(`evidence-set-${processId}.pdf`, await getEvidenceSet(processId));
// Ou enviar para o navegador (Express)
app.get('/processes/:id/evidence-set', async (req, res) => {
const pdf = await getEvidenceSet(req.params.id);
res
.type('application/pdf') // não repasse contentType: a API retorna "x-pdf"
.set('Content-Disposition', 'inline; filename="evidence-set.pdf"')
.send(pdf);
});
Respostas
{
"fileContents": "JVBERi0xLjMNCi...",
"contentType": "x-pdf"
}
| Campo | Tipo | Descrição |
|---|---|---|
fileContents | string (base64) | O PDF do conjunto de evidências, codificado em base64. |
contentType | string | Atualmente retorna x-pdf. |
x-pdf não é um tipo MIME válido, e os navegadores não o reconhecem. Não repasse contentType para o navegador. Decodifique fileContents de base64 e sirva os bytes como application/pdf, como no exemplo de Node.js acima.
Códigos de Erro
A API não expõe valores específicos de code ou message para este endpoint.
- 400 Bad Request
- 401 Unauthorized
- 404 Not Found
- 500 Internal Server Error
O parâmetro de caminho processId está ausente ou malformado.
Token Bearer ausente, expirado ou inválido. Veja Autenticação.
Processo não encontrado, ou o conjunto de evidências ainda não está disponível (processo não finalizado).
| Código | Mensagem | Descrição |
|---|---|---|
99999 | Internal failure! Try again later | Quando ocorre um erro interno. |
Próximos passos
- Para o resultado completo do processo, veja Obter Processo.
- Para a imagem da selfie capturada, veja Obter Selfie.