List checks | Verifa

curl https://devapi.withverifa.com/api/v1/checks \
     -H "X-API-Key: <apiKey>"

{
  "data": [
    {
      "id": "schk_abc123",
      "check_type": "sanction",
      "status": "pending",
      "has_match": true,
      "hit_count": 1,
      "provider": "string",
      "session_id": "string",
      "identity_id": "string",
      "external_ref": "string",
      "monitoring_enabled": true,
      "is_sandbox": true,
      "tags": [
        "string"
      ],
      "batch_id": "string",
      "pep_risk_tier": "tier_1",
      "pep_recommended_action": "string",
      "redacted_at": "2024-01-15T09:30:00Z",
      "last_checked_at": "2024-01-15T09:30:00Z",
      "created_at": "2024-01-15T09:30:00Z",
      "expires_at": "2024-01-15T09:30:00Z",
      "result": {},
      "hits": [
        {
          "id": "string",
          "created_at": "2024-01-15T09:30:00Z",
          "matched_name": "string",
          "name_similarity": 1.1,
          "dob_match": true,
          "combined_score": 1.1,
          "hit_source": "string",
          "hit_type": "string",
          "provider_ref": "string",
          "deceased": true,
          "is_false_positive": true,
          "pep_details": {
            "sources": [
              "string"
            ],
            "positions": [
              {
                "title": "string",
                "country": "string",
                "from": "string",
                "to": "string"
              }
            ],
            "associates": [
              {
                "name": "string",
                "relationship": "string"
              }
            ],
            "pep_class": "string"
          },
          "sanction_details": {
            "sources": [
              "string"
            ],
            "list_name": "string",
            "program": "string",
            "listed_on": "string"
          },
          "adverse_media_details": {
            "sources": [
              {
                "name": "string",
                "url": "string",
                "date": "string"
              }
            ]
          }
        }
      ]
    }
  ],
  "pagination": {
    "total": 1,
    "limit": 1,
    "offset": 1
  }
}

Returns a paginated list of checks for your organization.

Authentication

X-API-Keystring

Organization API key. Keys are prefixed with vk_live_ (production) or vk_sandbox_ (sandbox).

Query parameters

check_typeenumOptional

Filter by check type.

statusenumOptional

Filter by status.

Allowed values:

has_matchbooleanOptional

Filter by whether the check has matches.

identity_idstringOptional

Filter by identity ID.

session_idstringOptional

Filter by session ID.

batch_idstringOptional

Filter by batch ID.

tagstringOptional

Filter by tag.

limitintegerOptional1-100Defaults to 50

offsetintegerOptional>=0Defaults to 0

Response

A list of checks.

datalist of objects

paginationobject

Errors

401

Unauthorized Error

Authentication

Headers

Query parameters

Response

Errors