v2
Integração
Backend
Histórico de Atualizações
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
1
Código de status HTTP: 200 ou 201 *
2
Resposta JSON:
3
{
4
"message": "mensagem sobre o sucesso"
5
}
Copied!
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:
1
{
2
"message": "[SANDBOX] Valid request!"
3
}
Copied!
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
1
Código de status HTTP: 201
2
Resposta JSON: {
3
"legiti_decision": <one of "approve", "reject", "manual" or "unavailable">,
4
"message": "optional field; will be used for the unavailable decision"
5
}
Copied!
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
1
Código de status HTTP: 400
2
Resposta JSON: {
3
"error_message": "message for the error",
4
"error_code": 1
5
}
Copied!
Erros de validação no body da requisição
Código: 400
1
Código de status HTTP: 400
2
Resposta JSON: {
3
"error_message": {
4
"nome_do_campo": [
5
"mensagem explicando o erro no campo 'nome_do_campo'"
6
]
7
},
8
"error_code": 2
9
}
Copied!
Tipo inválido recebido no corpo da requisição
Código: 400
1
Código de status HTTP: 400
2
Resposta JSON: {
3
"error_message": "Invalid type in request body - expected a JSON object",
4
"error_code": 4
5
}
Copied!
Requisição sem payload no body
Código: 400
1
Código de status HTTP: 400
2
Resposta JSON: {
3
"error_message": "mensagem para o erro",
4
"error_code": 5
5
}
Copied!
Cabeçalho de autenticação não fornecido
Código: 401
1
Código de status HTTP: 401
2
Resposta JSON: {
3
"message": "Unauthorized"
4
}
Copied!
Não autorizado
Código: 403
1
Código de status HTTP: 403
2
Resposta JSON: {
3
"Message": "User is not authorized to access this resource with an explicit deny"
4
}
Copied!
Erros internos
Código: 503
1
Código de status HTTP: 503
2
Resposta JSON: {
3
"error_message": "mensagem para o erro",
4
"error_code": 3
5
}
Copied!
Last modified 8mo ago
Copy link
Contents
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