Skip to main content
GET
/
verifications
/
{id}
Get Verification
curl --request GET \
  --url https://clear-api.nfigate.com/api/v1/verifications/{id} \
  --header 'X-API-Key: <api-key>'
{
  "success": true,
  "data": {
    "id": "<string>",
    "subjectReference": "<string>",
    "requestedAt": "2023-11-07T05:31:56Z",
    "resolvedAt": "2023-11-07T05:31:56Z",
    "currentStep": 123,
    "verificationUrl": "<string>",
    "submittedData": {}
  },
  "message": "<string>"
}

​
Get Verification

Retrieve the current status and basic information about a specific verification.

​
Request

​
Path Parameters

ParameterTypeRequiredDescription
idstringYesThe verification ID

​
Response

{
  "success": true,
  "data": {
    "id": "abc123def456",
    "type": "kyc",
    "subjectReference": "user-12345",
    "status": "submitted",
    "requestedAt": "2024-01-15T10:30:00.000Z",
    "resolvedAt": null,
    "currentStep": 4,
    "verificationUrl": "https://app.nfi-clear.com/verify/abc123def456",
    "submittedData": {
      "residenceCountry": "Singapore",
      "documentType": "passport"
    }
  }
}

​
Status Values

StatusDescription
pendingVerification created, user hasn’t started
submittedUser completed, pending review
action_neededReviewer requested corrections
approvedVerification approved
rejectedVerification rejected

​
Example

​
cURL

curl 'https://clear-api.nfigate.com/api/v1/verifications/abc123def456' \
  -H 'X-API-Key: nfi_your_api_key_here'

​
JavaScript

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

const data = await response.json();
console.log('Status:', data.data.status);

​
Error Responses

StatusCodeDescription
404VERIFICATION_NOT_FOUNDVerification ID not found

Authorizations

​
X-API-Key
string
header
required

Your API key from the dashboard

Path Parameters

​
id
string
required

Verification ID

Response

Verification details

​
success
boolean
​
data
object
​
message
string