Weavr
Powered by Redocly

Hawk

hawk_customer_check_get_history

SecurityAPI_Secret_Key
Request
header Parameters
call-ref
string

A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255

Request Body schema: application/json
required
required
object

The id of the identity.

Responses
200

Success

400

Invalid Request

default

Error

post/hawk/customer_check/get_history
Request samples
application/json
{
  • "identityId": {
    }
}
Response samples
application/json
{
  • "items": [
    ]
}

hawk_customer_check_clear_all

SecurityAPI_Secret_Key
Request
header Parameters
call-ref
string

A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255

Responses
204

Success - No Content

400

Invalid Request

default

Error

post/hawk/customer_check/clear_all
Response samples
application/json
{
  • "message": "string",
  • "validation": {
    }
}

hawk_customer_check_put

SecurityAPI_Secret_Key
Request
header Parameters
call-ref
string

A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255

Request Body schema: application/json
required
required
object

The id of the identity.

riskLevel
required
string
Enum: "LOW" "MEDIUM" "HIGH" "PROHIBITED"
Responses
204

Success - No Content

400

Invalid Request

default

Error

post/hawk/customer_check/put
Request samples
application/json
{
  • "identityId": {
    },
  • "riskLevel": "LOW"
}
Response samples
application/json
{
  • "message": "string",
  • "validation": {
    }
}

hawk_customer_check_clear

SecurityAPI_Secret_Key
Request
header Parameters
call-ref
string

A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255

Request Body schema: application/json
required
required
object

The id of the identity.

Responses
204

Success - No Content

400

Invalid Request

default

Error

post/hawk/customer_check/clear
Request samples
application/json
{
  • "identityId": {
    }
}
Response samples
application/json
{
  • "message": "string",
  • "validation": {
    }
}

hawk_customer_check_peek

SecurityAPI_Secret_Key
Request
header Parameters
call-ref
string

A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255

Request Body schema: application/json
required
required
object

The id of the identity.

Responses
200

Success

400

Invalid Request

default

Error

post/hawk/customer_check/peek
Request samples
application/json
{
  • "identityId": {
    }
}
Response samples
application/json
{
  • "riskLevel": "LOW"
}

hawk_aml_check_get_history

SecurityAPI_Secret_Key
Request
header Parameters
call-ref
string

A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255

Request Body schema: application/json
required
object (AmlCheckResponseKey)
object (TypeId)
Responses
200

Success

400

Invalid Request

default

Error

post/hawk/aml_check/get_history
Request samples
application/json
{
  • "key": {
    },
  • "transactionId": {
    }
}
Response samples
application/json
{
  • "items": [
    ]
}

hawk_aml_check_clear_all

SecurityAPI_Secret_Key
Request
header Parameters
call-ref
string

A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255

Responses
204

Success - No Content

400

Invalid Request

default

Error

post/hawk/aml_check/clear_all
Response samples
application/json
{
  • "message": "string",
  • "validation": {
    }
}

hawk_aml_check_put

SecurityAPI_Secret_Key
Request
header Parameters
call-ref
string

A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255

Request Body schema: application/json
required
required
object
result
required
string
Enum: "APPROVE" "PAUSE" "ASYNC_APPROVE" "ASYNC_PAUSE" "ASYNC_NO_CALLBACK" "SERVICE_UNAVAILABLE"
Responses
204

Success - No Content

400

Invalid Request

default

Error

post/hawk/aml_check/put
Request samples
application/json
{
  • "key": {
    },
  • "result": "APPROVE"
}
Response samples
application/json
{
  • "message": "string",
  • "validation": {
    }
}

hawk_aml_check_clear

SecurityAPI_Secret_Key
Request
header Parameters
call-ref
string

A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255

Request Body schema: application/json
required
required
object
Responses
204

Success - No Content

400

Invalid Request

default

Error

post/hawk/aml_check/clear
Request samples
application/json
{
  • "key": {
    }
}
Response samples
application/json
{
  • "message": "string",
  • "validation": {
    }
}

hawk_aml_check_peek

SecurityAPI_Secret_Key
Request
header Parameters
call-ref
string

A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255

Request Body schema: application/json
required
required
object
Responses
200

Success

400

Invalid Request

default

Error

post/hawk/aml_check/peek
Request samples
application/json
{
  • "key": {
    }
}
Response samples
application/json
{
  • "result": "APPROVE"
}