📚 Documentação da API
Guia completo para integração com o sistema de verificação
Começando
O AgeCheck é uma API RESTful para verificação de identidade que permite validar documentos, selfies e realizar prova de vida.
🔑 Autenticação
Todas as requisições devem incluir sua API Key no header:
X-API-Key: sk_live_sua_chave_aqui
🌐 URL Base
https://ferramentasdaweb.com.br/db/agecheck/public/api
📦 Formato das Respostas
Todas as respostas são em JSON:
{
"status": "success",
"data": { ... },
"message": "Operação realizada com sucesso"
}
Dica: Utilize o ambiente de desenvolvimento (sk_test_) para testes antes de usar em produção.
Endpoints Disponíveis
POST
/verify/request
Inicia um novo processo de verificação. Retorna um token único para acompanhamento.
Parâmetros:
callback_url(opcional) - URL para receber notificações do resultadowebhook(opcional) - Se deve enviar webhook ao finalizar
Resposta:
{
"status": "success",
"token": "tok_4f3a2b1c8e7d6c5b",
"verification_url": "https://ferramentasdaweb.com.br/verify/tok_4f3a2b1c8e7d6c5b",
"expires_in": 1800
}
GET
/verify/status/{token}
Consulta o status de uma verificação pelo token.
Resposta:
{
"status": "approved",
"token": "tok_4f3a2b1c8e7d6c5b",
"verified_at": "2024-04-01 10:30:25",
"data": {
"document_type": "RG",
"name": "João Silva",
"birth_date": "1990-01-15"
}
}
POST
/verify/process
Envia os documentos para processamento.
Parâmetros (multipart/form-data):
token- Token da verificaçãodocument- Imagem do documento (RG/CNH)selfie- Foto do usuáriodocument_type- Tipo: 'rg', 'cnh', 'passport'
Exemplos de Integração
<?php
$apiKey = 'sk_live_sua_chave_aqui';
$apiUrl = 'https://ferramentasdaweb.com.br/db/agecheck/public/api';
// Iniciar verificação
$ch = curl_init($apiUrl . '/verify/request');
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
'X-API-Key: ' . $apiKey,
'Content-Type: application/json'
]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
$data = json_decode($response, true);
$token = $data['token'];
echo "Token: " . $token;
// Consultar status
$ch = curl_init($apiUrl . '/verify/status/' . $token);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['X-API-Key: ' . $apiKey]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$status = curl_exec($ch);
print_r(json_decode($status, true));
?>
Códigos de Erro
| Código | Mensagem | Descrição |
|---|---|---|
| 401 | Unauthorized | API Key inválida ou não fornecida |
| 404 | Not Found | Token ou endpoint não encontrado |
| 400 | Bad Request | Parâmetros inválidos ou faltando |
| 408 | Request Timeout | Token expirado |
| 429 | Too Many Requests | Limite de requisições excedido |
| 500 | Internal Server Error | Erro interno no servidor |
📞 Precisa de ajuda?
Entre em contato pelo Suporte ou envie um e-mail para suporte@ferramentasdaweb.com.br