Screen Entity

Universal screening method with db-first check strategy. Checks database for existing results first, then performs new screening if needed. Use force=true to bypass cache and force new screening.

POST/v1/kyc/screening

Authorization

bearerAuth

AuthorizationBearer <token>

JWT token obtained from authentication endpoint. Include the token in the Authorization header as 'Bearer {{user_token}}'

In: header

Query Parameters

force?string

Force new screening, bypassing database cache (case-insensitive, accepts 'true', 'TRUE', 'True', etc.)

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

entity_type*string

Type of entity being screened

entity_id?string

Optional reference to existing entity

individual?

Individual entity data (required when entity_type is 'individual')

company?

Company entity data (required when entity_type is 'company')

screening_types*array<>

Types of screening to perform

case_id?string

Optional UUID of the case this screening belongs to

metadata?

Additional metadata

Response Body

`application/json`

curl -X POST "https://example.com/v1/kyc/screening" \  -H "Content-Type: application/json" \  -d '{    "entity_type": "customers",    "entity_id": "5e5620ad-241f-4779-bf07-bf81d010b340",    "individual": {      "first_name": "John",      "last_name": "Doe",      "date_of_birth": "1980-01-01",      "nationality": "US"    },    "screening_types": [      "sanctions",      "peps"    ],    "metadata": {      "source": "customer_onboarding",      "customer_id": "123e4567-e89b-12d3-a456-426614174000"    }  }'

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "entity_type": "individual",
  "entity_id": "8161163a-f227-466f-bc01-090a01e80165",
  "entity_name": "string",
  "entity_schema": "string",
  "collection": "string",
  "status": "pending",
  "screening_date": "2019-08-24T14:15:22Z",
  "match_count": 0,
  "highest_score": 0,
  "has_matches": true,
  "assigned_to": "b9f52997-ff03-4166-bbff-22fd35e12939",
  "assigned_at": "2019-08-24T14:15:22Z",
  "case_id": "c74269e5-1f97-4e20-9164-ffbe3494d8d6",
  "matches": [
    {
      "id": "string",
      "caption": "string",
      "schema": "string",
      "score": 0,
      "match": true,
      "target": true,
      "datasets": [
        "string"
      ]
    }
  ],
  "metadata": {},
  "response": {}
}

{
  "status": 400,
  "message": "Invalid request parameters"
}

{
  "status": 401,
  "message": "Authentication required"
}

{
  "status": 403,
  "message": "Insufficient permissions"
}

{
  "status": 500,
  "message": "Internal server error"
}

Screen Entity

Authorization

Query Parameters

Request Body

Response Body

201application/json

400application/json

401application/json

403application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`