Qual a estrutura das mensagens de erro?

As mensagens de erro foram desenvolvidas com base em regras de negócio aplicadas especificamente para serviços de biometria.

Seguindo as boas práticas, os códigos de erro foram construídos seguindo a estrutura:

Status Code

4XX erros do cliente: requisição com dados inválidos ou incorretos; ticket expirado ou inativo, etc;
5XX erros do servidor Oiti: falha.; uma solicitação válida foi feita pelo cliente, mas o servidor falhou ao concluir a solicitação.

Body Response: message (indica a mensagem de erro) e code (indica o serviço e o código de erro).

Como é o response para mensagens de erro?

Para cada operação executada na Certiface API será retornada uma mensagem de erro conforme exemplo:

{
 "message": "Invalid Input: birthDate is a required field",
 "code": "XXX.400.000"
}

💡
Sobre o código de erro
As três primeiras letras de code estarão representando o serviço em específico.
Ex.: TKT (ticket); ORC (orchestrator); e RES (result).

Quais são os códigos de erro retornados pela Certiface API?

Lista de erros Ticket

Código	Mensagem	Descrição	Solução
TKT.400.001	'userDocumentNumber' is a required field	Campo obrigatório	Verifique se o parâmetro foi preenchido
TKT.400.001	'userDocumentNumber' is not valid	Dados inválidos	Verifique se os dados estão corretos
TKT.400.001	'name' is a required field	Campo obrigatório	Verifique se o parâmetro foi preenchido
TKT.400.001	'name' must contain first and last name	O campo deve conter Nome e Sobrenome	Verifique se os dados estão corretos
TKT.400.001	'birthDate' is a required field	Campo obrigatório	Verifique se o parâmetro foi preenchido
TKT.400.001	'birthDate' is not valid	Dados inválidos	Verifique se os dados estão corretos
TKT.400.001	'org' is a required field	Campo obrigatório	Verifique se o parâmetro foi preenchido
TKT.400.001	'subOrg' is a required field	Campo obrigatório	Verifique se o parâmetro foi preenchido
TKT.400.001	'branch' is a required field	Campo obrigatório	Verifique se o parâmetro foi preenchido
TKT.400.001	'operator' is a required field	O operador não foi configurado	Informe a Oiti sobre o motivo do erro pelo nosso Contato
TKT.400.002	Tenant not found	Configuração não encontrada	Informe a Oiti sobre o motivo do erro pelo nosso Contato
TKT.400.003	Ticket closed or invalid	Código inválido	Gere um novo ticket no passo Criar ticket e definição da jornada
TKT.400.004	Ticket expired or inactive	Código expirado	Gere um novo ticket no passo Criar ticket e definição da jornada
TKT.400.005	Requested service is not present in the registered workflow	O serviço não está presente no worflow	Informe a Oiti sobre o motivo do erro pelo nosso Contato
TKT.500.001	An error has occurred getting appkey on facecaptcha: ${error.message}	Ocorreu um erro ao obter um appkey no facecaptcha	Informe a Oiti sobre o motivo do erro pelo nosso Contato
TKT.500.001	An error has occurred generating facecaptcha credentials: ${error.message}	Ocorreu um erro ao gerar as credenciais do facecaptcha	Informe a Oiti sobre o motivo do erro em nosso Contato
TKT.500.004	Error saving ticket ${ticket.id}: ${error.message}	Ocorreu um erro ao salvar o ticket	Informe a Oiti sobre o motivo do erro em nosso Contato

Lista de erros Orchestrator

Code	Message	Descrição	Solução
ORC.400.001	Tenant not found	Configuração não encontrada	Informe a Oiti sobre o motivo do erro pelo nosso Contato
ORC.400.001	Ticket not found for this request	Ticket não encontrado nessa requisição	Informe a Oiti sobre o motivo do erro pelo nosso [Contato](doc:contato
ORC.400.001	'photo' is a required field	Campo obrigatório	Verifique se o parâmetro foi preenchido
ORC.400.001	'correlationId' is a required field	Campo obrigatório	Verifique se o parâmetro foi preenchido
ORC.400.001	'protocol' is a required field	Campo obrigatório	Informe a Oiti sobre o motivo do erro pelo nosso Contato
ORC.400.001	'service' must be one of the following values: BUREAU, SERPRO, LIVENESS	O serviço deve ter os valores: Bureau, Serpro ou Liveness	Informe a Oiti sobre o motivo do erro pelo nosso Contato
ORC.400.001	'service' is a required field	Campo obrigatório	Informe a Oiti sobre o motivo do erro pelo nosso Contato
ORC.400.001	'ticket' is a required field	Campo obrigatório	Verifique se o parâmetro foi preenchido
ORC.400.002	Operator does not have permission to use this ticket	Pessoa usuária não tem permissão para usar esse ticket	Gere um novo ticket no passo Criar ticket e definição da jornada
ORC.400.003	'documentNumber' does not match ticket documentNumber	Número de documento não é o mesmo informado no ticket	Informe um documento válido
ORC.400.004	Inactive profile	Perfil inativo	Gere um novo ticket no passo Criar ticket e definição da jornada
ORC.400.005	Ticket closed or invalid	Ticket encerrado ou inválido	Gere um novo ticket no passo Criar ticket e definição da jornada
ORC.400.006	Ticket is not active or is not a retry	Ticket não está ativo	Gere um novo ticket no passo Criar ticket e definição da jornada
ORC.400.007	Ticket not found for this request	Ticket não encontrado	Informe a Oiti sobre o motivo do erro pelo nosso Contato
ORC.401.003	Workflow not found	Workflow não encontrado	Informe a Oiti sobre o motivo do erro pelo nosso Contato
ORC.401.004	Ticket is not active to execute strategy service	Ticket não está ativo	Gere um novo ticket no passo Criar ticket e definição da jornada

Lista de erros Result

Code	Message	Descrição	Solução
RES.400.001	'org' is a required field	Campo obrigatório	Verifique se o parâmetro foi preenchido
RES.400.001	'subOrg' is a required field	Campo obrigatório	Verifique se o parâmetro foi preenchido
RES.400.001	'branch' is a required field	Campo obrigatório	Verifique se o parâmetro foi preenchido
RES.400.001	'operator' is a required field	Campo obrigatório	Informe a Oiti sobre o motivo do erro pelo nosso Contato
RES.400.002	Tenant not found	Configuração não encontrada	Informe a Oiti sobre o motivo do erro pelo nosso Contato
RES.400.003	Operator does not have permission to use this ticket	Pessoa usuária não tem permissão para usar esse ticket	Gere um novo ticket no passo Criar ticket e definição da jornada
RES.400.004	Image not found	Imagem não encontrada	Verifique se o parâmetro foi preenchido
RES.404.001	Ticket not found for this request	Ticket não encontrado	Gere um novo ticket no passo Criar ticket e definição da jornada
RES.404.002	Result not found	Resultado não encontrado	Informe a Oiti sobre o motivo do erro pelo nosso Contato