Skip to main content
Interactive API Reference: Explore all endpoints with the interactive API playground in the navigation. This page covers API-wide conventions and standards.

​
Base URL

https://api.anycheck.ai
All API requests should be made to this base URL. For authentication details, see Authentication.

​
Error Codes

Codes:
  • INVALID_REQUEST: Invalid request data or malformed input
  • INVALID_ID: Invalid UUID values
  • INVALID_VALUE: Invalid enum values
  • ALREADY_EXISTS: Duplicate resources
Example:
{
  "error_code": "INVALID_REQUEST",
  "message": "Invalid request. Please check input data format and try again",
  "errors": [
    {
      "field": "email",
      "message": "This field is required"
    },
    {
      "field": "password",
      "message": "This field is required"
    }
  ]
}

{
  "error_code": "INVALID_ID",
  "message": "Invalid Verification ID"
}
Codes:
  • UNAUTHORIZED: Missing or invalid authentication
  • INVALID_CREDENTIALS: Wrong email/password combination
  • TOKEN_EXPIRED: JWT access token has expired
  • API_KEY_EXPIRED: API key has expired
  • INVALID_TOKEN: JWT token is malformed or invalid
  • INVALID_API_KEY: API key is invalid or not found
Example:
{
  "error_code": "UNAUTHORIZED",
  "message": "You are not authorized to perform this action"
}
Codes:
  • REQUEST_TIMEOUT: Request processing timed out
Example:
{
  "error_code": "REQUEST_TIMEOUT",
  "message": "Request timed out. Please try again later"
}
Codes:
  • FORBIDDEN: User lacks permissions for the action
Example:
{
  "error_code": "FORBIDDEN",
  "message": "You are forbidden to perform this action"
}
Codes:
  • NOT_FOUND: Resource not found
Example:
{
  "error_code": "NOT_FOUND",
  "message": "Verification not found"
}
Codes:
  • UNAUTHORIZED: Session expired or logged in from another device
Example:
{
  "error_code": "UNAUTHORIZED",
  "message": "Your session has expired or logged in from another device"
}
Codes:
  • INTERNAL_SERVER_ERROR: General server errors
  • VERIFICATION_FAILED: Verification processing errors
Example:
{
  "error_code": "VERIFICATION_FAILED",
  "message": "An error occurred while queueing verification"
}
Codes:
  • SERVICE_UNAVAILABLE: Service temporarily unavailable
Example:
{
  "error_code": "SERVICE_UNAVAILABLE",
  "message": "Verification service is temporarily unavailable: BPKB_VERIFICATION - DKI_JAKARTA"
}

​
Pagination

List endpoints support pagination using the following query parameters: Parameters:
  • page_offset: Number of items to skip (starts at 0, default 0)
  • page_size: Items per page (default 10)
Example: 
GET /folders?page_offset=20&page_size=10
Response: 
{
  "total": 156,
  "items": [
    // Array of results (item 21 - 30)
  ]
}

​
Webhook

Coming Soon: Webhook functionality is currently under development and not yet available. For now, use status polling to check verification completion.
Include webhook configuration in verification requests to receive notifications. 
{
  "service_id": "service-uuid",
  "folder_id": "folder-uuid",
  "configuration": {
    // Service configuration
  },
  "webhook_url": "https://your-app.com/webhook",
  "webhook_metadata": {
    "customer_id": "cust-123",
    "request_id": "req-456"
  }
}
Your endpoint will receive POST requests with job results. 
{
  "verification_id": "verification-uuid",
  "execution_time": 2.28439,
  "status": "COMPLETED",
  "start_date": "2025-10-14T20:12:56.102166+07:00",
  "end_date": "2025-10-14T20:12:58.386556+07:00",
  "metadata": {
    "customer_id": "cust-123",
    "request_id": "req-456"
  },
  "output": {
    "face_match_confidence_level": "LOW",
    "face_match_confidence_score": 2.284846674563825,
    "is_match_face": false
  },
  "output_file_url": "https://example.com/output.json",
  "output_status": "NOT_VERIFIED"
}

​
Support

Need help with AnyCheck?

Email Support

Our team is ready to help you get started

WhatsApp Support

Get instant help via WhatsApp