API Reference

Complete API documentation for integrating UAVP into your applications

Getting Started with the API

Basic information for API integration

Base URL

https://api.myuavp.com/v1

Authentication

All API requests require authentication using Bearer tokens obtained from your dashboard:

Authorization: Bearer YOUR_API_KEY

Rate Limits

• 100 requests per minute for search endpoints
• 50 requests per minute for verification endpoints
• 10 requests per minute for certificate downloads

Response Format

All API responses follow this structure:

{
  "success": true,
  "data": { /* response data */ },
  "pagination": { /* pagination info */ }
}

Available Endpoints

GET

/api/v1/properties/search

Search and filter verified properties

Parameters

querystringSearch term for address or property code

limitnumberMaximum number of results (default: 50)

offsetnumberPagination offset (default: 0)

typestringProperty type filter

citystringCity filter

statestringState filter

Example Request

GET /api/v1/properties/search?query=Lagos&type=RESIDENTIAL&limit=10

POST

/api/v1/tenants/link-request

Request tenancy link to a property

Parameters

propertyIdstringRequiredID of the property to link to

tenantInfoobjectTenant information and documents

Example Request

POST /api/v1/tenants/link-request
{
  "propertyId": "prop_12345",
  "tenantInfo": {
    "name": "John Doe",
    "email": "[email protected]"
  }
}

GET

/api/v1/certificates/{id}

Download verification certificate

Parameters

idstringRequiredCertificate ID

formatstringDownload format (pdf, json)

Example Request

GET /api/v1/certificates/cert_12345?format=pdf

POST

/api/v1/verification/upload

Upload verification documents

Parameters

documentTypestringRequiredType of document (NIN, BVN, etc.)

filefileRequiredDocument file to upload

metadataobjectAdditional document metadata

Example Request

POST /api/v1/verification/upload
Content-Type: multipart/form-data
FormData:
  documentType: NIN
  file: [file]
  metadata: {"description": "National ID"}

GET

/api/v1/verification/status

Check verification status

Parameters

requestIdstringVerification request ID

Example Request

GET /api/v1/verification/status?requestId=req_12345

Response Examples

Sample responses for common API calls

Property Search Response

{
  "data": [
    {
      "id": "prop_12345",
      "propertyCode": "UAVP-001",
      "street": "123 Main Street",
      "city": "Lagos",
      "state": "Lagos",
      "type": "RESIDENTIAL",
      "verificationStatus": "VERIFIED",
      "coordinates": {
        "latitude": 6.5244,
        "longitude": 3.3792
      }
    }
  ],
  "pagination": {
    "total": 150,
    "limit": 50,
    "offset": 0
  }
}

Error Response

{
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid property ID",
    "details": {
      "field": "propertyId",
      "reason": "Property not found"
    }
  }
}

Error Handling

Common error codes and how to handle them

VALIDATION_ERROR

Invalid input parameters

Check parameter types and required fields

UNAUTHORIZED

Invalid or missing API key

Verify your API key and authorization header

RATE_LIMITED

Too many requests

Wait before retrying or upgrade your plan

NOT_FOUND

Resource not found

Check IDs and endpoint URLs

VERIFICATION_PENDING

Verification in progress

Check back later or contact support

SERVICE_UNAVAILABLE

Temporary service issue

Retry with exponential backoff

SDKs and Libraries

Official and community-supported libraries for easier integration

JavaScript/Node.js

npm install uavp-sdk

Official SDK with TypeScript support and automatic retries

Python

pip install uavp-python

Python client with async support and comprehensive error handling

PHP

composer require uavp/php-sdk

PHP SDK with Laravel integration and webhook verification

Go

go get github.com/uavp/go-sdk

Go client with context support and structured logging