Errors

In this section, you will find an overview of the errors you may encounter in the endpoints of the Unico IDCloud platform.

---

Introduction

---

The IDCloud platform uses conventional HTTP response codes to indicate the success or failure of an API request.

As a general rule:

• Codes in the 2xx range indicate a successful request;

• Codes in the 4xx range indicate incorrect or incomplete parameters (for example, a required parameter was omitted, or an operation failed with third parties, etc.);

• Codes in the 5xx range indicate that there was an error on the Unico IDCloud platform's servers.

The Unico IDCloud platform also generates an error message and an error code formatted in JSON:

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

Possible Errors

---

In this topic, you will find the possible errors for the endpoints, separated by their HTTP response.

Create Process

---

400 Bad Request

code	message	description
3	invalid flow	When the specified flow does not exist.
3	invalid purpose	When the provided proposal is invalid.
3	invalid callbackUri: unable to parse callbackUri: parse "": empty url, invalid callbackUri: url:	When the provided callbackUri is invalid.
3	invalid person: email required for notification channel NOTIFICATION_CHANNEL_EMAIL, invalid email address for notification channel NOTIFICATION_CHANNEL_EMAIL	When the provided email is invalid, but there is email notification.
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	When the provided phone number is invalid, but there is notification via SMS or WhatsApp.
3	idnsv2/GetPublicID request error: rpc error: code = InvalidArgument desc = invalid dui value	When the provided CPF is invalid.
9	XX ID Apikeys are not set	When an API Key has not been configured correctly.

401 Unauthorized

message	description
Jwt header is an invalid JSON	When the access token used contains incorrect characters.
Jwt is expired	When the access token used has expired.

429 Too Many Requests

No detailed error code will be provided for this situation, only the HTTP status code.

500 Internal Server Error

code	message	description
99999	Internal failure! Try again later	When there is an internal error.

Consult Process Result

---

400 Bad Request

code	message	description
3	process id is invalid	When the process ID is invalid.

401 Unauthorized

message	description
Jwt header is an invalid JSON	When the access token used contains incorrect characters.
Jwt is expired	When the access token used has expired.

404 Not Found

code	message	description
5	error getting process: rpc error: code = NotFound desc = process not found	When the process ID was not found.

429 Too Many Requests

No detailed error code will be provided for this situation, only the HTTP status code.

500 Internal Server Error

code	message	description
99999	Internal failure! Try again later	When there is an internal error.

Get User's Selfie

---

400 Bad Request

code	message	description
3	process id is invalid	When the process ID is invalid.

401 Unauthorized

message	description
Jwt header is an invalid JSON	When the access token used contains incorrect characters.
Jwt is expired	When the access token used has expired.

403 Forbidden

code	message	description
7	no permission	When the service account does not have permission to retrieve the selfie.

404 Not Found

code	message	description
5	error getting process: rpc error: code = NotFound desc = process not found	When the process ID was not found.

429 Too Many Requests

No detailed error code will be provided for this situation, only the HTTP status code.

500 Internal Server Error

code	message	description
99999	Internal failure! Try again later	When there is an internal error.

Obtain Evidence Set

---

400 Bad Request

code	message	description
3	process id is invalid	When the process ID is invalid.

401 Unauthorized

message	description
Jwt header is an invalid JSON	When the access token used contains incorrect characters.
Jwt is expired	When the access token used has expired.

403 Forbidden

code	message	description
7	no permission	When the service account does not have permission to retrieve the selfie.

404 Not Found

code	message	description
5	error getting process: rpc error: code = NotFound desc = process not found	When the process ID was not found.

429 Too Many Requests

No detailed error code will be provided for this situation, only the HTTP status code.

500 Internal Server Error

code	message	description
99999	Internal failure! Try again later	When there is an internal error.

Obtain Signed Document

---

404 Not Found

code	message	description
5	error getting process: rpc error: code = NotFound desc = process not found	When the process ID was not found.

429 Too Many Requests

No detailed error code will be provided for this situation, only the HTTP status code.

500 Internal Server Error

code	message	description
99999	Internal failure! Try again later	When there is an internal error.

Obtain Evidence Set of the Signed Document

---

404 Not Found

code	message	description
5	error getting process: rpc error: code = NotFound desc = process not found	When the process ID was not found.

412 Precondition Failed

No detailed error code will be provided for this situation, only the HTTP status code.

429 Too Many Requests

No detailed error code will be provided for this situation, only the HTTP status code.

500 Internal Server Error

code	message	description
99999	Internal failure! Try again later	When there is an internal error.

---

Still need help?​

Didn't find something or still need help? If you're already a client or partner, you can reach out through our Help Center.