Documentation Index

Fetch the complete documentation index at: https://docs.hawk.ai/llms.txt

Use this file to discover all available pages before exploring further.

Get customer case

Prev Next
Get
/v2/customer-checks/{caseId}

Retrieves Hawk-generated customer case statistics by internal case ID. Returns customer risk rating, flagging results, and screening data.

Security
API Key: API_KEY
Header parameter nameapi-key
Path parameters
caseId
string (uuid) Required

Internal Hawk case ID

Responses
200

Customer case found with all data sources available

Expand All
object
caseId
string (uuid)

Internal Hawk case ID

Example5f8a3b2c-1d4e-4f5a-9b6c-7d8e9f0a1b2c
correlationId
string (uuid)

Correlation ID linking this case to the original request

tenantId
string (uuid)

Tenant identifier

customerId
string

Customer identifier associated with this case

accountId
string

Account identifier associated with this case

createdAt
string (date-time)

Timestamp when processing of the case completed (ISO 8601 UTC)

caseStatus
string

Current lifecycle status of the case. One of: OPEN, NOT_OPENED, AUTO_CLOSED

ExampleOPEN
processingStatus
string

Current processing status of the case. One of: new, unsuspicious, relieved, unsubstantiated, opening, machine-review, operator-review, accepted, escalated, sar-filing, sar-filed, reopening, reopened

assignedTo
string

ID of the user the case is assigned to

apiType
string

Type of check that created this case (AMLChecks or CustomerChecks)

ExampleCustomerChecks
sourceTags
Array of string

Source tags applied to this case

string
tenantCategory
string

Category assigned to the tenant

crrStatistics
object (CrrStatistics)

Customer Risk Rating statistics

customerEmail
Array of string

Email addresses of the customer

string
customerName
string

Name of the customer

customerStatus
string

Customer status. One of: proceeded, blocked

customerType
string

Type of customer

riskLevel
string

Risk level assigned to the customer

totalPoints
integer (int32)

Total risk points scored

riskFactors
Array of string

Risk factors identified

string
flaggingResults
Array of object (FlaggingResult)

Flagging results from risk assessment

object
countriesMatched
Array of string

Countries that matched this flag

string
flag
string

Flag identifier

screeningResults
Array of object (ScreeningResult)

Screening hits

object

A single screening hit, object-wrapped (mirrors the callback contract) so it can carry additional fields in future.

type
string

Screening hit type. One of: POLITICALLY_EXPOSED_PERSON, SPECIAL_INTEREST_ENTITY, SPECIAL_INTEREST_PERSON, SANCTIONED_ENTITY, SANCTIONED_PERSON, RELATIVE_OR_CLOSE_ASSOCIATE, BLACKLIST_ENTITY, BLACKLIST_PERSON, ADVERSE_MEDIA

ExampleSPECIAL_INTEREST_PERSON
206

Customer case found but some data sources are unavailable — response payload may have missing fields

Expand All
object
caseId
string (uuid)

Internal Hawk case ID

Example5f8a3b2c-1d4e-4f5a-9b6c-7d8e9f0a1b2c
correlationId
string (uuid)

Correlation ID linking this case to the original request

tenantId
string (uuid)

Tenant identifier

customerId
string

Customer identifier associated with this case

accountId
string

Account identifier associated with this case

createdAt
string (date-time)

Timestamp when processing of the case completed (ISO 8601 UTC)

caseStatus
string

Current lifecycle status of the case. One of: OPEN, NOT_OPENED, AUTO_CLOSED

ExampleOPEN
processingStatus
string

Current processing status of the case. One of: new, unsuspicious, relieved, unsubstantiated, opening, machine-review, operator-review, accepted, escalated, sar-filing, sar-filed, reopening, reopened

assignedTo
string

ID of the user the case is assigned to

apiType
string

Type of check that created this case (AMLChecks or CustomerChecks)

ExampleCustomerChecks
sourceTags
Array of string

Source tags applied to this case

string
tenantCategory
string

Category assigned to the tenant

crrStatistics
object (CrrStatistics)

Customer Risk Rating statistics

customerEmail
Array of string

Email addresses of the customer

string
customerName
string

Name of the customer

customerStatus
string

Customer status. One of: proceeded, blocked

customerType
string

Type of customer

riskLevel
string

Risk level assigned to the customer

totalPoints
integer (int32)

Total risk points scored

riskFactors
Array of string

Risk factors identified

string
flaggingResults
Array of object (FlaggingResult)

Flagging results from risk assessment

object
countriesMatched
Array of string

Countries that matched this flag

string
flag
string

Flag identifier

screeningResults
Array of object (ScreeningResult)

Screening hits

object

A single screening hit, object-wrapped (mirrors the callback contract) so it can carry additional fields in future.

type
string

Screening hit type. One of: POLITICALLY_EXPOSED_PERSON, SPECIAL_INTEREST_ENTITY, SPECIAL_INTEREST_PERSON, SANCTIONED_ENTITY, SANCTIONED_PERSON, RELATIVE_OR_CLOSE_ASSOCIATE, BLACKLIST_ENTITY, BLACKLIST_PERSON, ADVERSE_MEDIA

ExampleSPECIAL_INTEREST_PERSON
401

Missing or invalid API key

{
  "errors": [
    "Missing or invalid API key"
  ]
}
object
errors
Array of string

List of error messages

string
404

No customer case exists for the given caseId

{
  "errors": [
    "Customer case not found"
  ]
}
object
errors
Array of string

List of error messages

string
429

Rate limit exceeded

{
  "errors": [
    "Rate limit exceeded"
  ]
}
object
errors
Array of string

List of error messages

string