Skip to main content
POST
/
v2
/
verification
/
global-db
/
initiate
Initiate global database screening
curl --request POST \
  --url https://bgv.konnectnxt.com/api/v2/verification/global-db/initiate/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "search_term": "John Doe",
  "group_id": "grp_12345",
  "version": "2"
}
'
{
  "status": "success",
  "code": 201,
  "message": "Operation completed successfully",
  "data": {
    "task_id": "550e8400-e29b-41d4-a716-446655440000",
    "group_id": "grp_12345",
    "request_id": "1f07d2de-f113-43f5-9613-43d4897cb493",
    "status": "in_progress"
  },
  "credits_used": 10,
  "credits_remaining": 90
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

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