Verify

Use 3 endpoints verify/id/front, verify/id/back, verify/liveness/multi to verify an already registered user.

General Input For Any Request

base-url: https://api.vlenseg.com/api/DigitalIdentity/verify/<endpoint_path>

Headers

Name	Type	Description
Content-Type*	string	application/json
ApiKey*	string	API Key
Authorization*	string	Bearer Access Token `Bearer <accessToken>` that returned from login api or successfull registration

Request Body

Name	Type	Description
transaction_id	GUID	The transaction Id. Required if this request belongs to an existing transaction. If null then a new transaction Id will be generated and returned in the response to be used in subsequent requests for the same transaction.

200 success

{
  "data": <Data model according to each model described below>,
  "Services": {
      "Validations": {
        "validation_errors": [
          {
            "field": <string>,
            "value": <string>,
            "errors": [
              {
                "code": <int>,
                "message": <string>
              }
            ]
          }
        ]
      },
      "spoofing": {
        "fake": <bool>
      },
      "classification": {
        "doc_type": <string>
      }
    }
  },
  "error_code": <int>,
  "error_message": <string>
}

400: Bad Request

{
    "data": null,
    "error_code": 400,
    "error_message": "Bad Request - Input parameters are invalid."
}

401: Unauthorized

{
  "data": null,
  "Services": null,
  "error_code": 401,
  "error_message": "Unauthorized – invalid API Key"
}

National ID front side

Sends National ID Front Image

POST https://<base-url>/id/front

Use parameters mentioned in general input above, check the data model in responses below.

Request Body

Name	Type	Description
image*	string	The base 64 encoding of the 1st face image captured

200: OK Data model for ID front image

{
    "data": {
      "isVerificationProcessCompleted": <bool>,
      "isDigitalIdentityVerified": <bool>,
      "deviceInfo": <string>,
      "user": {
        "name": <string>,
        "surname": <string>,
        "fullName": <string>,
        "userName": <string>,
        "emailAddress": <string>,
        "phoneNumber": <string>,
        "idNumber": <string>
      }
    },
    .
    .
    .
}

National ID back side

Sends National ID Back Image

POST https://<base-url>/id/back

Use parameters mentioned in general input above, check the data model in responses below.

Request Body

Name	Type	Description
image*	string	The base 64 encoding of the 1st face image captured

200: OK Data model for ID back image

{
    "data": {
      "isVerificationProcessCompleted": <bool>,
      "isDigitalIdentityVerified": <bool>,
      "deviceInfo": <string>,
      "user": {
        "name": <string>,
        "surname": <string>,
        "fullName": <string>,
        "userName": <string>,
        "emailAddress": <string>,
        "phoneNumber": <string>,
        "idNumber": <string>
      }
    },
    .
    .
    .
}

Liveness detection with multiple face images

Detecting Liveness

POST https://<base-url>/liveness/multi

Use parameters mentioned in general input above, check the data model in responses below.

Detecting Liveness while matching between faces captured and face on Identity documents

Request Body

Name	Type	Description
face_1*	string	The base 64 encoding of the 1st face image captured
face_2*	string	The base 64 encoding of the 2nd face image captured, the time gap between capturing it and 1st capture must not exceed 500 milliseconds
face_3*	string	The base 64 encoding of the 3rd face image captured, the time gap between capturing it and 2nd capture must not exceed 500 milliseconds

200: OK

{
    "data": {
      "isVerificationProcessCompleted": <bool>,
      "isDigitalIdentityVerified": <bool>,
      "deviceInfo": <string>,
      "user": {
        "name": <string>,
        "surname": <string>,
        "fullName": <string>,
        "userName": <string>,
        "emailAddress": <string>,
        "phoneNumber": <string>,
        "idNumber": <string>
      }
    },
    .
    .
    .
}

• Avoid attaching same image "Identical copy image" as this won't happen in real case and will result false liveness.

• 3 face images must be for the same person as if not same person this will result false liveness.

• 3 face images should simulate/be the real scenario, captured in sequence with time span of max 0.5 second between each. avoid sending 3 different captures for same person in totally different conditions like pose, background and lightning as this might result false liveness.

• Compression is recommended so that images don't exceed 500 KB per each to avoid a long time in uploading images.