Get All Screenings
Comprehensive search method for existing screening records in the database with advanced query capabilities.
/v1/kyc/screeningAuthorization
bearerAuth JWT token obtained from authentication endpoint. Include the token in the Authorization header as 'Bearer {{user_token}}'
In: header
Query Parameters
Search by entity type (exact match)
Search by entity name (pattern match)
Search by match count greater than
Search by highest score greater than or equal to
Search by screening date after
Search by status in list (comma-separated)
Search by has matches boolean
Number of results to return (default: 50, max: 1000)
Number of results to skip
Sort fields (comma-separated, prefix with - for descending)
Stack results by field (with optional format)
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/v1/kyc/screening?search.entity_type=individual&search.entity_name.like=John&search.match_count.gt=0&search.highest_score.gte=0.8&search.screening_date.gt=2024-01-01T00%3A00%3A00Z&search.status.in=completed%2Cpending&search.has_matches=true&sort=-screening_date%2Centity_name&stack=entity_type"{
"results": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"entity_type": "individual",
"entity_name": "John Doe",
"status": "completed",
"screening_date": "2024-09-03T10:30:00Z",
"match_count": 2,
"highest_score": 0.85,
"has_matches": true
}
],
"total": 1,
"limit": 50,
"offset": 0
}{
"status": 400,
"message": "Invalid request parameters"
}{
"status": 401,
"message": "Authentication required"
}{
"status": 403,
"message": "Insufficient permissions"
}{
"status": 500,
"message": "Internal server error"
}