Introduction to GridLogs API
GridLogs is an AI-powered KYB (Know Your Business) and AML (Anti-Money Laundering) analysis platform providing comprehensive risk assessment and verification services. Our API allows you to integrate GridLogs’ powerful verification capabilities into your own systems.
Key Features
- Business Verification (KYB): Verify business details, ownership structures, and documents
- Individual Verification (KYC): Verify identities and background checks for individuals
- Document Analysis: Extract and verify information from identity documents, certificates, and more
- Risk Assessment: Assess risk through sanctions screening, adverse media checks, and enhanced due diligence
- Task Management: Create and manage compliance tasks and workflows
- Document Management: Upload, store, and manage verification documents securely
API Structure
Our API is organized into several categories:
Core Resources
- Business Cases: Manage business verification cases
- Consumer Cases: Manage individual verification cases
- Tasks: Create and track verification tasks
- Notes: Add and retrieve notes on verification cases
- Documents: Manage document metadata records
Services
- Document Analysis: Extract and analyze information from documents
- Uploads: Upload, manage, and retrieve verification documents
Getting Started
To use the GridLogs API, you’ll need to:
- Obtain an API key (contact us at support@gridlogs.co)
- Add your API key to requests using the
X-API-Key
header
- Start making API calls to our endpoints
Base URL
All API requests should be made to:
https://api.gridlogs.co/v1
Example Request
Here’s a simple example of retrieving a list of business cases:
curl -X GET https://api.gridlogs.co/v1/business-cases \
-H "X-API-Key: your_api_key_here"
All API responses are returned in JSON format and include standardized fields such as success
to indicate whether the request was successful.
Example response:
{
"success": true,
"items": [
{
"id": "bc_12345",
"legalName": "Acme Corporation",
"dbaName": "Acme Inc",
"websiteUrl": "https://www.acmecorp.com",
"riskScore": 35,
"recommendation": "LOW",
"createdAt": "2023-01-15T10:30:00Z",
"updatedAt": "2023-01-15T10:30:00Z"
},
// More business cases...
],
"meta": {
"total": 25,
"page": 1,
"limit": 10,
"totalPages": 3
}
}
Error Handling
When an error occurs, the API will return an appropriate HTTP status code along with a JSON response containing information about the error.
Example error response:
{
"statusCode": 400,
"message": "Invalid input data",
"error": "Bad Request"
}
Next Steps
Explore our API documentation to learn more about specific endpoints and how to use them.
Responses are generated using AI and may contain mistakes.