API Documentation
Banking Platform API Overview
The Banking Platform API provides financial institutions with a secure and standardized way to connect with GHI's funding platform. This documentation offers a comprehensive guide to implementing and using the API.
Authentication
API Key Authentication: All API requests require authentication using an API key issued by GHI.
// Example API key header
Authorization: Bearer your_api_key_here
API keys should be kept secure and never exposed in client-side code.
Base URL
All API requests should be made to:
https://api.ghi1bank.com/v1/
Endpoints
Account Information
GET /account
Retrieves information about the authenticated financial institution's account.
Sample response:
{
"account_id": "fi_12345",
"name": "First Community Bank",
"status": "active",
"integration_date": "2023-05-15",
"compliance_level": "full",
"available_funds": 5000000
}
Projects
GET /projects
Lists available projects for funding.
Sample response:
{
"projects": [
{
"id": "proj_789",
"name": "Community Health Center",
"location": "Navajo Nation, AZ",
"funding_needed": 2500000,
"funding_received": 1200000,
"status": "active",
"description": "Construction of a community health center...",
"impact_metrics": {
"people_served": 5000,
"jobs_created": 35,
"community_support": "high"
}
}
],
"pagination": {"total": 42, "page": 1, "per_page": 10}
}
Transactions
POST /transactions
Initiates a funding transaction to a specific project.
Request body:
{
"project_id": "proj_789",
"amount": 500000,
"reference": "Q2-2023-Community-Fund",
"notes": "Initial funding for health center construction"
}
Sample response:
{
"transaction_id": "txn_456789",
"status": "pending",
"timestamp": "2023-06-12T14:30:45Z",
"estimated_completion": "2023-06-12T14:35:45Z"
}
Reports
GET /reports
Generates customizable reports for compliance and impact assessment.
Request parameters:
{
"report_type": "funding_impact",
"date_range": {"start": "2023-01-01", "end": "2023-06-30"},
"format": "pdf"
}
Sample response:
{
"report_id": "rep_12345",
"status": "generating",
"estimated_completion": "2023-07-01T09:15:00Z",
"download_url": null
}
Error Handling
The API uses standard HTTP status codes to indicate the success or failure of requests. Detailed error messages are provided in the response body to assist with troubleshooting.
Sample error response:
{
"error": {
"code": "insufficient_funds",
"message": "The requested transaction amount exceeds available funds",
"details": {"available": 300000, "requested": 500000}
}
}
UN DRIP Compliance Verification
GET /compliance/undrip
Retrieves detailed UN DRIP compliance information for the institution or project.
Sample response:
{
"compliance_status": "verified",
"verification_date": "2023-05-20T10:15:33Z",
"articles": {
"3_4": {"status": "compliant", "description": "Self-determination and autonomy for indigenous peoples"},
"5_18": {"status": "compliant", "description": "Distinct institutions and participation in decision-making"},
"19": {"status": "compliant", "description": "Free, prior and informed consent"},
"23_32": {"status": "compliant", "description": "Development priorities and control over lands and resources"},
"39_40_41": {"status": "compliant", "description": "Access to financial assistance, fair conflict resolution, and UN system support"}
},
"certification_level": "gold",
"next_review_date": "2024-05-20"
}
Rate Limits
To ensure system stability and fair usage, the API enforces rate limits of 100 requests per minute per API key. Exceeding this limit will result in HTTP 429 (Too Many Requests) responses.
Webhooks
The API supports webhooks for asynchronous notification of important events:
- Transaction status changes
- Compliance alerts
- Project updates
- Report completion notifications
Configure webhook endpoints in your account settings dashboard.
SDK Support
GHI provides official client libraries for easy integration:
- JavaScript/Node.js
- Python
- Java
- C#/.NET
- Ruby
Support
For technical assistance with API integration, please contact our developer support team through the Contact Us page or developer portal.