Skip to main content
POST
Initiate global database screening

Authorizations

Authorization
string
header
required

API key issued by KonnectNXT. Pass as Authorization: Bearer <your_api_key>.

Body

application/json
search_term
string
required

Name or entity to be screened

Example:

"John Doe"

group_id
string

Optional group identifier

Example:

"grp_12345"

version
string

Vendor API version

Example:

"2"

Response

Screening initiated successfully

status
string
Example:

"success"

code
integer
Example:

201

message
string
Example:

"Operation completed successfully"

data
object
credits_used
number
Example:

10

credits_remaining
number
Example:

90