Skip to main content

Integrate ready-made onboarding flows

In this ready-made flow guide, you will learn how to implement ReuseID onboarding in your mobile app.

About ReuseID ready-made onboarding​

In a ReuseID onboarding flow, there are two required processes that need to be executed with your app:

  • A MobileID device registration.
  • A identity proofing process, either a VideoID ID document scanning and liveness check or ReadID NFC scanning.
Note

This integration guide contains details for identity proofing provider VideoID. Please contact us by creating a support ticket if you want details on ReadID.

What does it look like?​

In the sequence diagram below, you can see what a ReuseID onboarding looks like.

Sequence diagram showing a ReuseID onboarding

Sequence diagram showing a ReuseID onboarding

MobileID device registration​

The first operation that you need to execute is the MobileID registration.

To learn how to implement the registration process for Android and iOS, use the panel buttons below.

Terminology for registration

When you navigate our documentation, you will also see the term activation. In this context, both activation and registration are synonymous, and refer to the same operation.

Android
Learn how to implement the registration process for Android
iOS
Learn how to implement the registration process for iOS

Operation context​

Operation context is a MobileID feature that allows you to send data over an end-to-end encrypted channel between the backend and the mobile app.

In ReuseID, we use this feature to send data related to the ReuseID operation to the app.

Want to learn more?

To learn about how the operation context object is structured and how you can fetch the data, see our platform-specific documentation for Android and iOS.

Note

In the onboarding operation, we only use the post-operation context to share information.

Post-operation context​

Once the registration is complete, you will get a finishActivationResponse object. This object contains a post-operation context.

Response​

You can find an example of the response below:

Example: Post-operation context
{
  "post_operation_context" : {
    "context_content_b64": <signicatOperation>,
    "context_mime": "application/json"
  }
}
Response object description​

You can find a table of descriptions for the response object parameters below:

Signicat operation object​

The Signicat operation object (signicatOperation) is used to pass information related to the ReuseID process to the mobile app.

Object​

You can find an example of the object below:

Example: Signicat operation object
 {
   "signicatOperation": {
       "version": "1",
       "operation": "registration",
       "provider": "signicatvideoid",
       "token": <TOKEN>,
       "url": "https://etrust-sandbox.electronicid.eu/v2",
       "processType": "substantial",
       "videoidProviderOptions": {
          "docType": 1,
          "docTypes": [1,2,3],
          "defaultId": 1
       }
   }
}
Object description​

You can find a table of descriptions for the object parameters below:

VideoID provider options object​

The VideoID provider options object (videoidProviderOptions) contains VideoID provider-specific configuration options.

You can find a table of descriptions for the object parameters below:

Object description​

Perform VideoID​

Once you have completed the MobileID registration, you then need to start the ViedeoID process in your app.

1. VideoID authorisation​

Before starting the VideoID activity, you need to get an authorisation token for VideoID. You can do this by making a request to the videoid.request API:

  1. Obtain the following parameters from the Signicat operation object:
    • url
    • token
  2. Input this data into the following example:
    Example: Request to get VideoID authorisation token
    curl -X POST <URL>/videoid.request \
    -H 'Authorization: Bearer <TOKEN>' \
    -H 'content-type: application/json' \
    -d '{
        "process": "Unattended"
    }'
    What does Unattended mean?

    In the SDK, the process that you are starting for VideoID is called Unattended. In other parts of the documentation, you will see us refer to this operation as Substantial.

  3. After a successful request , you will receive the following response:
    Example: Response with VideoID authorisation token
    {
    "id": "87a819bd-9419-417a-9e55-cab8789d4115",
    "authorization": "<authorisationToken>"
    }
    Note

    The authorization from this request is required in the next step when you start a VideoID activity.

2. Start VideoID activity​

Next, you need to start the VideoID activity in your app. You should consider the following when starting the activity:

Code examples​

Swift example
func makeUIViewController(context: Context) -> VideoIDSDK.VideoIDSDKViewController {
  let environment: VideoIDSDK.SDKEnvironment = VideoIDSDK.SDKEnvironment(
    url: <<url>>,
    authorization: <<token>>
  )
  let viewController = VideoIDSDKViewController(
    environment: environment,
    docType: <<DocType - Optional>>,
    docTypes: <<DocTypes - Optional>>,
    idDefault: <<DefaultId - Optional>>,
  )
  viewController.delegate = self
  return viewController
}

// Error Handling
func onComplete(videoID: String) {
  // VideoID process succeeded - Handle the next steps here
}
func onError(_ error: VideoIDError) {
  // VideoID process failed - Handle the error here
}
Want to customise VideoID further?

To learn more about VideoID and the available customisation options, you can navigate to the SDK documentation available in the ElectronicID dashboard.

On this page