Respostas

Search…

Respostas

Nossa API REST usa uma estrutura de resposta padronizada, tanto para requisições bem sucedidas quanto para as sem sucesso.
Respostas Bem Sucedidas
Endpoints de Pedidos quando evaluate é 'false'
Código: 200 ou 201
Código de status HTTP: 200 ou 201 *
Resposta JSON:
{
    "message": "mensagem sobre o sucesso"
}
Código de status HTTP será 201 para requisições POST e 200 para requisições PUT.
Respostas de sandbox para os endpoints de coleta
Ao testar sua integração, você deve usar as chaves Sandbox fornecidas. Ao enviar uma requisição POST com uma chave de API Sandbox (por exemplo, criando um pedido), você obterá um código de resposta HTTP 200 ao invés de 201, e uma mensagem que se parece com isso:
{
  "message": "[SANDBOX] Valid request!"
}
Isso indica que a solicitação foi válida. Esses dados da requisição não serão usados pela Legiti para treinar nossos modelos de avaliação.
Endpoint de Pedidos quando evaluate é 'true'
Código: 201
Código de status HTTP: 201
Resposta JSON: {
    "legiti_decision": <one of "approve", "reject", "manual" or "unavailable">,
    "message": "optional field; will be used for the unavailable decision"
}
A decisão manual significa que estamos sugerindo enviar o pedido a uma mesa de análise manual. Isso só será usado se a sua lógica de negócio tiver análise manual como uma etapa do processo de verificação de fraude.
A decisão unavailable só será devolvida no caso de sua empresa estar na fase piloto de sua integração com a Legiti; esta resposta é devolvida para indicar que nosso modelo recebeu e avaliou seu pedido, mas uma decisão ainda não está disponível. (Os resultados da avaliação são armazenados internamente pela Legiti e serão revisados durante a fase piloto.)
Respostas de Erro
JSON inválido recebido na requisição
Código: 400
Código de status HTTP: 400
Resposta JSON: {
    "error_message": "message for the error",
    "error_code": 1
}
Erros de validação no body da requisição
Código: 400
Código de status HTTP: 400
Resposta JSON: {
    "error_message": {
        "nome_do_campo": [
            "mensagem explicando o erro no campo 'nome_do_campo'"
        ]
    },
    "error_code": 2
}
Tipo inválido recebido no corpo da requisição
Código: 400
Código de status HTTP: 400
Resposta JSON: {
    "error_message": "Invalid type in request body - expected a JSON object",
    "error_code": 4
}
Requisição sem payload no body
Código: 400
Código de status HTTP: 400
Resposta JSON: {
    "error_message": "mensagem para o erro",
    "error_code": 5
}
Cabeçalho de autenticação não fornecido
Código: 401
Código de status HTTP: 401
Resposta JSON: {
    "message": "Unauthorized"
}
Não autorizado
Código: 403
Código de status HTTP: 403
Resposta JSON: {
    "Message": "User is not authorized to access this resource with an explicit deny"
}
Erros internos
Código: 503
Código de status HTTP: 503
Resposta JSON: {
    "error_message": "mensagem para o erro",
    "error_code": 3
}

Dados Customizáveis

Next - Backend

Tratamento de Erros

Last modified 2mo ago

Copy link

Outline

Respostas Bem Sucedidas

Endpoints de Pedidos quando evaluate é 'false'

Endpoint de Pedidos quando evaluate é 'true'

Respostas de Erro

JSON inválido recebido na requisição

Erros de validação no body da requisição

Tipo inválido recebido no corpo da requisição

Requisição sem payload no body

Cabeçalho de autenticação não fornecido

Não autorizado

Erros internos