APIs
Obtém o resultado consolidado do processo
Consulte o resultado final consolidado de um processo iniciado anteriormente, informando o requestId como parâmetro de caminho.
GET
Obtém o resultado consolidado do processo
Use
Exemplo de sucesso (
GET /onboarding/api/v1/steps/result/{requestId} para consultar o resultado final consolidado de um processo iniciado anteriormente. A requisição requer o requestId como parâmetro de caminho para identificar o processo e não espera um corpo de requisição.
A API irá retornar todos os dados e status consolidados do processo especificado pelo identificador.
Requisito: é necessário enviar o header de autenticação, mais informações aqui
Path Parameters
string
required
O ID único da requisição de processo a ser consultada, no formato UUID.Exemplo:
05be75cc-8f8a-414a-891f-434aa9b4e7a5Response
Retorna o resultado consolidado e o status do processo. Os blocos de resultado (livenessResponse, mfaResponse, fraudResponse, uploadResponse, bureauQueryResponse, signerResponse) são retornados apenas para as etapas executadas no processo.
Exemplo de sucesso (200 OK)
string
Status consolidado do processo. Valores possíveis:
STARTED, PROCESSING, ANALYSIS, SIGNING, APPROVED, REJECTED, FINISHED, FAILED, ABORTED, IGNORED, CANCELLED, EXPIRED.object
Dados enviados na requisição que iniciou o processo.
object
Resultado da etapa de liveness.
object
Resultado da etapa MFA.
object
Resultado da etapa de fraude.
object
Resultado da etapa de upload de arquivo.
object
Resultado da consulta ao pacote de datasets.
object
Resultado da etapa de assinatura, com o estado de cada documento indexado pelo
fileId.string
Data e hora (ISO) em que o processo atingiu um status de finalização.
string
Data e hora (ISO) de criação do processo.
Respostas de Erro
A API pode retornar os status400 (Bad request), 401 (Unauthorized), 403 (Forbidden — processo pertence a outro projeto), 404 (Resource not found — requestId não existe) e 500 (Internal server error).
string
Código do erro que categoriza o tipo de erro.Exemplo:
NOT_FOUNDstring
Mensagem de erro.Exemplo:
Resource not found