Skip to main content
GET
/
verification
/
digital-address
/
token
/
generate-url
cURL
curl --request GET \
  --url https://bgv.konnectnxt.com/api/verification/digital-address/token/generate-url \
  --header 'Authorization: Bearer <token>'
{
  "status": "success",
  "code": 200,
  "message": "URL Generated Successfully.",
  "data": {
    "url": "https://konnectnxt.com/digital-address-verification/candidate-initiate?key=eyJhbGciOiJIUzI1NiIsInR..."
  },
  "credits_used": 3,
  "credits_remaining": 178
}
The Generate Digital Address Verification URL API is used to generate a unique URL that allows candidates to submit their digital address details and related proof documents. This URL is specifically designed for the candidate to enter their address information, which will later be verified in the subsequent verification process. When you call this API, it generates a URL containing a token. This token ensures that the candidate’s submission is secure and uniquely tied to their request. The candidate will use this URL to provide their address details and upload any required documents for verification.

​
What Does This API Do?

  • Generates a URL for Candidate Input: This API creates a link that candidates can use to fill in their address details and upload supporting documents (like proof of address). This step is part of a larger verification workflow.
  • Secures the Submission: The generated URL includes a unique token, ensuring that the candidate’s data is securely tied to the verification process. This prevents unauthorized access and ensures that only the correct information is provided.
  • Next Stage Verification: After the candidate submits their address and documents, the next step involves verifying the submitted information in the background. This API only handles the collection of data, and the actual verification will happen at a later stage.
  • Credits Management: Each time a URL is generated, credits are consumed from your account. You can monitor the credits used and the remaining balance using the credits_used and credits_remaining fields in the response.

Authorizations

​
Authorization
string
header
required

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

Response

Successfully generated token URL

​
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

​
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

​
data
object