API Documentation
Integrate Land Registry into your applications
Get API Key
Generate your API key from the dashboard settings.
Authenticate
Include your API key in the Authorization header.
Make Requests
Start verifying land titles programmatically.
Authentication
POST
/api/auth/signupCreate a new user account
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| string | Required | User email address | |
| password | string | Required | User password (min 8 chars) |
| full_name | string | Required | Full name of the user |
Response Example
{
"user": {
"id": "uuid",
"email": "user@example.com",
"created_at": "2024-01-01T00:00:00Z"
},
"session": {
"access_token": "eyJ...",
"refresh_token": "..."
}
}POST
/api/auth/signinSign in to existing account
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| string | Required | User email address | |
| password | string | Required | User password |
POST
/api/auth/signoutAuth Required
Sign out current user
Land Claims
GET
/api/claimsAuth Required
List all claims for authenticated user
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| status | string | Optional | Filter by status (PENDING, VERIFIED, DISPUTED) |
| limit | number | Optional | Number of results (default: 20) |
| offset | number | Optional | Pagination offset |
Response Example
{
"claims": [
{
"id": "uuid",
"parcel_id": "GH-ACC-001234",
"status": "VERIFIED",
"ai_confidence_score": 0.94,
"created_at": "2024-01-01T00:00:00Z"
}
],
"total": 42,
"limit": 20,
"offset": 0
}POST
/api/claimsAuth Required
Submit a new land claim for verification
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| document_url | string | Required | URL of uploaded document |
| latitude | number | Required | GPS latitude coordinate |
| longitude | number | Required | GPS longitude coordinate |
| land_size_sqm | number | Optional | Land size in square meters |
| address | string | Optional | Property address |
GET
/api/claims/:idAuth Required
Get details of a specific claim
GET
/api/claims/:id/verificationAuth Required
Get AI verification results for a claim
Response Example
{
"claim_id": "uuid",
"status": "VERIFIED",
"confidence_score": 0.94,
"agents": [
{
"name": "DocumentAnalysisAgent",
"score": 0.96,
"findings": ["Valid deed format", "Signatures verified"]
},
{
"name": "SatelliteVerificationAgent",
"score": 0.92,
"findings": ["Boundaries match satellite imagery"]
}
],
"verified_at": "2024-01-01T00:05:00Z"
}Blockchain
POST
/api/blockchain/mintAuth Required
Mint an NFT for a verified claim
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| claim_id | string | Required | ID of the verified claim |
| wallet_address | string | Required | Recipient wallet address |
Response Example
{
"transaction_hash": "0x...",
"token_id": "12345",
"contract_address": "0x...",
"explorer_url": "https://polygonscan.com/tx/0x..."
}GET
/api/blockchain/verify/:tokenIdVerify authenticity of a land title NFT
Credits
GET
/api/credits/balanceAuth Required
Get current credit balance
Response Example
{
"balance": 15,
"plan": "PROFESSIONAL",
"monthly_allocation": 100,
"used_this_month": 85
}POST
/api/credits/purchaseAuth Required
Purchase additional credits
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| amount | number | Required | Number of credits to purchase |
| payment_method | string | Required | Payment method ID |
Quick Start Example
Submit a land claim using cURL
curl -X POST https://api.landregistry.africa/v1/claims \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"document_url": "https://storage.example.com/deed.pdf",
"latitude": 5.6037,
"longitude": -0.1870,
"land_size_sqm": 500,
"address": "123 Independence Ave, Accra"
}'Rate Limits
100
Requests per minute (Starter)
500
Requests per minute (Professional)
Unlimited
Requests per minute (Enterprise)