Skip to main content
API docs by Redocly

ReuseID Onboarding API Reference (1.0.0)

Download OpenAPI specification:Download

  • Base URL: https://api.signicat.com/reuseid/
  • Documentation: See the ReuseID developer documentation.
  • Support: Create a support ticket in the Signicat Dashboard.

Introduction

The Signicat ReuseID Onboarding API enables you to implement your own reusable identity through onboarding or step-up operations. With this API, you can:

  • Onboard new users with identity verification and establish authentication credentials for returning use.
  • Perform a step-up with identity verification when required for existing users.

This REST API uses the OAuth 2.0 protocol for authorisation. All request and response bodies are formatted in JSON.

Get started

Before you can start making requests to this API, you need to learn how to connect to it. To do this, see the Connect to Signicat APIs Quick start guide.

Using this API

Audit logs

Use the Signicat Audit logs service to see documented evidence of the sequence of activities that have affected a system.

  • Access it: Signicat Dashboard > Settings > Audit logs
  • For information generic to all Signicat audit logs, see the general Audit logs documentation.

Errors

When you make an API call to Signicat and an error occurs, you will receive a response message with an error code.

  • For errors generic to all Signicat APIs, see the general Error codes documentation.

Events (callback)

Use the Signicat Events service to automatically receive information about when something happens in one of our services into your system.

Note: This is often referred to as callback.

  • Access it: Go to Signicat Dashboard > Settings > Events
  • For information generic to all Signicat events, see the general Events documentation.

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 identity proofing session is started.
  3. After the end-user has successfully gone through the identity proofing process, the flow updates the user information with the data from the identity proofing 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 an identity proofing.
  4. Add identity attributes to the MobileID user.
Request Body schema: application/json
externalRef
any
provider
string

A parameter to specify which identify proofing provider to use. The current two providers available are readid and signicatvideoid. If no provider is supplied, then the default provider signicatvideoid is used.

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
{
  • "externalRef": "Empl10300469",
  • "provider": "signicatvideoid",
  • "videoidProviderOptions": {
    }
}

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, an identity proofing session is started.
  3. After the end-user has successfully gone through the identity proofing process, the flow updates the MobileID user information with the data from the identity proofing process.

Start step-up

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

In this flow, you will:

  • Perform a MobileID authentication.
  • Perform an identity proofing.
  • Add identity attributes to the MobileID user.
Request Body schema: application/json
userId
required
string
Example: "0eb66632-88d0-4ef4-8126-495c64a0abd2"

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

deviceId
required
string
Example: "f8d74181-9e00-41ba-ba4f-43aa6a3dfea5"

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

provider
string

A parameter to specify which identify proofing provider to use. The current two providers available are readid and signicatvideoid. If no provider is supplied, then the default provider signicatvideoid is used.

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",
  • "provider": "string",
  • "videoidProviderOptions": {
    }
}

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": {
    }
}