Skip to main content
GET
Obtém o resultado consolidado do processo
Use 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.Exemplo: 05be75cc-8f8a-414a-891f-434aa9b4e7a5

Response

Retorna o resultado consolidado e o status final do processo.

Exemplo de sucesso (200 OK)

string
required
ID do processo consultado.
string
required
Status final consolidado do processo (e.g., APPROVED, REJECTED, PENDING).
object
Objeto contendo os resultados detalhados das etapas executadas.
string
Data e hora de finalização do processo.

Respostas de Erro

A API pode retornar os status 400 (Bad request), 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_FOUND
string
Mensagem de erro.Exemplo: Resource not found