Skip to main content

​
API Reference

The NFI Clear API is organized around REST. Our API has predictable resource-oriented URLs, accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

​
Base URL

https://clear-api.nfigate.com/api/v1

​
Content Type

All requests should include the Content-Type: application/json header when sending JSON data.

​
Response Format

All API responses follow a consistent format: 
{
  "success": true,
  "data": { ... },
  "message": "Optional success message"
}

​
Error Response

{
  "success": false,
  "error": "Error description",
  "code": "ERROR_CODE"
}

​
HTTP Status Codes

CodeMeaning
200OK - Request succeeded
201Created - Resource created successfully
400Bad Request - Invalid parameters
401Unauthorized - Invalid or missing API key
403Forbidden - Insufficient permissions
404Not Found - Resource not found
409Conflict - Resource already exists
500Internal Server Error - Server error

​
Endpoints Overview

​
Verifications

MethodEndpointDescription
POST/verificationsCreate verification
GET/verificationsList verifications
GET/verifications/:idGet verification
GET/verifications/:id/detailsGet full details

​
Pagination

List endpoints support pagination using page and limit query parameters: 
curl 'https://clear-api.nfigate.com/api/v1/verifications?page=1&limit=20' \
  -H 'X-API-Key: nfi_your_api_key'

​
Pagination Response

{
  "success": true,
  "data": {
    "verifications": [...],
    "pagination": {
      "page": 1,
      "limit": 20,
      "totalCount": 150,
      "totalPages": 8,
      "hasMore": true
    }
  }
}

​
Filtering

Use query parameters to filter results:
ParameterTypeDescription
statusstringFilter by status: pending, submitted, action_needed, approved, rejected
typestringFilter by type: kyc, kyb
subjectReferencestringSearch by subject reference
sortBystringSort field (default: requestedAt)
sortOrderstringSort order: asc, desc (default: desc)
Example: 
curl 'https://clear-api.nfigate.com/api/v1/verifications?status=pending&type=kyc' \
  -H 'X-API-Key: nfi_your_api_key'

​
Testing

All endpoints include cURL examples. Replace nfi_your_api_key with your actual API key.