Skip to main content
⌘ K

Using Audkenni QR with Dokobit API products

· Updated ·

Audkenni App QR flow allows users to authenticate with the Audkenni App by scanning a QR code or using a device link.

In order to start using Audkenni App QR flow, the integration process is straightforward. In most cases, the only requirement is to include an additional parameter when creating the authentication session.

API product compatibility with Audkenni QR code

Identity Gateway

Audkenni App QR flow is available for Identity Gateway redirect-based and embedded integrations. In order to start using it, we've added two new parameters which should be part of your requests, depending on your specific use case — audkenniapp_qr_flow=true/false and app2app_url=callbackLink.

  • For Identity Gateway redirect-based integrations, Audkenni App QR flow can be added with an additional parameter when creating the authentication session.

    When sending POST /api/authentication/create, add the parameter audkenniapp_qr_flow=true to the request.

     

  • If you are only starting to use Identity Gateway API solution after the introduction to Audkenni QR, this method will be automatically added to the default request. 

    In case you would like to turn it off, when sending POST /api/authentication/create, add the parameter audkenniapp_qr_flow=false

     

  • For Identity Gateway embedded integrations, Audkenni App QR flow can also be used with the same audkenniapp_qr_flow parameter.

    Please note that when Audkenni App QR flow is used in embedded mode, return_url is always used instead of the JavaScript callback function. If authentication is successful, the user is redirected to the provided return_url. If an error occurs, the user is redirected to the return_url with the error message attached as a GET parameter.

     

  • For integrations done in mobile applications, Audkenni App QR flow can also be added with the audkenniapp_qr_flow value, used together with a new app2app_url=callbackLink parameter, where the user would be redirected after successful authentication in the Audkenni App.

    Once the user is returned to your application, you would need to send all GET parameters to the /auth/{token}/audkenniapp-v3/callback endpoint, after which the user is redirected to the redirect_url, provided in the initial POST /api/authentication/create request.

    Note: your mobile application must support deep links for the app2app_url parameter to work.

A more detailed documentation on Identity Gateway and Audkenni App QR flow functionality with this API can be found here:
https://id-sandbox.dokobit.com/api/doc.

Testing

Audkenni QR code in both sandbox and production environment of Identity Gateway. It is enough to have the Audkenni application updated to its latest version for the method to work.

Since there is not test data to use Audkenni app, real data can be used to complete sandbox environment testing phase.

In case you have any additional questions regarding the functionality of Audkenni QR code with our API solutions, please reach out to developers@dokobit.com

Related articles