Erros

Nesta seção, você encontrará a visão geral sobre os erros que pode receber nos endpoints da plataforma Unico IDCloud

---

Introdução

---

A plataforma IDCloud utiliza códigos de resposta HTTP convencionais para indicar o sucesso ou falha de uma solicitação de API.

Como regra geral:

• Códigos no intervalo 2xx indicam sucesso na requisição;

• Códigos no intervalo 4xx indicam parâmetros incorretos ou incompletos (por exemplo, um parâmetro obrigatório foi omitido ou uma operação falhou com terceiros, etc.);

• Códigos no intervalo 5xx indicam que houve um erro nos servidores da plataforma Unico IDCloud.

A plataforma Unico IDCloud também gera uma mensagem de erro e um código de erro formatado em JSON:

{
    "error": {
        "code": "0000",
        "description": "error description"
    }
}

Erros possíveis

---

Neste tópico, você encontrará os possíveis erros dos endpoints, separados por seu HTTP response.

Criar Processo

---

400 Bad Request

code	message	Descrição
3	invalid flow	Quando o flow específicado não existe.
3	invalid person: friendly name exceeds 50 characters.	Quando o nome excede a quantidade máxima de 50 caracteres.
3	invalid purpose	Quando a proposta informada não é valida.
3	invalid callbackUri: unable to parse callbackUri: parse "": empty url, invalid callbackUri: url:	Quando o callbackUri informado não é válido.
3	invalid person: email required for notification channel NOTIFICATION_CHANNEL_EMAIL, invalid email address for notification channel NOTIFICATION_CHANNEL_EMAIL	Quando o e-mail informado não é válido, mas há a notificação via e-mail.
3	invalid person: phone number required for notification channel NOTIFICATION_CHANNEL_WHATSAPP, phone number does not contain 13 chars for notification channel NOTIFICATION_CHANNEL_WHATSAPP	Quando o telefone informado não é válido, mas há a notificação via SMS ou WhatsApp.
3	idnsv2/GetPublicID request error: rpc error: code = InvalidArgument desc = invalid dui value	Quando o CPF informado não é válido.
9	XX ID Apikeys are not set	Quando alguma API Key não foi configurada corretamente.

401 Unauthorized

message	Descrição
Jwt header is an invalid JSON	Quando o access-token utilizado contém caracteres errados.
Jwt is expired	Quando o access-token utilizado expirou

429 Too Many Requests

Não será fornecido nenhum código de erro detalhado para esta situação, apenas o código de status HTTP.

500 Internal Server Error

code	message	Descrição
99999	Internal failure! Try again later	Quando há algum erro interno.

Consultar Resultado do Processo

---

400 Bad Request

code	message	Descrição
3	process id is invalid	Quando o id de processo é inválido.

401 Unauthorized

message	Descrição
Jwt header is an invalid JSON	Quando o access-token utilizado contém caracteres errados.
Jwt is expired	Quando o access-token utilizado expirou

404 Not Found

code	message	Descrição
5	error getting process: rpc error: code = NotFound desc = process not found	Quando o id do processo não foi encontrado

429 Too Many Requests

Não será fornecido nenhum código de erro detalhado para esta situação, apenas o código de status HTTP.

500 Internal Server Error

code	message	Descrição
99999	Internal failure! Try again later	Quando há algum erro interno.

Obter Selfie do Usuário

---

400 Bad Request

code	message	Descrição
3	process id is invalid	Quando o id de processo é inválido.

401 Unauthorized

message	Descrição
Jwt header is an invalid JSON	Quando o access-token utilizado contém caracteres errados.
Jwt is expired	Quando o access-token utilizado expirou

403 Forbidden

code	message	Descrição
7	no permission	Quando a conta de serviço não possui a permissão para obter a selfie

404 Not Found

code	message	Descrição
5	error getting process: rpc error: code = NotFound desc = process not found	Quando o id do processo não foi encontrado

429 Too Many Requests

Não será fornecido nenhum código de erro detalhado para esta situação, apenas o código de status HTTP.

500 Internal Server Error

code	message	Descrição
99999	Internal failure! Try again later	Quando há algum erro interno.

Obter Conjunto Probatório

---

400 Bad Request

code	message	Descrição
3	process id is invalid	Quando o id de processo é inválido.

401 Unauthorized

message	Descrição
Jwt header is an invalid JSON	Quando o access-token utilizado contém caracteres errados.
Jwt is expired	Quando o access-token utilizado expirou

403 Forbidden

code	message	Descrição
7	no permission	Quando a conta de serviço não possui a permissão para obter a selfie

404 Not Found

code	message	Descrição
5	error getting process: rpc error: code = NotFound desc = process not found	Quando o id do processo não foi encontrado

429 Too Many Requests

Não será fornecido nenhum código de erro detalhado para esta situação, apenas o código de status HTTP.

500 Internal Server Error

code	message	Descrição
99999	Internal failure! Try again later	Quando há algum erro interno.

Obter Documento Assinado

---

404 Not Found

429 Too Many Requests

Não será fornecido nenhum código de erro detalhado para esta situação, apenas o código de status HTTP.

500 Internal Server Error

sucess	message	data	Descrição
false	Falha ao consultar o arquivo do documento.	Documento não existe.	O id do documento informado não existe

Obter Conjunto Probatório do Documento Assinado

---

404 Not Found

Message	StatusCode	Errors
Not Found - Documento não existe	404	null

412 Precondition Failed

429 Too Many Requests

Não será fornecido nenhum código de erro detalhado para esta situação, apenas o código de status HTTP.

500 Internal Server Error

sucess	message	data	Descrição
false	Falha ao consultar o arquivo do documento.	Documento não existe.	O id do documento informado não existe

---

​Dúvidas?

Não encontrou algo ou ainda precisa de ajuda? Se já é um cliente ou parceiro, pode entrar em contato através da Central de Ajuda.