import useBaseUrl from ‘@docusaurus/useBaseUrl’;

Create verification session

If you have API key and API secret you can create a verification token.

API key and API secret can be retrieved by contacting Mark ID tech support or Mark ID sales team:

• sales@markid.lt
• info@markid.lt
• via Dashboard

Graphical representation of token generation (UML activity)

Sending request

Send a HTTP POST request to: https://ivs.markid.eu/api/v2/token

The request must contain basic auth headers where username is API key and password is API secret.

We recommend:

Provide only clientId value while generating a token. Do not provide whole client information. Often clients make mistakes and cannot pass the verification successfully. Use client information (name, surname and etc.) from our system’s webhook. This would prevent errors and improve user experience.

If provided information is incorrect or different than information found in the document, you would get verification overall status SUSPECTED with mismatchTags: DOC_INFO_MISMATCH

The request must contain JSON with optional and mandatory parameters:

If you’re generating a 8 digit mobile code, please keep in mind that for security purposes, expiryTime cannot be longer than generateDigitString default value(must be the value as default expiryTime). If you need to increase the maximum default value of the mobile code expiration, please contact sales@markid.lt or our technical support team via Dashboard.

Receiving response

The response JSON contains exact same fields as JSON during token generation. It also returns default values for fields that were optional and not specified during token generation. Additionally, the response also provides these fields below:

Examples

Example requests

You can choose not to send any data regarding your client that needs to be identified. The only mandatory parameter is clientId.

{  
   "clientId":"100000"
}

As our only mandatory parameter is clientId, however we recommend that you would append at least client’s name and surname if possible. It increases the success rate of verifications.

{  
   "clientId":"100000",
   "firstName":"John Tom",
   "lastName":"Smith"
}

Specify all of the parameters for full control.

{  
   "clientId":"100000",
   "firstName":"John Tom",
   "lastName":"Smith",
   "successUrl":"https://www.my-company.com/markid/success",
   "errorUrl":"https://www.my-company.com/markid/fail",
   "unverifiedUrl":"https://www.my-company.com/markid/unverified",
   "callbackUrl" : "https://mywebsite.com/markid/webhookendpoint",
   "locale":"en",
   "showInstructions":true,
   "expiryTime":600,
   "sessionLength":600,
   "country":"lt",
   "documents":["PASSPORT"],
   "dateOfBirth": "1990-12-20",
   "dateOfExpiry": "1990-12-20",
   "dateOfIssue": "1990-12-20",
   "nationality": "lt",
   "personalNumber": "123456789",
   "documentNumber": "123456",
   "sex": "M",
   "address": "Address",
   "tokenType": "IDENTIFICATION",
   "videoCallQuestions": ["Question 1", "Question 2"],
   "externalRef": "reference",
   "utilityBill": false,
   "additionalSteps": null,
   "additionalData": null
   
}

Example responses

If supplied data in JSON and API key with API secret are valid, you should receive a successful response providing you scanRef which is the main identifier of a verification in Mark ID platform.

An example response with all fields provided:

{
   "message": "Token created successfully",
   "authToken": "pgYQX0z2T8mtcpNj9I20uWVCLKNuG0vgr12f0wAC",
   "scanRef": "ec6a7108-8c26-11e9-9758-309c231b1bac",
   "clientId": "100000",
   "firstName": "JOHN TOM",
   "lastName": "SMITH",
   "successUrl": "https://www.my-company.com/markid/success",
   "errorUrl": "https://www.my-company.com/markid/fail",
   "unverifiedUrl":"https://www.my-company.com/markid/unverified",
   "callbackUrl" : "https://mywebsite.com/markid/webhookendpoint",
   "locale": "en",
   "showInstructions":true,
   "country": "lt",
   "expiryTime": 600,
   "sessionLength": 600,
   "documents": [
     "PASSPORT"
   ],
   "allowedDocuments": {
        "ALL": [
            "ID_CARD",
            "PASSPORT",
            "DRIVER_LICENSE",
            "RESIDENCE_PERMIT"
        ]
    },
   "dateOfBirth": "1990-12-20",
   "dateOfExpiry": "1990-12-20",
   "dateOfIssue": "1990-12-20",
   "nationality": "lt",
   "personalNumber": "123456789",
   "documentNumber": "123456",
   "sex": "M",   
   "digitString": "4823657",
   "address": "Address",
   "tokenType": "IDENTIFICATION",
   "videoCallQuestions": ["Question 1", "Question 2"],
   "externalRef": "reference",
   "utilityBill": false,
   "additionalSteps": null,
   "additionalData": null,
   "callbackUrl" : "https://mywebsite.com/markid/webhookendpoint"
}

An example response with no fields provided:

{
  "message": "Token created successfully",
  "authToken": "LEWCd6xHTW2auHrst9MEqZN8tUgKsUQ8hSMNYoLI",
  "scanRef": "9b11acb2-8c27-11e9-9758-309c231b1bac",
  "clientId": "100000",
  "personScanRef": "100000",
  "firstName": null,
  "lastName": null,
  "successUrl": null,
  "errorUrl": null,
  "locale": "en",
  "showInstructions":true,
  "country": null,
  "expiryTime": 3600,
  "sessionLength": 300,
  "documents": [
    "ID_CARD",
    "PASSPORT",
    "RESIDENCE_PERMIT",
    "DRIVER_LICENSE"
  ],
  "allowedDocuments": {
        "ALL": [
            "ID_CARD",
            "PASSPORT",
            "RESIDENCE_PERMIT",
            "DRIVER_LICENSE"
        ]
    },
  "dateOfBirth": null,
  "dateOfExpiry": null,
  "dateOfIssue": null,
  "nationality": null,
  "personalNumber": null,
  "documentNumber": null,
  "sex": null,
  "digitString": "4823657",
  "address": null,
  "tokenType": "IDENTIFICATION",
  "videoCallQuestions": [],
  "externalRef": null,
  "utilityBill": false,
  "additionalSteps": null,
  "additionalData": null

}

Sending a request with custom settings

You can generate a token with customizable settings, such as liveness face detection, instructions, attempt count, etc. simply by adding the available parameters to your token generation request body.

The default values of the settings depend on the environment’s configuration. You can freely contact our support team using your Dashboard account to inquire about current and available settings, some of them have to be included in your contract before it can be enabled.

Our sales team at sales@markid.lt will be happy to answer contract related questions and possibilities of including additional services to your environments.

Please find the full available list of settings below:

None of the above parameters are mandatory, and they have to be turned on in your environment’s configuration before you can pass a specific option parameter in your token generation request.

If the option is turned on in the configuration, they will be active for all of the generated tokens, unless you specify othwerise with the above parameters.

As a result, these options will give you more freedom in customizing our services and applying them in more different scenarios.

Please keep in mind that some of these parameters are already in optimal and tested settings. Use at your own risk.

In case of a malformed JSON body or API key/secret mismatch you will receive a standard Mark ID API error response.

For more on Mark ID API responses visit Mark ID error messages Mark ID error messages.