Skip to main content
POST
/
verification
/
digital-address
/
initiate
cURL
curl --request POST \
  --url https://bgv.konnectnxt.com/api/verification/digital-address/initiate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "full_name": "Aarav Sharma",
  "email": "arnav.sharma@example.com",
  "mobile": "0987654321",
  "id_proof": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAIUEAAAZ2CAYAA",
  "profile_picture": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAIUEAAAZ2CAYAA",
  "address_proof": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAIUEAAAZ2CAYAA",
  "full_address": {
    "is_permanent_address": false,
    "door_no": "22/Na",
    "block": "C-Block",
    "street": "MG Road",
    "area": "Inderanagar",
    "city": "Bangalore",
    "state": "Karnataka",
    "country": "India",
    "postal_code": "560038"
  }
}'
{
  "status": "Success",
  "code": 200,
  "message": "Verification has been successfully initiated. The verification link has been sent to your WhatsApp/Email.",
  "data": {
    "verification_link": "https://konnectnxt.com/digital-address-verification/candidate-verification?key=eyJhbGciOiJIUzI1NiIsInR5cCI6Ikp...",
    "case_id": "a07e9fddfcf64f2787231211adb0359e"
  },
  "credits_used": 3,
  "credits_remaining": 9365
}
This API is used to initiate the digital address verification process for a candidate. It takes the candidate’s details as input, including their full name, contact information, ID proof, profile picture, address proof, and full address details. Once the request is processed, an email and a WhatsApp message are sent to the candidate, prompting them to complete the verification process.
You can track the status of your case using BGV Status API.

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
full_name
string
required

Full name of the individual

Example:

"Aarav Sharma"

​
email
string
required

Email address of the individual

Example:

"arnav.sharma@example.com"

​
mobile
string
required

Mobile number of the individual

Example:

"0987654321"

​
id_proof
string<byte>
required

Base64 encoded ID proof

Example:

"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAIUEAAAZ2CAYAA"

​
address_proof
string<byte>
required

Base64 encoded address proof

Example:

"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAIUEAAAZ2CAYAA"

​
full_address
object
required
​
profile_picture
string<byte>

Base64 encoded profile picture

Example:

"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAIUEAAAZ2CAYAA"

Response

Verification initiated successfully.

​
status
enum<string>
required

Overall status of the API

Available options:
success,
error
​
code
integer
required

HTTP status code

​
message
string
required

Description of the response or error

​
data
object
required
​
credits_used
integer
required

Represents the total number of credits used in this request.

Example:

3

​
credits_left
integer
required

Represents the remaining credits available for use.

Example:

4040