Códigos de retorno

Os códigos e mensagens listadas a seguir, são enviados nos campos code e message do objeto status no corpo da requisição retornada para cada chamada, assim como no exemplo abaixo:

{
    "status": {
      "code": 3000,
      "message": "Success",
    	"details": ""
    },
    "data": {
    	"balance": 1000
    }
}

Para os casos onde o código e mensagem de retorno forem relacionados a um erro, o objeto data será retornado vazio, e informações específicas sobre o problema poderão ser retornadas no campo details do objeto status, como no exemplo abaixo:

{
    "status": {
        "code": 3001,
        "message": "Authorization error",
        "details": "Authorization header missing"
    },
    "data": { }
}

Geral

Os códigos de 1000 a 1999 são de natureza geral.

Status HTTP	Código	Mensagem	Descrição
200	1000	Success	A requisição foi processada com sucesso.
500	1999	Internal error	Erro interno. Entre em contato com o suporte.

Autenticação

Os códigos de 2000 a 2999 são relacionados aos recursos de autenticação.

Status HTTP	Código	Mensagem	Descrição
200	2000	Success	A requisição ao recurso de autenticação foi processada com sucesso.
400	2001	Username or password not provided	Os campos `username` ou `password` não foram enviados.
401	2002	Username or password not valid	Os campos `username` ou `password` não são válidos.
403	2003	User blocked	O usuário está bloqueado. Entre em contato com o suporte.
403	2004	User not verified	O usuário não é verificado. Complete a verificação antes de prosseguir.
400	2005	Access token expiration must be an integer between 1 and 87600	O campo `expires_in` deve ser um número inteiro entre 1 e 87600 (horas).
500	2999	Internal error	Erro interno no recurso de autenticação. Entre em contato com o suporte.

Créditos

Os códigos de 3000 a 3999 são relacionados aos recursos de créditos.

Status HTTP	Código	Mensagem	Descrição
200	3000	Success	A requisição ao recurso de créditos foi processada com sucesso.
401	3001	Authorization error	Erro na autorização da requisição ao recurso de créditos.
400	3002	Invalid parameter	Parâmetros da requisição ao recurso de créditos inválidos.
500	3999	Internal error	Erro interno no recurso de créditos. Entre em contato com o suporte.

Consultas

Os códigos de 4000 a 4999 são relacionados aos recursos de consultas.

Status HTTP	Código	Mensagem	Descrição
200	4000	Success	A requisição ao recurso de consultas foi processada com sucesso.
401	4001	Authorization error	Erro na autorização da requisição ao recurso de consultas.
400	4002	Invalid parameter	Parâmetros da requisição ao recurso de consultas inválidos.
403	4003	Not enough credits	O saldo de créditos é insuficiente para completar a consulta.
403	4004	Query blocked	Consulta bloqueada por motivos legais.
400	4005	Date of birth validation error	Erro na validação da data de nascimento da pessoa consultada.
500	4999	Internal error	Erro interno no recurso de consultas. Entre em contato com o suporte.