Skip to content
On this page

API Reference

Base URL: https://api.aegis-dig.com

Request Format

All requests must include:

  • Authorization: Bearer {api_key} header
  • Content-Type: application/json for POST requests

Response Format

json
{
  "request_id": "req_abc123",
  "data": {},
  "meta": {
    "latency_ms": 42,
    "quota_remaining": 9850
  }
}

Error Format

json
{
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "CPF number is invalid",
    "details": [{ "field": "cpf", "message": "Checksum mismatch" }],
    "request_id": "req_xyz789"
  }
}

Error Codes

CodeHTTPDescription
UNAUTHORIZED401Invalid API key
FORBIDDEN403Insufficient permissions
NOT_FOUND404Resource not found
VALIDATION_ERROR422Invalid request body
RATE_LIMITED429Too many requests
INTERNAL_ERROR500Server error

Rate Limits

Planreq/minreq/day
Starter6010,000
Growth600100,000
EnterpriseCustomUnlimited

Available Endpoints

EndpointMethodDescription
/v1/verify/cpfPOSTValidate CPF number
/v1/verify/cnpjPOSTValidate CNPJ number
/v1/credit/scorePOSTGet credit score
/v1/fraud/checkPOSTAnti-fraud check
/v1/ocr/documentPOSTDocument OCR
/v1/consentPOSTLGPD consent

Released under the MIT License.