Kycv1Screening Management
Get Screening by ID
Retrieve an existing screening record from the database by ID.
GET
/v1/kyc/screening/{id}Authorization
bearerAuth AuthorizationBearer <token>
JWT token obtained from authentication endpoint. Include the token in the Authorization header as 'Bearer {{user_token}}'
In: header
Path Parameters
id*string
Screening ID
Query Parameters
include_matches?string
Include detailed match results (case-insensitive, accepts 'true', 'TRUE', 'True', etc.)
include_response?string
Include full KYC provider API response (case-insensitive, accepts 'true', 'TRUE', 'True', etc.)
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/v1/kyc/screening/497f6eca-6276-4993-bfeb-53cbbbba6f08"{
"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": 401,
"message": "Authentication required"
}{
"status": 403,
"message": "Insufficient permissions"
}{
"status": 404,
"message": "Screening record not found"
}{
"status": 500,
"message": "Internal server error"
}