Skip to main content
GET
/
verifications
List Verifications
curl --request GET \
  --url https://clear-api.nfigate.com/api/v1/verifications \
  --header 'X-API-Key: <api-key>'
{
  "success": true,
  "data": {
    "verifications": [
      {
        "id": "<string>",
        "subjectReference": "<string>",
        "requestedAt": "2023-11-07T05:31:56Z",
        "resolvedAt": "2023-11-07T05:31:56Z",
        "currentStep": 123,
        "verificationUrl": "<string>",
        "submittedData": {}
      }
    ],
    "pagination": {
      "page": 123,
      "limit": 123,
      "totalCount": 123,
      "totalPages": 123,
      "hasMore": true
    }
  }
}

​
List Verifications

Retrieve a list of all your verifications with optional filtering and pagination.

​
Request

​
Query Parameters

ParameterTypeRequiredDescription
statusstringNoFilter by status: pending, submitted, action_needed, approved, rejected
typestringNoFilter by type: kyc, kyb
subjectReferencestringNoSearch by subject reference
pagenumberNoPage number (default: 1)
limitnumberNoItems per page (default: 20, max: 100)

​
Response

{
  "success": true,
  "data": {
    "verifications": [
      {
        "id": "abc123def456",
        "type": "kyc",
        "subjectReference": "user-12345",
        "status": "pending",
        "requestedAt": "2024-01-15T10:30:00.000Z",
        "currentStep": 2,
        "verificationUrl": "https://app.nfi-clear.com/verify/abc123def456"
      }
    ],
    "pagination": {
      "page": 1,
      "limit": 20,
      "totalCount": 150,
      "totalPages": 8,
      "hasMore": true
    }
  }
}

​
Example

​
cURL

curl 'https://clear-api.nfigate.com/api/v1/verifications?status=pending&type=kyc&page=1&limit=20' \
  -H 'X-API-Key: nfi_your_api_key_here'

​
JavaScript

const response = await fetch(
  'https://clear-api.nfigate.com/api/v1/verifications?status=pending&page=1',
  {
    headers: { 'X-API-Key': 'nfi_your_api_key_here' }
  }
);

const data = await response.json();
console.log(`Found ${data.data.pagination.totalCount} verifications`);

​
Filter Examples

# Pending KYC verifications
curl 'https://clear-api.nfigate.com/api/v1/verifications?status=pending&type=kyc' \
  -H 'X-API-Key: nfi_your_api_key_here'

# Search by reference
curl 'https://clear-api.nfigate.com/api/v1/verifications?subjectReference=user-123' \
  -H 'X-API-Key: nfi_your_api_key_here'

# Paginated results
curl 'https://clear-api.nfigate.com/api/v1/verifications?page=2&limit=50' \
  -H 'X-API-Key: nfi_your_api_key_here'

Authorizations

​
X-API-Key
string
header
required

Your API key from the dashboard

Query Parameters

​
status
enum<string>

Filter by status

Available options:
pending,
submitted,
action_needed,
approved,
rejected
​
type
enum<string>

Filter by type

Available options:
kyc,
kyb
​
subjectReference
string

Search by subject reference

​
page
integer
default:1

Page number

​
limit
integer
default:20

Items per page

Required range: x <= 100

Response

List of verifications

​
success
boolean
​
data
object