Skip to main content
API docs by Redocly

ReuseID API Reference (1.0.0)

Download OpenAPI specification:Download

API support: support@signicat.com URL: https://developer.signicat.com/support/

Introduction

Our ReuseID solution enables you to create, manage, and control your end-users' identities. ReuseID combines multiple products from our portfolio to provide you with a solution for implementing your own reusable identity.

The Signicat ReuseID API enables you to onboard identities and perform step-up operations.

Getting Started

To use our ReuseID API, you need to complete the following steps:

Before you start

  1. If you do not have an account already, then you need to sign up to Signicat.
  2. In the Signicat Dashboard, you must create an organisation and create an account.
  3. To authenticate against our APIs, you need to set up an API client. From this step, you will obtain a Client ID and a Client Secret.
  4. To use ReuseID, you need to set the required permissions. Ensure that you select the ReuseID API permission.

Onboarding

The ReuseID Onboarding API provides you with operations related to the onboarding flow, such as starting and getting information about a ReuseID session.

About the onboarding flow

  1. The onboarding flow creates a MobileID user and initiates a MobileID device registration.
  2. Once the end-user has confirmed the activation code, their device is registered to their account and the VideoID session is started.
  3. After the end-user has successfully gone through the VideoID process, the flow updates the user information with the data from the VideoID process.

Start onboarding

The Start onboarding endpoint initiates an onboarding session.

In this flow, you will:

  1. Create a MobileID user.
  2. Activate a MobileID device.
  3. Perform a VideoID proofing.
  4. Add identity attributes to the MobileID user.
Request Body schema: application/json
object

An object that contains parameters for deciding what kind of documents can be used, and which document should be the default.

  • If not specified, then all ID documents that our VideoID solution supports will be available as an option for the end-user.
  • If only one specific document is to be used, then you can specify this with docType.
  • If multiple documents are to be available, then you can specify this with docTypes.

Note: When multiple docTypes are specified, we recommend that you provide a defaultId. This is the first option shown to the user.

docType
integer

A parameter to specify a single document type that you want to be used by the end-user.

docTypes
Array of integers

A parameter to specify multiple document types that you want to be available for the end-user to choose from.

defaultId
integer

A parameter to specify the default document type that you want to be shown to the end-user, when multiple document types are specified. This can only be used when docTypes has been provided.

Note: If not set, then the default is the lowest integer.

Responses

Request samples

Content type
application/json
{
  • "eidProviderOptions": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get onboarding

The Get onboarding endpoint gets data from an onboarding session.

path Parameters
transactionId
required
string

The ID of the transaction, given in the Start onboarding session.

query Parameters
transactionId
string

The ID of the transaction, given in the Start onboarding session.

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Step-up

The ReuseID Step-up API provides you with operations related to the step-up flow, such as starting and getting information about a ReuseID step-up session.

About the step-up flow

  1. The step-up flow initiates a MobileID authentication on the provided device.
  2. Once the end-user has authenticated, a VideoID session is started.
  3. After the end-user has successfully gone through the VideoID process, the flow updates the MobileID user information with the data from the VideoID process.

Start step-up

The Start step-up endpoint initiates a step-up session.

In this flow, you will:

  • Perform a MobileID authentication.
  • Perform a VideoID proofing.
  • Add identity attributes to the MobileID user.
Request Body schema: application/json
userId
required
string

The ID of the user that will carry out the operation, in a valid UUID format.

deviceId
required
string

The ID of the end-user's device that will be used for the operation.

object

An object that contains parameters for deciding what kind of documents can be used, and which document should be the default.

  • If not specified, then all ID documents that our VideoID solution supports will be available as an option for the end-user.
  • If only one specific document is to be used, then you can specify this with docType.
  • If multiple documents are to be available, then you can specify this with docTypes.

Note: When multiple docTypes are specified, we recommend that you provide a defaultId. This is the first option shown to the user.

Responses

Request samples

Content type
application/json
{
  • "userId": "0eb66632-88d0-4ef4-8126-495c64a0abd2",
  • "deviceId": "f8d74181-9e00-41ba-ba4f-43aa6a3dfea5",
  • "eidProviderOptions": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get step-up

The Get step-up endpoint gets data from a step-up session.

path Parameters
transactionId
required
string

The ID of the transaction, given in the Start step-up session.

query Parameters
transactionId
string

The ID of the transaction, given in the Start step-up session.

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}