Skip to main content
API docs by Redocly

ID Document and Biometric Verification: Assure API (1.0.0)

Download OpenAPI specification:Download

URL: https://dashboard.signicat.com/contact-us License: Signicat AS


Introduction to the Assure API

The Assure API is a RESTful service that you can use to perform electronic identity verification (eIDV) of your customers during onboarding. This means you can scan and verify identity documents using one or more of the supported eIDV services. It also allows to obtain identity information from eID methods and to match and corroborate the data from these sources. The purpose of the Assure API is to provide a unique and simple way of integrating these identification services, working both in a browser and native mobile contexts and supporting asynchronous operations.

See also the user docs on how to get started with the Assure API.

Assure

Watermark

Apply a watermark on an image with a selected title, text and date. You can apply the watermark directly on an image sent in the request or on an image from a dossier or process. See also the "general documentation on how to use the Watermark service.

Authorizations:
basicAuth
Request Body schema: application/json
required

Watermark payload

image
string

Image to be watermarked.
Must be in dataURL format (Example: data:image/png;base64,iVBORw....)
The following formats are supported: png, jpg
Minimum image size allowed is 250x120 pixels.
Maximum size allowed is:

  • 4MB
  • 5000px
Note: Recommended maximum size is 1080px.

dossierId
string

Apply a watermark on the image from this dossier.

processId
string

Apply a watermark on the image from this process.

imageDepiction
string
Enum: "selfie" "front"

The type of image to be retrieved from the process.
The portrait value is only available for the 'signicatvideoid' and 'readid' providers.

required
object (Watermark)

Watermark object to be applied to the image.

Responses

Request samples

Content type
application/json
{
  • "image": "data:image/png;base64,iVBORw...",
  • "dossierId": "37191afe-25b3-4c30-b42a-b0ab64aa1d64",
  • "processId": "8afb3ac6-6780-42e4-bbc2-3713e2f6d97c",
  • "imageDepiction": "selfie",
  • "watermark": {
    }
}

Response samples

Content type
application/json
{
  • "instance": "/assure/dossiers/",
  • "method": "POST",
  • "status": 400,
  • "type": "base:client-problem",
  • "title": "Malformed Authorization header.",
  • "detail": "Please provide a valid Bearer authentication.",
  • "traceId": "034fb8bbc5da31f4dd2cf66e70ef313c"
}

Redact

Redact selected fields in document images. You can apply the redaction directly on an image sent in the request or on an image from a dossier or process. See also the "general documentation on how to use the Redaction service.

Authorizations:
basicAuth
Request Body schema: application/json
required

Redaction payload

front
string

Front image to be redacted.
Must be in dataURL format (Example: data:image/png;base64,iVBORw....)

back
string

Back image to be redacted.
Must be in dataURL format (Example: data:image/png;base64,iVBORw....)

dossierId
string

Redact the image from this dossier

processId
string

Redact the image from this process

documentType
required
string
Enum: "passport" "identityCard" "driversLicense" "residencePermit"

Type of the document to be redacted.

documentCountry
required
string
Value: "NLD"

Country of the document to be redacted (ISO 3166 Alpha 3).

fieldsToRedact
required
Array of strings

It indicates which field(s) should be redacted from the ID images.

redactionLevel
string
Enum: "standard" "medium" "high" "veryHigh"

This is the size of the bounding box for the redaction functionality. 'standard' (smallest) is default.

Responses

Request samples

Content type
application/json
{
  • "front": "data:image/png;base64,iVBORw...",
  • "back": "data:image/png;base64,iVBORw...",
  • "dossierId": "37191afe-25b3-4c30-b42a-b0ab64aa1d64",
  • "processId": "8afb3ac6-6780-42e4-bbc2-3713e2f6d97c",
  • "documentType": "passport",
  • "documentCountry": "NLD",
  • "fieldsToRedact": [
    ],
  • "redactionLevel": "standard"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "redactedFrontImage": "data:image/png;base64,iVBORw....",
  • "redactedBackImage": "data:image/png;base64,iVBORw....",
  • "detail": "Please check the image has enough quality and that the document provided is from the list of supported documents."
}

Get document types

This service returns a list with document types supported by each provider, e.g. passport, driving licence etc.

Note: There might be limitations for specific services. For example, retrieving Onfido's extra driving licence information is only supported for specific documents. For a list of supported DL documents, see Use Onfido to extract extra driving licence information in the integration guide.

Authorizations:
basicAuth
path Parameters
providerName
required
string
Enum: "onfido" "signicatpaper" "signicatpictureid" "signicatvideoid"
Example: onfido

The ID of one of the supported providers.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Matching

Get matching configuration

Gets an existing matching configuration in JSON format.

Authorizations:
basicAuth
path Parameters
configurationId
required
string
Example: Configuration1

The ID of a matching configuration.

Responses

Response samples

Content type
application/json
{
  • "configuration": {
    },
  • "id": "Configuration1",
  • "createdAt": "2021-10-04T09:35:19Z",
  • "updatedAt": "2021-10-04T09:35:19Z"
}

Update matching configuration

Updates an existing matching configuration.

Authorizations:
basicAuth
path Parameters
configurationId
required
string
Example: Configuration1

The ID of a matching configuration.

Request Body schema: application/json
required

Matching configuration payload

Array of objects (FieldConfiguration)
Array
id
string

The field to be compared.

sourceField
string

Data from source node.

targetField
string

Data from target node.

normalization
string
Enum: "none" "upper" "clean" "cleanUpper" "initialsUpper" "numeric"

The normalization to be applied to source and target values.

  • 'none': No conversion - case sensitive scenario.
  • 'upper': Converts all characters to upper case - ignores case scenario.
  • 'clean': Converts into latin script - Following ICAO Doc 9303 Part 3 Section 6 recommendation.
  • 'cleanUpper': Apply clean an upper normalization.
  • 'initialsUpper': Converts to the first two initials from multiple words.
  • 'numeric': Converts to the 0-9 characters only.
    • algorithm
    string
    Enum: "levenshtein" "fuzzy"

    The matching algorithm to be used.

  • 'levenshtein': String compare normalized values
    • Exact match: True if all characters match
    Partial match: True if the similarity ratio is above 90% of characters
  • 'fuzzy': String compare normalized values
    • Exact match: True if all characters match
    Partial match: True if the similarity ratio is above 90% of characters or if one of multiple words are an exact match.

    Responses

    Request samples

    Content type
    application/json
    {
    • "fields": [
      ]
    }

    Response samples

    Content type
    application/json
    {
    • "configuration": {
      },
    • "id": "Configuration1",
    • "createdAt": "2021-10-04T09:35:19Z",
    • "updatedAt": "2021-10-04T09:35:19Z"
    }

    Create matching configuration

    Creates a new matching configuration.

    Authorizations:
    basicAuth
    path Parameters
    configurationId
    required
    string [ 0 .. 100 ] characters
    Example: Configuration1

    The ID of a matching configuration.

    Request Body schema: application/json
    required

    Matching configuration payload

    Array of objects (FieldConfiguration)
    Array
    id
    string

    The field to be compared.

    sourceField
    string

    Data from source node.

    targetField
    string

    Data from target node.

    normalization
    string
    Enum: "none" "upper" "clean" "cleanUpper" "initialsUpper" "numeric"

    The normalization to be applied to source and target values.

  • 'none': No conversion - case sensitive scenario.
  • 'upper': Converts all characters to upper case - ignores case scenario.
  • 'clean': Converts into latin script - Following ICAO Doc 9303 Part 3 Section 6 recommendation.
  • 'cleanUpper': Apply clean an upper normalization.
  • 'initialsUpper': Converts to the first two initials from multiple words.
  • 'numeric': Converts to the 0-9 characters only.
    • algorithm
    string
    Enum: "levenshtein" "fuzzy"

    The matching algorithm to be used.

  • 'levenshtein': String compare normalized values
    • Exact match: True if all characters match
    Partial match: True if the similarity ratio is above 90% of characters
  • 'fuzzy': String compare normalized values
    • Exact match: True if all characters match
    Partial match: True if the similarity ratio is above 90% of characters or if one of multiple words are an exact match.

    Responses

    Request samples

    Content type
    application/json
    {
    • "fields": [
      ]
    }

    Response samples

    Content type
    application/json
    {
    • "configuration": {
      },
    • "id": "Configuration1",
    • "createdAt": "2021-10-04T09:35:19Z",
    • "updatedAt": "2021-10-04T09:35:19Z"
    }

    Delete a matching configuration

    Deletes a matching configuration.

    Authorizations:
    basicAuth
    path Parameters
    configurationId
    required
    string
    Example: Configuration1

    The ID of a matching configuration.

    Responses

    Response samples

    Content type
    application/json
    {
    • "instance": "/assure/dossiers/",
    • "method": "POST",
    • "status": 400,
    • "type": "base:client-problem",
    • "title": "Malformed Authorization header.",
    • "detail": "Please provide a valid Bearer authentication.",
    • "traceId": "034fb8bbc5da31f4dd2cf66e70ef313c"
    }

    Perform matching

    You can use this service to corroborate the end-user’s identity. This service matches different sources of information about the end-user.

    Authorizations:
    basicAuth
    path Parameters
    dossierId
    required
    string
    Example: 37191afe-25b3-4c30-b42a-b0ab64aa1d64

    This ID is obtained from the "Create dossier" response body.

    Request Body schema: application/json
    required

    Matching payload

    required
    object (MatchRequestComponent)

    Matching result by component

    required
    object (MatchRequestComponent)

    Matching result by component

    configurationId
    string

    Optional field to specify a custom matching configuration.

    Responses

    Request samples

    Content type
    application/json
    {
    • "source": {
      },
    • "target": {
      }
    }

    Response samples

    Content type
    application/json
    {
    • "dossierId": "37191afe-25b3-4c30-b42a-b0ab64aa1d64",
    • "createdAt": "2021-03-22T15:21:05.294087Z",
    • "source": {
      },
    • "target": {
      },
    • "matchResult": {
      }
    }

    Get all available matching configuration IDs

    Gets all existing matching configuration IDs.

    Authorizations:
    basicAuth

    Responses

    Response samples

    Content type
    application/json
    [
    • {
      }
    ]

    Dossiers

    Get user data

    Use this service to get the existing data in the dossier about the end-user. You will also get information about when this data was last updated.

    Authorizations:
    basicAuth
    path Parameters
    dossierId
    required
    string
    Example: 37191afe-25b3-4c30-b42a-b0ab64aa1d64

    This ID is obtained from the "Create dossier" response body.

    Responses

    Response samples

    Content type
    application/json
    {
    • "dossierId": "8afb3ac6-6780-42e4-bbc2-3713e2f6d97c",
    • "userData": {
      },
    • "createdAt": "2021-10-04T09:35:19Z",
    • "updatedAt": "2021-10-04T09:35:19Z"
    }

    Update user data

    Use this service to update the data about the end-user in the dossier. This service will update existing fields and add new fields if they don't exist in the user data. If you want to delete some information from the user data, you must send that field as an empty string.

    Authorizations:
    basicAuth
    path Parameters
    dossierId
    required
    string
    Example: 37191afe-25b3-4c30-b42a-b0ab64aa1d64

    This ID is obtained from the "Create dossier" response body.

    Request Body schema: application/json
    required

    Userdata payload

    object (UserData)

    Dossier user data

    firstName
    string [ 0 .. 64 ] characters

    The end-user's given name(s).

    lastName
    string [ 0 .. 64 ] characters

    The end-user's surname(s).

    gender
    string[FM]
    Enum: "M" "F"

    The end-user's sex.

    nationality
    string

    The end-user's nationality (country code in ISO 3166 Alpha 3 format).

    dateOfBirth
    string

    The end-user's date of birth (YYYY-MM-DD).

    personalIdentificationNumber
    string

    The end-user's national identity number.

    placeOfBirth
    string

    The end-user's birth place.

    mobile
    string

    The end-user's mobile phone number.

    email
    string

    The end-user's email address.

    object (Address)

    User data address

    Responses

    Request samples

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

    Response samples

    Content type
    application/json
    {
    • "instance": "/assure/dossiers/",
    • "method": "POST",
    • "status": 400,
    • "type": "base:client-problem",
    • "title": "Malformed Authorization header.",
    • "detail": "Please provide a valid Bearer authentication.",
    • "traceId": "034fb8bbc5da31f4dd2cf66e70ef313c"
    }

    Set user data

    Use this service to add data about the end-user into the dossier (e.g. data the end-user entered in a form).

    Authorizations:
    basicAuth
    path Parameters
    dossierId
    required
    string
    Example: 37191afe-25b3-4c30-b42a-b0ab64aa1d64

    This ID is obtained from the "Create dossier" response body.

    Request Body schema: application/json
    required

    Userdata payload

    object (UserData)

    Dossier user data

    firstName
    string [ 0 .. 64 ] characters

    The end-user's given name(s).

    lastName
    string [ 0 .. 64 ] characters

    The end-user's surname(s).

    gender
    string[FM]
    Enum: "M" "F"

    The end-user's sex.

    nationality
    string

    The end-user's nationality (country code in ISO 3166 Alpha 3 format).

    dateOfBirth
    string

    The end-user's date of birth (YYYY-MM-DD).

    personalIdentificationNumber
    string

    The end-user's national identity number.

    placeOfBirth
    string

    The end-user's birth place.

    mobile
    string

    The end-user's mobile phone number.

    email
    string

    The end-user's email address.

    object (Address)

    User data address

    Responses

    Request samples

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

    Response samples

    Content type
    application/json
    {
    • "instance": "/assure/dossiers/",
    • "method": "POST",
    • "status": 400,
    • "type": "base:client-problem",
    • "title": "Malformed Authorization header.",
    • "detail": "Please provide a valid Bearer authentication.",
    • "traceId": "034fb8bbc5da31f4dd2cf66e70ef313c"
    }

    Delete user data

    Use this service to delete all data about the end-user from the dossier.

    Authorizations:
    basicAuth
    path Parameters
    dossierId
    required
    string
    Example: 37191afe-25b3-4c30-b42a-b0ab64aa1d64

    This ID is obtained from the "Create dossier" response body.

    Responses

    Response samples

    Content type
    application/json
    {
    • "instance": "/assure/dossiers/",
    • "method": "POST",
    • "status": 401,
    • "type": "base:client-problem",
    • "title": "The signature of the JWT could not be validated because the key was not found.",
    • "detail": "The given JWT is signed by a key with key ID 'signing-key-aaaaaaaaaaaaaaaaaaaaaaaaaaa', but no such key was found.",
    • "traceId": "034fb8bbc5da31f4dd2cf66e70ef313c"
    }

    Get all dossiers

    You can use this service to check the last 100 dossiers you have created (and that have not yet been deleted).

    Authorizations:
    basicAuth

    Responses

    Response samples

    Content type
    application/json
    [
    • {
      }
    ]

    Create dossier

    You should create a new dossier for each new end-user to perform identity verification for that user. A dossier can have more than one process inside and each process can use a different provider (e.g. Onfido, ReadID etc).

    Authorizations:
    basicAuth
    Request Body schema: application/json

    Dossier payload

    externalReference
    string

    Customer specific reference to be associated with an ID of a dossier.

    Responses

    Request samples

    Content type
    application/json
    {
    • "externalReference": "someReferenceExample"
    }

    Response samples

    Content type
    application/json
    {
    • "dossierId": "710a4326-ef7f-4bed-85c4-aa523f742742",
    • "externalReference": "someReferenceExample",
    • "createdAt": "2022-01-01T09:00:00Z",
    • "updatedAt": "2022-01-01T10:30:00Z"
    }

    Get file from dossier

    Use this service to retrieve files in the dossier.

    Supported depiction types are front and back images of the ID document and selfie images of the end-user.

    Supported file formats are jpg/png.

    For more information, see the Files in dossier in the integration documentation.

    Authorizations:
    basicAuth
    path Parameters
    dossierId
    required
    string
    Example: 37191afe-25b3-4c30-b42a-b0ab64aa1d64

    This ID is obtained from the "Create dossier" response body.

    query Parameters
    depiction
    required
    string
    Enum: "front" "back" "selfie"
    Example: depiction=front

    The type of image to be retrieved from the dossier.

    Responses

    Response samples

    Content type
    application/json
    {
    • "instance": "/assure/dossiers/",
    • "method": "POST",
    • "status": 400,
    • "type": "base:client-problem",
    • "title": "Malformed Authorization header.",
    • "detail": "Please provide a valid Bearer authentication.",
    • "traceId": "034fb8bbc5da31f4dd2cf66e70ef313c"
    }

    Set files to the dossier

    Use this service to upload files to the dossier.

    Supported depiction types are front and back images of the ID document and selfie images of the end-user.

    Supported file formats are jpg/png. The file must be sent using the dataURL scheme.

    You can send one or more files at the same time. If the same depiction type (e.g. selfie) is sent more than once, only the last one is kept.

    If you want to copy an image from the process into the dossier, you must define the processId parameter in the body. Then the file will be uploaded from the process.

    For more information, see the Files in dossier section in the integration documentation.

    Authorizations:
    basicAuth
    path Parameters
    dossierId
    required
    string
    Example: 37191afe-25b3-4c30-b42a-b0ab64aa1d64

    This ID is obtained from the "Create dossier" response body.

    Request Body schema: application/json
    required

    Upload image payload

    front
    string

    Image of the front of the identity document.
    Must be in dataURL format (Example: data:image/png;base64,iVBORw....)

    back
    string

    Image of the back of the identity document.
    Must be in dataURL format (Example: data:image/png;base64,iVBORw....)

    selfie
    string

    Selfie image of the end-user.
    Must be in dataURL format (Example: data:image/png;base64,iVBORw....)

    processId
    string

    processId is obtained from the "Create process" response body.

    Responses

    Request samples

    Content type
    application/json
    {
    • "front": "data:image/png;base64,iVBORw...",
    • "back": "data:image/png;base64,iVBORw...",
    • "selfie": "data:image/png;base64,iVBORw...",
    • "processId": "8afb3ac6-6780-42e4-bbc2-3713e2f6d97c"
    }

    Response samples

    Content type
    application/json
    {
    • "instance": "/assure/dossiers/",
    • "method": "POST",
    • "status": 400,
    • "type": "base:client-problem",
    • "title": "Malformed Authorization header.",
    • "detail": "Please provide a valid Bearer authentication.",
    • "traceId": "034fb8bbc5da31f4dd2cf66e70ef313c"
    }

    Delete files from dossier

    All files uploaded to the dossier will be deleted.

    Authorizations:
    basicAuth
    path Parameters
    dossierId
    required
    string
    Example: 37191afe-25b3-4c30-b42a-b0ab64aa1d64

    This ID is obtained from the "Create dossier" response body.

    Responses

    Response samples

    Content type
    application/json
    {
    • "instance": "/assure/dossiers/",
    • "method": "POST",
    • "status": 401,
    • "type": "base:client-problem",
    • "title": "The signature of the JWT could not be validated because the key was not found.",
    • "detail": "The given JWT is signed by a key with key ID 'signing-key-aaaaaaaaaaaaaaaaaaaaaaaaaaa', but no such key was found.",
    • "traceId": "034fb8bbc5da31f4dd2cf66e70ef313c"
    }

    Get dossier

    Use this service to get all the information about a dossier, including a summarized view of all the processes in it (e.g. Process ID, Status code, Provider...)

    Authorizations:
    basicAuth
    path Parameters
    dossierId
    required
    string
    Example: 37191afe-25b3-4c30-b42a-b0ab64aa1d64

    This ID is obtained from the "Create dossier" response body.

    Responses

    Response samples

    Content type
    application/json
    {
    • "dossierId": "710a4326-ef7f-4bed-85c4-aa523f742742",
    • "externalReference": "someReferenceExample",
    • "createdAt": "2022-01-01T09:00:00Z",
    • "updatedAt": "2022-01-01T10:30:00Z",
    • "processes": [
      ]
    }

    Delete dossier

    This service deletes all userData, files and processes in the given dossier (dossierId).

    Warning: This is a destructive operation since you cannot do a rollback afterwards. You should only use this service after you have finished the end-user’s identification.

    Note: For Onfido, you are not allowed to delete a dossier if there are still processes in the processing state (for more details about process statuses, see the Get process page in the integration documentation).

    Authorizations:
    basicAuth
    path Parameters
    dossierId
    required
    string
    Example: 37191afe-25b3-4c30-b42a-b0ab64aa1d64

    This ID is obtained from the "Create dossier" response body.

    Responses

    Response samples

    Content type
    application/json
    {
    • "instance": "/assure/dossiers/",
    • "method": "POST",
    • "status": 401,
    • "type": "base:client-problem",
    • "title": "The signature of the JWT could not be validated because the key was not found.",
    • "detail": "The given JWT is signed by a key with key ID 'signing-key-aaaaaaaaaaaaaaaaaaaaaaaaaaa', but no such key was found.",
    • "traceId": "034fb8bbc5da31f4dd2cf66e70ef313c"
    }

    Delete all dossiers

    Warning: Normally, you should not use this service, since it deletes all dossiers associated with the OIDC client.

    Authorizations:
    basicAuth

    Responses

    Response samples

    Content type
    application/json
    {
    • "dossierId": "710a4326-ef7f-4bed-85c4-aa523f742742",
    • "externalReference": "someReferenceExample",
    • "createdAt": "2022-01-01T09:00:00Z",
    • "updatedAt": "2022-01-01T10:30:00Z"
    }

    Processes

    Create process

    This service creates a new process in the dossier, using a given provider. You use this service in most flows, unless you integrate through the eIDV alternative flow for the web.
    The request can accept several parameters. However, which parameters to use, depends on the provider and type of process. For more details, see the parameter descriptions below.
    After you have created the process, you cannot change the information you sent in its request. This means, if you need to change any of the information sent in its parameter, you must create a new process. Alternatively, you can delete the old process.

    Authorizations:
    basicAuth
    path Parameters
    dossierId
    required
    string
    Example: 37191afe-25b3-4c30-b42a-b0ab64aa1d64

    This ID is obtained from the "Create dossier" response body.

    Request Body schema: application/json
    required

    Process payload

    provider
    required
    string
    Enum: "onfido" "readid" "signicatpaper" "facetec" "webid" "signicatpictureid" "signicatvideoid" "connect:idmethod"

    The provider that performs the identity document verification. This field is always required for all the providers (see Enum above).

    For more information about supported ID methods from Signicat, see the overview of eIDs in the general documentation.

    processType
    string
    Enum: "substantial" "substantialFullyAuto" "high" "document" "documentSelfie" "documentVideo" "sdk" "ready" "accountid" "videoid"

    This field only applies to the 'signicatvideoid', 'onfido' or 'readid' provider.

    The available values are:

    • For 'signicatvideoid':
      • high (default): A human agent will review the process. This is done asynchronously.
      • substantial: Process verification is done automatically, meaning no human agent is involved.
      • substantialFullyAuto: Similar to substantial but without any inconclusive status. It will automatically reach an accepted or rejected status. For more information about what each status means, see the Get process page in the integration guide.
    • For 'onfido'
      • document: The verification is only done on the provided identity document.
      • documentSelfie (default): The verification is done on the identity document and the photo of the end-user. The photo allows assessing whether the holder of the identity document is the same person as the one in the ID document (facial similarity). The photo must be taken at the time of the request.
      • documentVideo: The verification is done on the identity document and also a video-call while the end-user does some requested actions (e.g. “Look over your left shoulder”). The video allows assessing whether the holder of the identity document is the same person as the one on the video-call(facial similarity). It also detects liveness information.
    • For 'readid'
      • sdk (default)
      • ready
    • For 'webid'
      • videoid: The end-user is identified by a support agent in a live video call.
      • accountid: The end-user identifies themselves by capturing their ID and selfie.
    • For 'signicatpictureid'
      • document: The verification is only done on the provided identity document.
      • documentSelfie (default): The verification is done on the identity document and the photo of the end-user. The photo allows assessing whether the holder of the identity document is the same person as the one in the ID document (facial similarity). The photo must be taken at the time of the request.

    documentType
    string
    Enum: "driversLicense" "passport" "identityCard" "residencePermit" "workPermit" "voterId" "postalIdCard" "professionalQualificationCard" "professionalPermit" "socialSecurity" "panCard" "passportCard" "stateId" "visa" "asylumRegistrationCard" "nationalHealthInsuranceCard" "aadharCard" "immigrationStatusDocument" "indigenousCard" "municipalityIdentityCard" "privateOperatorsCard" "certificateOfSponsorship" "serviceIdCard" "taxId"

    This field only applies to the 'onfido' or 'signicatpaper' provider.
    It is required when images are uploaded via the Assure API (not via the SDK).
    This field defines the document type used in the verification.
    To check the available values, use the "Get Document Types" service.

    object (ProcessParameters)

    Provider specific process parameters

    documentCountry
    string

    This field only applies to the 'signicatpaper' provider and is then a required field.
    It represents the country of the document that will be used in the verification (ISO 3166-1 Alpha 2), e.g. NL.

    For passports only, it is also possible to use the UNIV value. This allows any ICAO compliant passport to be used in the verification. However, in this case, Signicat Paper will only extract information from the MRZ area. This is useful, for example, if you want information from a passport that is not supported by Signicat Paper and you only need information that is in the MRZ area. For a full list of documents supported by Signicat, see the Get document types endpoint.
    Note: If you use the UNIV value, redaction will not be performed.

    redact
    Array of strings

    This field can only be used when the provider is 'signicatpaper')
    It indicates which field(s) should be redacted from the ID images.
    This will affect the 'front' and 'back' images you are able to get from the process If you request redaction, you will only be able to get those images if they were successfully redacted (i.e., if 'isFullRedaction':'true' in the Get Process response).

    redactionLevel
    string
    Enum: "standard" "medium" "high" "veryHigh"

    This field can only be used when the provider is 'signicatpaper'.
    This is the size of the bounding box for the redaction functionality. 'standard' (smallest) is default.

    eventTags
    Array of strings

    List of tags to be used on events API

    documentId
    integer <int32>

    Required for provider 'signicatpictureid'. Unique id for the document that will be used to identify the end-user. Get the full list of possible id document from Get Document Types.

    Responses

    Request samples

    Content type
    application/json
    Example

    Example using onfido provider

    {
    • "provider": "onfido",
    • "processType": "documentSelfie",
    • "documentType": "passport",
    • "processParameters": {
      },
    • "eventTags": [
      ]
    }

    Response samples

    Content type
    application/json
    Example

    Example using onfido provider

    {
    • "processId": "d560f9fc-9312-4110-ad88-f3acf392ca9c",
    • "provider": "onfido",
    • "processType": "documentSelfie",
    • "status": "pending",
    • "authorization": "***********",
    • "createdAt": "2024-03-21T11:42:52Z",
    • "updatedAt": "2024-03-21T11:42:52Z"
    }

    Get process

    Use this service to get all the information about a process (e.g. provider, processType, updatedAt, status) and the verification result (e.g. finalResult).
    The data in the response may vary depending on the provider used to perform the verification.
    See also the Get process section in the integration documentation.

    Authorizations:
    basicAuth
    path Parameters
    dossierId
    required
    string
    Example: 37191afe-25b3-4c30-b42a-b0ab64aa1d64

    This ID is obtained from the "Create dossier" response body.

    processId
    required
    string
    Example: 8afb3ac6-6780-42e4-bbc2-3713e2f6d97c

    processId is obtained from the "Create process" response body.

    Responses

    Response samples

    Content type
    application/json
    Example

    The status is accepted when all underlying verifications have passed

    {
    • "processId": "b481a2e7-ba64-4889-bede-236a0a4a05d0",
    • "provider": "onfido",
    • "processType": "document",
    • "notificationUrl": "http://httpstat.us/200",
    • "status": "accepted",
    • "finalResult": {
      },
    • "providerSpecific": {
      },
    • "createdAt": "2024-12-26T15:40:55Z",
    • "updatedAt": "2024-12-26T15:42:10Z"
    }

    Start verification

    This service requests the provider to perform a verification of the identity document that was uploaded. This service must always run after the ID images are uploaded to the provider (Set images to the process). After calling this service, the information in the process can no longer be changed. This means that if you need to change something in the process (e.g. upload new images), you must create a new process and start over again.

    Authorizations:
    basicAuth
    path Parameters
    dossierId
    required
    string
    Example: 37191afe-25b3-4c30-b42a-b0ab64aa1d64

    This ID is obtained from the "Create dossier" response body.

    processId
    required
    string
    Example: 8afb3ac6-6780-42e4-bbc2-3713e2f6d97c

    processId is obtained from the "Create process" response body.

    Request Body schema: application/json

    Start verification payload

    object (FacetecEnrollmentRequest)

    This field only applies to the 'facetec' provider and is required.
    This object contains necessary information to validate the liveness of a person. The FaceTec SDK provides the returned values of these liveness checks. The values are matched against imageDepiction.

    imageDepiction
    string
    Enum: "selfie" "front"

    This field only applies to the 'facetec' provider and is required. It defines the image depiction in the process that is used to compare against the images captured in facetecEnrollment (see 'Set Images to the process' to see which depictions are valid for 'facetec' processes).

    rAuthorityId
    string

    Id of the registration authority where the VideoID will be sent to be verified by an agent. Not required. If not set, it will use the default value set in your Signicat Account (contact support@signicat.com to change that value).

    Responses

    Request samples

    Content type
    application/json
    {
    • "facetecEnrollment": {
      },
    • "imageDepiction": "selfie",
    • "rAuthorityId": "11a56f16-6f19-4282-8f2d-3749b86471d5"
    }

    Response samples

    Content type
    application/json
    {
    • "processId": "8afb3ac6-6780-42e4-bbc2-3713e2f6d97c",
    • "status": "processing"
    }

    Delete process

    This service deletes all information about a process.

    Warning: This is a destructive operation since you cannot do a rollback afterwards.

    Note: For Onfido, you are not allowed to delete a process if it is still in the processing state (for more details about process statuses, see the Get process page in the integration documentation).

    These are the steps for deleting a process:

    • Before you delete, you should wait until the verification is finished, and then save all the information by using the Get process and Download full result services.
    • After saving, use this 'Delete process' service (and later also Delete dossier if you are finished with that end-user’s identity verification).
    • Once the delete operation has finished, the provider of the process will receive a request to delete the information on their side. The information will either be immediately deleted or soft-deleted, i.e., it will be marked for deletion and hard-deleted after X days (decided by each provider).

    Authorizations:
    basicAuth
    path Parameters
    dossierId
    required
    string
    Example: 37191afe-25b3-4c30-b42a-b0ab64aa1d64

    This ID is obtained from the "Create dossier" response body.

    processId
    required
    string
    Example: 8afb3ac6-6780-42e4-bbc2-3713e2f6d97c

    processId is obtained from the "Create process" response body.

    Responses

    Get image

    Use this service to return images from the process.

    Note: The images were either uploaded to the process directly through the Set images endpoint or by using the provider’s SDK to capture and upload them.

    Supported depiction types are front and back images of the ID document, selfie images of the end-user, and portraitimages extracted from the ID document (portrait is available only for some providers).

    Supported file formats are jpg/png.

    For more information, see the Images section in the integration documentation.

    Authorizations:
    basicAuth
    path Parameters
    dossierId
    required
    string
    Example: 37191afe-25b3-4c30-b42a-b0ab64aa1d64

    This ID is obtained from the "Create dossier" response body.

    processId
    required
    string
    Example: 8afb3ac6-6780-42e4-bbc2-3713e2f6d97c

    processId is obtained from the "Create process" response body.

    query Parameters
    depiction
    required
    string
    Enum: "front" "back" "selfie" "portrait"
    Example: depiction=front

    The type of image to be retrieved from the process.
    The portrait value is only available for the 'signicatvideoid' and 'readid' providers.

    Responses

    Response samples

    Content type
    application/json
    {
    • "instance": "/assure/dossiers/",
    • "method": "POST",
    • "status": 400,
    • "type": "base:client-problem",
    • "title": "Malformed Authorization header.",
    • "detail": "Please provide a valid Bearer authentication.",
    • "traceId": "034fb8bbc5da31f4dd2cf66e70ef313c"
    }

    Set images to the process

    Use this service to add images to the process, which in turn will upload images directly to a provider (i.e. not using their SDK to capture and upload the images).

    Note: Direct upload using Assure is only available for Onfido, Signicat Paper and FaceTec.

    Supported depiction types are front and back images of the ID document, selfie images of the end-user, and portrait images extracted from the ID document (portrait is available only for some providers).

    Supported file formats are jpg/png. The file must be sent using the dataURL scheme.

    You can send one or more images at the same time. If the same depiction type (e.g. selfie) is sent more than once, only the last one is kept.

    You are not allowed to upload images after the verification has started.

    For more information, see the Images section in the integration documentation.

    Authorizations:
    basicAuth
    path Parameters
    dossierId
    required
    string
    Example: 37191afe-25b3-4c30-b42a-b0ab64aa1d64

    This ID is obtained from the "Create dossier" response body.

    processId
    required
    string
    Example: 8afb3ac6-6780-42e4-bbc2-3713e2f6d97c

    processId is obtained from the "Create process" response body.

    Request Body schema: application/json
    required

    Set images payload

    front
    string

    Image of the front of the identity document.
    Must be in dataURL format (Example: data:image/png;base64,iVBORw....)

    back
    string

    Image of the back of the identity document.
    Must be in dataURL format (Example: data:image/png;base64,iVBORw....)

    selfie
    string

    Selfie image of the end-user.
    Must be in dataURL format (Example: data:image/png;base64,iVBORw....)

    Responses

    Request samples

    Content type
    application/json
    {
    • "front": "data:image/png;base64,iVBORw...",
    • "back": "data:image/png;base64,iVBORw...",
    • "selfie": "data:image/png;base64,iVBORw..."
    }

    Response samples

    Content type
    application/json
    {
    • "instance": "/assure/dossiers/",
    • "method": "POST",
    • "status": 400,
    • "type": "base:client-problem",
    • "title": "Malformed Authorization header.",
    • "detail": "Please provide a valid Bearer authentication.",
    • "traceId": "034fb8bbc5da31f4dd2cf66e70ef313c"
    }

    Fail process

    This endpoint allows you to change a process status from pending to failed. This is useful if lots of processes get stuck in pending status due to some problems or user errors (e.g. unstable wifi connection, missing access to the web camera, etc.). Changing those statuses to failed, would declutter the dossier. You cannot set other statuses than pending to failed. If you try to do that, you will receive an HTML 409 error message.

    Authorizations:
    basicAuth
    path Parameters
    dossierId
    required
    string
    Example: 37191afe-25b3-4c30-b42a-b0ab64aa1d64

    This ID is obtained from the "Create dossier" response body.

    processId
    required
    string
    Example: 8afb3ac6-6780-42e4-bbc2-3713e2f6d97c

    processId is obtained from the "Create process" response body.

    Responses

    Response samples

    Content type
    application/json
    {
    • "processId": "8afb3ac6-6780-42e4-bbc2-3713e2f6d97c",
    • "status": "processing",
    • "reason": "{\"message\": \"Failed by request\"}"
    }

    Get list of processes

    You can use this service to retrieve information about all the processes you have created the last 30 days (as long as they are not deleted). This can be useful, for example, to investigate how many processes have failed and why, to see how many processes are accepted/rejected etc.The result is presented as a list. You can filter the process list on creation date, status, offset and limit (see 'query parameters' below).

    Authorizations:
    basicAuth
    query Parameters
    startCreationDate
    required
    string
    Example: startCreationDate=2021-10-04T09:35:19Z

    The start date and time (ISO-8601 with UTC: YYYY-MM-DDThh:mm:ssZ) for the first process in the process list. This date filter is relative to the date the process was created (the createdAt field of the process).

    endCreationDate
    string
    Example: endCreationDate=2021-10-04T09:35:19Z

    The end date and time (ISO-8601 with UTC: YYYY-MM-DDThh:mm:ssZ) for the last process in the process list

    status
    Array of strings unique
    Example: status=accepted

    This field allows you to filter the process list on one or more statuses. The default value is an empty string, which means it returns all processes with all statuses.

    offset
    integer <int32> [ 0 .. 200000 ]
    Default: 0

    You can enter an offset value to specify which process should be retrieved first. The default offset value is 0 (first position in the database) and maximum is 200000. This maximum number is set to avoid performance issues. If you want to display more processes than defined in 'limit', you can create several requests with a different offset:
    1. Create a request for the most recent items: GET /processes?limit=20&offset=0
    2. On scroll/next page, create a second request: GET /processes?limit=20&offset=20
    3. On scroll/next page, create a third request: GET /processes?limit=20&offset=40

    limit
    integer <int32> [ 1 .. 2000 ]
    Default: 100
    Example: limit=100

    This is the maximum number of processes allowed in the response. The default value is 100 and maximum allowed is 2000. If you want to look at more processes than the defined limit, you must make more requests using the 'offset' parameter (see the example above).

    order
    string
    Example: order=createdAtDescending

    Allows to choose the order on which the processes will be returned - by descending or ascending createdAt date.
    Default is descending.

    Responses

    Response samples

    Content type
    application/json
    [
    • {
      }
    ]

    Get video

    This service gets the video that the end-user recorded while the images were captured and uploaded through their SDK with this option set. The service is available for Signicat VideoID and Onfido.

    Authorizations:
    basicAuth
    path Parameters
    dossierId
    required
    string
    Example: 37191afe-25b3-4c30-b42a-b0ab64aa1d64

    This ID is obtained from the "Create dossier" response body.

    processId
    required
    string
    Example: 8afb3ac6-6780-42e4-bbc2-3713e2f6d97c

    processId is obtained from the "Create process" response body.

    Responses

    Response samples

    Content type
    application/json
    {
    • "instance": "/assure/dossiers/",
    • "method": "POST",
    • "status": 400,
    • "type": "base:client-problem",
    • "title": "Malformed Authorization header.",
    • "detail": "Please provide a valid Bearer authentication.",
    • "traceId": "034fb8bbc5da31f4dd2cf66e70ef313c"
    }

    Get processes' external id

    Use this request to get the process external id. This id is the assure process id in the provider side. It corresponds to different things in each provider: Onfido: applicantId, Signicat VideoID: videoId, ReadID: sessionId, Signicat Paper: requestId, Facetec: n/a, WebID: actionId, Signicat PictureID: transactionId.

    Authorizations:
    basicAuth
    path Parameters
    dossierId
    required
    string
    Example: 37191afe-25b3-4c30-b42a-b0ab64aa1d64

    This ID is obtained from the "Create dossier" response body.

    processId
    required
    string
    Example: 8afb3ac6-6780-42e4-bbc2-3713e2f6d97c

    processId is obtained from the "Create process" response body.

    Responses

    Response samples

    Content type
    application/json
    {
    • "externalId": "2822984e-fa4d-46a9-b4cd-de47d5050cc0"
    }

    Download full result

    This service returns a zip file containing all information (images, videos, json files) about a process after verification is complete (“accepted“, ”rejected“, ”inconclusive“).
    After verification is complete, it is recommended to download all information about the process before you delete the process. <
    See also the Download full result section in the integration documentation.

    Authorizations:
    basicAuth
    path Parameters
    dossierId
    required
    string
    Example: 37191afe-25b3-4c30-b42a-b0ab64aa1d64

    This ID is obtained from the "Create dossier" response body.

    processId
    required
    string
    Example: 8afb3ac6-6780-42e4-bbc2-3713e2f6d97c

    processId is obtained from the "Create process" response body.

    Responses

    Response samples

    Content type
    application/json
    {
    • "instance": "/assure/dossiers/",
    • "method": "POST",
    • "status": 401,
    • "type": "base:client-problem",
    • "title": "The signature of the JWT could not be validated because the key was not found.",
    • "detail": "The given JWT is signed by a key with key ID 'signing-key-aaaaaaaaaaaaaaaaaaaaaaaaaaa', but no such key was found.",
    • "traceId": "034fb8bbc5da31f4dd2cf66e70ef313c"
    }

    Capture

    Get capture configuration

    This service returns an existing capture configuration in JSON format.
    <For details about the configuration fields, see the Capture configurations section in the integration documentation.

    Authorizations:
    basicAuth
    path Parameters
    configurationId
    required
    string
    Example: Configuration1

    The ID of a capture configuration.

    Responses

    Response samples

    Content type
    application/json
    {
    • "pageTitle": "This is a title",
    • "favicon": "data:image/x-icon;base64,/9j/4AAQSkZJRg",
    • "fontName": "Raleway",
    • "fontUrl": "https://fonts.googleapis.com/css?family=Raleway:400,500,600,700&display=swap",
    • "primaryColor": "#5AAFFF",
    • "fontColor": "#000000",
    • "buttonsColor": "#000000",
    • "buttonsHoverColor": "#000000",
    • "buttonsTextColor": "#000000",
    • "spinnerColor": "#000000",
    • "documentTypes": [
      ],
    • "documentCountries": {
      },
    • "twoSidedPassports": [
      ],
    • "languages": [
      ],
    • "translations": {
      },
    • "defaultCountry": "NOR",
    • "allowFileUpload": [
      ],
    • "allowTakePhoto": [
      ],
    • "allowZoomOnPreview": [
      ],
    • "useSignicatTheming": true,
    • "enableMobileHandover": false,
    • "enableOrientationConfirmation": false,
    • "autoCapture": false,
    • "detectGlare": [
      ],
    • "customRedactionError": false,
    • "takeSelfie": false,
    • "smsDefaultCountry": "NOR",
    • "maxRetries": 3,
    • "showModalBeforeRedirect": true,
    • "mobileHandoverTimeout": 3,
    • "mobileHandoverModes": [
      ],
    • "forceMobileHandover": true,
    • "useNativeCamera": true,
    • "customCss": "html, body {\\n margin: 0;\\n padding: 0;\\n}\\nbody {\\n background-color: #F7F7F7;\\n font-family: 'Roboto Condensed', sans-serif;\\n color: #4F5B63;\\n background-size: cover;\\n background-repeat: no-repeat;\\n min-height:100vh;\\n}\\n.top {\\n width: 512px;\\n margin: 0 auto;\\n}",
    • "onfidoConfig": { },
    • "signicatvideoidConfig": {
      },
    • "showConsentPage": true,
    • "showAccessibilityLink": true,
    • "showDocumentInstructionsScreen": true,
    • "documentInstructionsScreenItems": [],
    • "showPrerequisitesScreen": true,
    • "prerequisitesScreenItems": [
      ],
    • "showCountryBeforeDocumentType": true
    }

    Update capture configuration

    This service updates an existing capture configuration.The capture configuration impacts the frontend workflow and the graphical interface. <For details about the configuration options, see the Capture configurations section in the integration documentation.

    Authorizations:
    basicAuth
    path Parameters
    configurationId
    required
    string
    Example: Configuration1

    The ID of a capture configuration.

    Request Body schema: application/json
    required

    Capture configuration payload

    pageTitle
    string
    Default: "Signicat Capture"

    The title to be displayed in the browser tab.
    Maximum length: 60 characters.
    In addition to Capture, this field also affects the Onfido and EID SDKs.

    favicon
    string
    Default: "(signicat icon)"

    A custom favicon to be displayed in the browser tab. This must be a valid data-uri or link.
    Allowed data formats: [ "jpeg", "png", "ico"]
    In addition to Capture, this field also affects the Onfido and EID SDKs.

    fontName
    string

    The name of the font to be used in the Capture SDK user interface.
    In addition to Capture, this field also affects the EID SDK.

    fontUrl
    string

    The URL to the CSS file with the font-face.
    In addition to Capture, this field also affects the EID SDK.

    primaryColor
    string

    The HEX or RGB code for the primary color.
    In addition to Capture, this field also affects the Onfido and EID SDKs.

    fontColor
    string
    Default: "black"

    The HEX or RGB code for the general font color.
    In addition to Capture, this field also affects the Onfido and EID SDKs.

    buttonsColor
    string

    The HEX or RGB code for the background color of the buttons. If not set, it will default to primaryColor.
    In addition to Capture, this field also affects the Onfido and EID SDKs.

    buttonsHoverColor
    string

    The HEX or RGB code for the background color of the hover buttons. If not set, it will default to primaryColor.
    In addition to Capture, this field also affects the Onfido and EID SDKs.

    buttonsTextColor
    string
    Default: "white"

    The HEX or RGB code for the text color on the buttons.
    In addition to Capture, this field also affects the Onfido and EID SDKs.

    spinnerColor
    string

    The HEX or RGB code for the color of the loading spinner. If not set, it will default to primaryColor.
    In addition to Capture, this field also affects the Onfido and EID SDKs.

    documentTypes
    Array of strings
    Items Enum: "driversLicense" "passport" "identityCard" "residencePermit" "workPermit" "voterId" "postalIdCard" "professionalQualificationCard" "professionalPermit" "socialSecurity" "panCard" "passportCard" "stateId" "visa" "asylumRegistrationCard" "nationalHealthInsuranceCard" "aadharCard" "immigrationStatusDocument" "indigenousCard" "municipalityIdentityCard" "privateOperatorsCard" "certificateOfSponsorship" "serviceIdCard" "taxId"

    Filters the list of document types that the end-user can choose from. If the field is empty or not defined, all the document types supported by the provider will be displayed.
    In addition to Capture, this field also affects the EID SDK.
    This setting will not take effect for signicatvideoid processes if eidConfig > idTypes is also sent.

    object

    Filters the list of countries that the end-user can choose from. The value will always be an object with the keys corresponding to documentTypes. The value of the keys can be:

    • Empty: If the field is empty or not defined, all the countries supported by the provider will be displayed.
    • univ (string): The univ value (in lower case) is only available for passports. It displays a list of all the countries in the world. Code example: 
      "documentCountries": {
    "passport": "univ"
}
    • Array of country codes (ISO 3166 Alpha 3): This displays only the defined countries. Code example: 
      "documentCountries": {
    "passport": [ "PRT", "NOR" ]
}
      In this case, the end-user will only see the Portuguese and Norwegian document options.
    • UNIV in an array with country codes: The UNIV value (upper case) is only available for the ‘signicatpaper’ provider with passport as document type. It will display an additional option for "Other countries", so the end-user can choose other countries than the ones that are supported in Signicat Paper's template. Code example: 
      "documentCountries": {
    "passport": [ "PRT", "NOR", "UNIV" ]
}
      In this example, the list of passports will show "Portuguese", "Norwegian" and "Other countries" (3 options). You should be aware of the following when using UNIV:
      - Only data from the MRZ area is extracted.
      - Redaction will not be performed.
      - It only works for ICAO compliant passports (that comply with the ICAO9303 rule).
    In addition to Capture, this field also affects the EID SDK.
    This setting will not take effect for signicatvideoid processes if eidConfig > idTypes is also sent.

    twoSidedPassports
    object

    List of countries where also the backside of the passport should be captured.The value can be either an array of country codes (ISO 3166 Alpha 3), or a string all (to ask for the backside of all passports) or null (to not ask for the backside of any passports).

    languages
    Array of strings unique
    Default: "en"

    List of languages the end-user can choose from (ISO 639-1, two-letter codes). In addition to the standard two-letter country codes, we support the following old country codes for backwards compatibility: [ "cz", "gb", "gr", "uk" ].
    For supported languages, see the Translations section in the integration documentation.
    In addition to Capture, this field also affects the EID SDK.

    object

    Custom translations for the Capture SDK. For more details about supported languages and how to create your own translations, see the Translations section in the integration documentation.
    In addition to Capture, this field also affects the EID SDK.

    defaultCountry
    string
    Default: "NOR"

    Helps the UI decide which country to select by default when multiple options are available. For example: To pre-select the phone country code in the mobile handover screen or to set the default country (ISO 3166 Alpha 3) in the list of countries of the document selection screen.
    In addition to Capture, this field also affects the EID SDK.

    allowFileUpload
    Array of strings
    Default: " [mobile, desktop] "

    Enables/disables the file upload option for mobile and desktop.

    allowTakePhoto
    Array of strings
    Default: " [mobile, desktop] "

    Enables/disables the "take photo" option for mobile and desktop.

    allowZoomOnPreview
    Array of strings

    Enables/disables the option to zoom the uploaded image when previewing it for both the "take photo" and "upload photo" flows.

    useSignicatTheming
    boolean
    Default: "false"

    Enables/disables the use of Signicat Theming.

    enableMobileHandover
    boolean
    Default: "true"

    Enables/disables the mobile handover feature.
    In addition to Capture, this field also affects the EID SDK.

    enableOrientationConfirmation
    boolean
    Default: "false"

    Enables/disables the orientation confirmation step at the end of the file upload flow.

    autoCapture
    boolean
    Default: "false"

    Enables/disables the auto-capture feature on the camera flow. Available for passports only.

    detectGlare
    object

    Enables/disables glare detection for both the "take photo" and "upload photo" flows.It can be a boolean or array.

    customRedactionError
    boolean
    Default: "false"

    If the redaction failed, it enables/disables a specific error page in the mobile flow. If set to true, it will redirect to the red error page. If there was an error but the redaction went well, it will redirect to the yellow error page.

    takeSelfie
    boolean
    Default: "false"

    Enables/disables the selfie step at the end of the Capture flow (both camera and file upload). This is required if you want to use both the Onfido documentSelfie and the Capture SDK.

    smsDefaultCountry
    string
    Default: "NOR"

    Country prefix (ISO 3166 Alpha 3) to be pre-selected on the mobile handover popup screen for phone number input.
    In addition to Capture, this field also affects the EID SDK.

    maxRetries
    integer <int32>
    Default: "0"

    The maximum number of retries after the verification fails (e.g. if the document is not valid or possible to read etc.).
    In addition to Capture, this field also affects the EID SDK.

    showModalBeforeRedirect
    boolean
    Default: "true"

    If true, the app shows the success/error modal before redirecting to the redirectUrl. If false, it redirects immediately.

    mobileHandoverTimeout
    integer <int32>
    Default: "0"

    Number of minutes before the mobile handover loading page times out and cancels the process.
    In addition to Capture, this field also affects the EID SDK.

    mobileHandoverModes
    Array of strings
    Default: "[ sms, qrCode ]"

    A list of mobile handover modes the user can choose from. Supported modes are "sms" and "qrCode". The first in the list is used as default.
    In addition to Capture, this field also affects the EID SDK.

    forceMobileHandover
    boolean
    Default: "false"

    Forces the end-user to take photos with their mobile device.

    useNativeCamera
    boolean
    Default: "false"

    Forces the end-user to take photos with the native camera app instead of the browser camera on the mobile.

    customCss
    string

    Optional.
    The custom CSS to be loaded in the app. The string should contain the CSS code.
    In addition to Capture, this field also affects the EID SDK.

    onfidoConfig
    object (JsonNode)

    Custom configurations for the native Onfido Web SDK. This configuration applies when provider is set to onfido and sdk is set to native in Start capture flow. This object is in JSON format. Accepted elements are the ones listed below plus any field included in the Onfido initialisation object: Onfido Web SDK Reference

    • customHtml Optional.
      Custom HTML code (in the form of a string) to replace the HTML of the app. This should always include an element with the ID "onfido-mount" where the Onfido SDK will be mounted.
    • customHeaderLogo Optional.
      An image, provided in a Data URI or link format, indicating the logo image that will be displayed in the top left corner of the page.
    • customBackgroundImage Optional.
      An image provided in a Data URI or link format, indicating the image to be displayed as background under the Onfido SDK.
    • language Optional.
      You can customise the SDK language by passing a string. Available languages are: [en, nb, sv, nl]
    • translations Optional.
      An object where the keys are the language code and have the phrases and mobilePhrases Onfido translations. Refer to the Onfido documentation for instructions on how to find the right keys.
      Code example: 
      "en": {
    "phrases": { 'capture.driving_licence.instructions': 'This custom string will appear by default' }
    "mobilePhrases": { 'capture.driving_licence.instructions': 'This custom string will only appear on mobile' }
}
    • useOnfidoTranslations Optional.
      This field only applies to the Onfido provider when sdk is set to native. It enables Capture to use Onfido's own translations instead of Signicat's translations. For information about the languages Onfido supports, see Supported Languages.

    object (SignicatVideoIdConfig)

    Custom configurations for the native Signicat VideoID Web SDK. This configuration applies when provider is set to signicatvideoid and sdk is set to native in Start capture flow. This object is in JSON format

    showConsentPage
    boolean

    If true, the app shows the consent page before starting the flow

    showAccessibilityLink
    boolean

    If true, the app shows the accessibility statement link at the bottom of the screen.

    showDocumentInstructionsScreen
    boolean

    Enables/disables a screen between the document country picker screen and the take photo or upload photo screen. This screen shows the end-user instructions on how to take or upload a valid photo of an identity document.

    Array of objects (DocumentInstructionScreenItem)
    showPrerequisitesScreen
    boolean

    If enabled, this is the first screen the end-user sees when the capture UI is loaded. It presents tips about what they should have ready before they continue the identification. You can see an example of how this screen looks like in the integration documentation under Translations > Prerequisites screen.

    Array of objects (PrerequisiteScreenItem)
    showCountryBeforeDocumentType
    boolean

    If true, the app will show the document country picker before the document type picker.

    Responses

    Request samples

    Content type
    application/json
    {
    • "pageTitle": "This is a title",
    • "favicon": "data:image/x-icon;base64,/9j/4AAQSkZJRg",
    • "fontName": "Raleway",
    • "fontUrl": "https://fonts.googleapis.com/css?family=Raleway:400,500,600,700&display=swap",
    • "primaryColor": "#5AAFFF",
    • "fontColor": "#000000",
    • "buttonsColor": "#000000",
    • "buttonsHoverColor": "#000000",
    • "buttonsTextColor": "#000000",
    • "spinnerColor": "#000000",
    • "documentTypes": [
      ],
    • "documentCountries": {
      },
    • "twoSidedPassports": [
      ],
    • "languages": [
      ],
    • "translations": {
      },
    • "defaultCountry": "NOR",
    • "allowFileUpload": [
      ],
    • "allowTakePhoto": [
      ],
    • "allowZoomOnPreview": [
      ],
    • "useSignicatTheming": true,
    • "enableMobileHandover": false,
    • "enableOrientationConfirmation": false,
    • "autoCapture": false,
    • "detectGlare": [
      ],
    • "customRedactionError": false,
    • "takeSelfie": false,
    • "smsDefaultCountry": "NOR",
    • "maxRetries": 3,
    • "showModalBeforeRedirect": true,
    • "mobileHandoverTimeout": 3,
    • "mobileHandoverModes": [
      ],
    • "forceMobileHandover": true,
    • "useNativeCamera": true,
    • "customCss": "html, body {\\n margin: 0;\\n padding: 0;\\n}\\nbody {\\n background-color: #F7F7F7;\\n font-family: 'Roboto Condensed', sans-serif;\\n color: #4F5B63;\\n background-size: cover;\\n background-repeat: no-repeat;\\n min-height:100vh;\\n}\\n.top {\\n width: 512px;\\n margin: 0 auto;\\n}",
    • "onfidoConfig": { },
    • "signicatvideoidConfig": {
      },
    • "showConsentPage": true,
    • "showAccessibilityLink": true,
    • "showDocumentInstructionsScreen": true,
    • "documentInstructionsScreenItems": [],
    • "showPrerequisitesScreen": true,
    • "prerequisitesScreenItems": [
      ],
    • "showCountryBeforeDocumentType": true
    }

    Response samples

    Content type
    application/json
    {
    • "pageTitle": "This is a title",
    • "favicon": "data:image/x-icon;base64,/9j/4AAQSkZJRg",
    • "fontName": "Raleway",
    • "fontUrl": "https://fonts.googleapis.com/css?family=Raleway:400,500,600,700&display=swap",
    • "primaryColor": "#5AAFFF",
    • "fontColor": "#000000",
    • "buttonsColor": "#000000",
    • "buttonsHoverColor": "#000000",
    • "buttonsTextColor": "#000000",
    • "spinnerColor": "#000000",
    • "documentTypes": [
      ],
    • "documentCountries": {
      },
    • "twoSidedPassports": [
      ],
    • "languages": [
      ],
    • "translations": {
      },
    • "defaultCountry": "NOR",
    • "allowFileUpload": [
      ],
    • "allowTakePhoto": [
      ],
    • "allowZoomOnPreview": [
      ],
    • "useSignicatTheming": true,
    • "enableMobileHandover": false,
    • "enableOrientationConfirmation": false,
    • "autoCapture": false,
    • "detectGlare": [
      ],
    • "customRedactionError": false,
    • "takeSelfie": false,
    • "smsDefaultCountry": "NOR",
    • "maxRetries": 3,
    • "showModalBeforeRedirect": true,
    • "mobileHandoverTimeout": 3,
    • "mobileHandoverModes": [
      ],
    • "forceMobileHandover": true,
    • "useNativeCamera": true,
    • "customCss": "html, body {\\n margin: 0;\\n padding: 0;\\n}\\nbody {\\n background-color: #F7F7F7;\\n font-family: 'Roboto Condensed', sans-serif;\\n color: #4F5B63;\\n background-size: cover;\\n background-repeat: no-repeat;\\n min-height:100vh;\\n}\\n.top {\\n width: 512px;\\n margin: 0 auto;\\n}",
    • "onfidoConfig": { },
    • "signicatvideoidConfig": {
      },
    • "showConsentPage": true,
    • "showAccessibilityLink": true,
    • "showDocumentInstructionsScreen": true,
    • "documentInstructionsScreenItems": [],
    • "showPrerequisitesScreen": true,
    • "prerequisitesScreenItems": [
      ],
    • "showCountryBeforeDocumentType": true,
    • "id": "Configuration1",
    • "createdAt": "2022-01-01T09:00:00Z",
    • "updatedAt": "2022-01-01T10:30:00Z"
    }

    Create capture configuration

    This service creates a new configuration to be used with the “Start capture flow” service. This configuration specifies the frontend workflow and graphical interface. For details about the configuration options, see the Capture configurations section in the integration documentation.

    Authorizations:
    basicAuth
    path Parameters
    configurationId
    required
    string [ 0 .. 100 ] characters
    Example: Configuration1

    The ID of a capture configuration.

    Request Body schema: application/json
    required

    Capture configuration payload

    pageTitle
    string
    Default: "Signicat Capture"

    The title to be displayed in the browser tab.
    Maximum length: 60 characters.
    In addition to Capture, this field also affects the Onfido and EID SDKs.

    favicon
    string
    Default: "(signicat icon)"

    A custom favicon to be displayed in the browser tab. This must be a valid data-uri or link.
    Allowed data formats: [ "jpeg", "png", "ico"]
    In addition to Capture, this field also affects the Onfido and EID SDKs.

    fontName
    string

    The name of the font to be used in the Capture SDK user interface.
    In addition to Capture, this field also affects the EID SDK.

    fontUrl
    string

    The URL to the CSS file with the font-face.
    In addition to Capture, this field also affects the EID SDK.

    primaryColor
    string

    The HEX or RGB code for the primary color.
    In addition to Capture, this field also affects the Onfido and EID SDKs.

    fontColor
    string
    Default: "black"

    The HEX or RGB code for the general font color.
    In addition to Capture, this field also affects the Onfido and EID SDKs.

    buttonsColor
    string

    The HEX or RGB code for the background color of the buttons. If not set, it will default to primaryColor.
    In addition to Capture, this field also affects the Onfido and EID SDKs.

    buttonsHoverColor
    string

    The HEX or RGB code for the background color of the hover buttons. If not set, it will default to primaryColor.
    In addition to Capture, this field also affects the Onfido and EID SDKs.

    buttonsTextColor
    string
    Default: "white"

    The HEX or RGB code for the text color on the buttons.
    In addition to Capture, this field also affects the Onfido and EID SDKs.

    spinnerColor
    string

    The HEX or RGB code for the color of the loading spinner. If not set, it will default to primaryColor.
    In addition to Capture, this field also affects the Onfido and EID SDKs.

    documentTypes
    Array of strings
    Items Enum: "driversLicense" "passport" "identityCard" "residencePermit" "workPermit" "voterId" "postalIdCard" "professionalQualificationCard" "professionalPermit" "socialSecurity" "panCard" "passportCard" "stateId" "visa" "asylumRegistrationCard" "nationalHealthInsuranceCard" "aadharCard" "immigrationStatusDocument" "indigenousCard" "municipalityIdentityCard" "privateOperatorsCard" "certificateOfSponsorship" "serviceIdCard" "taxId"

    Filters the list of document types that the end-user can choose from. If the field is empty or not defined, all the document types supported by the provider will be displayed.
    In addition to Capture, this field also affects the EID SDK.
    This setting will not take effect for signicatvideoid processes if eidConfig > idTypes is also sent.

    object

    Filters the list of countries that the end-user can choose from. The value will always be an object with the keys corresponding to documentTypes. The value of the keys can be:

    • Empty: If the field is empty or not defined, all the countries supported by the provider will be displayed.
    • univ (string): The univ value (in lower case) is only available for passports. It displays a list of all the countries in the world. Code example: 
      "documentCountries": {
    "passport": "univ"
}
    • Array of country codes (ISO 3166 Alpha 3): This displays only the defined countries. Code example: 
      "documentCountries": {
    "passport": [ "PRT", "NOR" ]
}
      In this case, the end-user will only see the Portuguese and Norwegian document options.
    • UNIV in an array with country codes: The UNIV value (upper case) is only available for the ‘signicatpaper’ provider with passport as document type. It will display an additional option for "Other countries", so the end-user can choose other countries than the ones that are supported in Signicat Paper's template. Code example: 
      "documentCountries": {
    "passport": [ "PRT", "NOR", "UNIV" ]
}
      In this example, the list of passports will show "Portuguese", "Norwegian" and "Other countries" (3 options). You should be aware of the following when using UNIV:
      - Only data from the MRZ area is extracted.
      - Redaction will not be performed.
      - It only works for ICAO compliant passports (that comply with the ICAO9303 rule).
    In addition to Capture, this field also affects the EID SDK.
    This setting will not take effect for signicatvideoid processes if eidConfig > idTypes is also sent.

    twoSidedPassports
    object

    List of countries where also the backside of the passport should be captured.The value can be either an array of country codes (ISO 3166 Alpha 3), or a string all (to ask for the backside of all passports) or null (to not ask for the backside of any passports).

    languages
    Array of strings unique
    Default: "en"

    List of languages the end-user can choose from (ISO 639-1, two-letter codes). In addition to the standard two-letter country codes, we support the following old country codes for backwards compatibility: [ "cz", "gb", "gr", "uk" ].
    For supported languages, see the Translations section in the integration documentation.
    In addition to Capture, this field also affects the EID SDK.

    object

    Custom translations for the Capture SDK. For more details about supported languages and how to create your own translations, see the Translations section in the integration documentation.
    In addition to Capture, this field also affects the EID SDK.

    defaultCountry
    string
    Default: "NOR"

    Helps the UI decide which country to select by default when multiple options are available. For example: To pre-select the phone country code in the mobile handover screen or to set the default country (ISO 3166 Alpha 3) in the list of countries of the document selection screen.
    In addition to Capture, this field also affects the EID SDK.

    allowFileUpload
    Array of strings
    Default: " [mobile, desktop] "

    Enables/disables the file upload option for mobile and desktop.

    allowTakePhoto
    Array of strings
    Default: " [mobile, desktop] "

    Enables/disables the "take photo" option for mobile and desktop.

    allowZoomOnPreview
    Array of strings

    Enables/disables the option to zoom the uploaded image when previewing it for both the "take photo" and "upload photo" flows.

    useSignicatTheming
    boolean
    Default: "false"

    Enables/disables the use of Signicat Theming.

    enableMobileHandover
    boolean
    Default: "true"

    Enables/disables the mobile handover feature.
    In addition to Capture, this field also affects the EID SDK.

    enableOrientationConfirmation
    boolean
    Default: "false"

    Enables/disables the orientation confirmation step at the end of the file upload flow.

    autoCapture
    boolean
    Default: "false"

    Enables/disables the auto-capture feature on the camera flow. Available for passports only.

    detectGlare
    object

    Enables/disables glare detection for both the "take photo" and "upload photo" flows.It can be a boolean or array.

    customRedactionError
    boolean
    Default: "false"

    If the redaction failed, it enables/disables a specific error page in the mobile flow. If set to true, it will redirect to the red error page. If there was an error but the redaction went well, it will redirect to the yellow error page.

    takeSelfie
    boolean
    Default: "false"

    Enables/disables the selfie step at the end of the Capture flow (both camera and file upload). This is required if you want to use both the Onfido documentSelfie and the Capture SDK.

    smsDefaultCountry
    string
    Default: "NOR"

    Country prefix (ISO 3166 Alpha 3) to be pre-selected on the mobile handover popup screen for phone number input.
    In addition to Capture, this field also affects the EID SDK.

    maxRetries
    integer <int32>
    Default: "0"

    The maximum number of retries after the verification fails (e.g. if the document is not valid or possible to read etc.).
    In addition to Capture, this field also affects the EID SDK.

    showModalBeforeRedirect
    boolean
    Default: "true"

    If true, the app shows the success/error modal before redirecting to the redirectUrl. If false, it redirects immediately.

    mobileHandoverTimeout
    integer <int32>
    Default: "0"

    Number of minutes before the mobile handover loading page times out and cancels the process.
    In addition to Capture, this field also affects the EID SDK.

    mobileHandoverModes
    Array of strings
    Default: "[ sms, qrCode ]"

    A list of mobile handover modes the user can choose from. Supported modes are "sms" and "qrCode". The first in the list is used as default.
    In addition to Capture, this field also affects the EID SDK.

    forceMobileHandover
    boolean
    Default: "false"

    Forces the end-user to take photos with their mobile device.

    useNativeCamera
    boolean
    Default: "false"

    Forces the end-user to take photos with the native camera app instead of the browser camera on the mobile.

    customCss
    string

    Optional.
    The custom CSS to be loaded in the app. The string should contain the CSS code.
    In addition to Capture, this field also affects the EID SDK.

    onfidoConfig
    object (JsonNode)

    Custom configurations for the native Onfido Web SDK. This configuration applies when provider is set to onfido and sdk is set to native in Start capture flow. This object is in JSON format. Accepted elements are the ones listed below plus any field included in the Onfido initialisation object: Onfido Web SDK Reference

    • customHtml Optional.
      Custom HTML code (in the form of a string) to replace the HTML of the app. This should always include an element with the ID "onfido-mount" where the Onfido SDK will be mounted.
    • customHeaderLogo Optional.
      An image, provided in a Data URI or link format, indicating the logo image that will be displayed in the top left corner of the page.
    • customBackgroundImage Optional.
      An image provided in a Data URI or link format, indicating the image to be displayed as background under the Onfido SDK.
    • language Optional.
      You can customise the SDK language by passing a string. Available languages are: [en, nb, sv, nl]
    • translations Optional.
      An object where the keys are the language code and have the phrases and mobilePhrases Onfido translations. Refer to the Onfido documentation for instructions on how to find the right keys.
      Code example: 
      "en": {
    "phrases": { 'capture.driving_licence.instructions': 'This custom string will appear by default' }
    "mobilePhrases": { 'capture.driving_licence.instructions': 'This custom string will only appear on mobile' }
}
    • useOnfidoTranslations Optional.
      This field only applies to the Onfido provider when sdk is set to native. It enables Capture to use Onfido's own translations instead of Signicat's translations. For information about the languages Onfido supports, see Supported Languages.

    object (SignicatVideoIdConfig)

    Custom configurations for the native Signicat VideoID Web SDK. This configuration applies when provider is set to signicatvideoid and sdk is set to native in Start capture flow. This object is in JSON format

    showConsentPage
    boolean

    If true, the app shows the consent page before starting the flow

    showAccessibilityLink
    boolean

    If true, the app shows the accessibility statement link at the bottom of the screen.

    showDocumentInstructionsScreen
    boolean

    Enables/disables a screen between the document country picker screen and the take photo or upload photo screen. This screen shows the end-user instructions on how to take or upload a valid photo of an identity document.

    Array of objects (DocumentInstructionScreenItem)
    showPrerequisitesScreen
    boolean

    If enabled, this is the first screen the end-user sees when the capture UI is loaded. It presents tips about what they should have ready before they continue the identification. You can see an example of how this screen looks like in the integration documentation under Translations > Prerequisites screen.

    Array of objects (PrerequisiteScreenItem)
    showCountryBeforeDocumentType
    boolean

    If true, the app will show the document country picker before the document type picker.

    Responses

    Request samples

    Content type
    application/json
    {
    • "pageTitle": "This is a title",
    • "favicon": "data:image/x-icon;base64,/9j/4AAQSkZJRg",
    • "fontName": "Raleway",
    • "fontUrl": "https://fonts.googleapis.com/css?family=Raleway:400,500,600,700&display=swap",
    • "primaryColor": "#5AAFFF",
    • "fontColor": "#000000",
    • "buttonsColor": "#000000",
    • "buttonsHoverColor": "#000000",
    • "buttonsTextColor": "#000000",
    • "spinnerColor": "#000000",
    • "documentTypes": [
      ],
    • "documentCountries": {
      },
    • "twoSidedPassports": [
      ],
    • "languages": [
      ],
    • "translations": {
      },
    • "defaultCountry": "NOR",
    • "allowFileUpload": [
      ],
    • "allowTakePhoto": [
      ],
    • "allowZoomOnPreview": [
      ],
    • "useSignicatTheming": true,
    • "enableMobileHandover": false,
    • "enableOrientationConfirmation": false,
    • "autoCapture": false,
    • "detectGlare": [
      ],
    • "customRedactionError": false,
    • "takeSelfie": false,
    • "smsDefaultCountry": "NOR",
    • "maxRetries": 3,
    • "showModalBeforeRedirect": true,
    • "mobileHandoverTimeout": 3,
    • "mobileHandoverModes": [
      ],
    • "forceMobileHandover": true,
    • "useNativeCamera": true,
    • "customCss": "html, body {\\n margin: 0;\\n padding: 0;\\n}\\nbody {\\n background-color: #F7F7F7;\\n font-family: 'Roboto Condensed', sans-serif;\\n color: #4F5B63;\\n background-size: cover;\\n background-repeat: no-repeat;\\n min-height:100vh;\\n}\\n.top {\\n width: 512px;\\n margin: 0 auto;\\n}",
    • "onfidoConfig": { },
    • "signicatvideoidConfig": {
      },
    • "showConsentPage": true,
    • "showAccessibilityLink": true,
    • "showDocumentInstructionsScreen": true,
    • "documentInstructionsScreenItems": [],
    • "showPrerequisitesScreen": true,
    • "prerequisitesScreenItems": [
      ],
    • "showCountryBeforeDocumentType": true
    }

    Response samples

    Content type
    application/json
    {
    • "pageTitle": "This is a title",
    • "favicon": "data:image/x-icon;base64,/9j/4AAQSkZJRg",
    • "fontName": "Raleway",
    • "fontUrl": "https://fonts.googleapis.com/css?family=Raleway:400,500,600,700&display=swap",
    • "primaryColor": "#5AAFFF",
    • "fontColor": "#000000",
    • "buttonsColor": "#000000",
    • "buttonsHoverColor": "#000000",
    • "buttonsTextColor": "#000000",
    • "spinnerColor": "#000000",
    • "documentTypes": [
      ],
    • "documentCountries": {
      },
    • "twoSidedPassports": [
      ],
    • "languages": [
      ],
    • "translations": {
      },
    • "defaultCountry": "NOR",
    • "allowFileUpload": [
      ],
    • "allowTakePhoto": [
      ],
    • "allowZoomOnPreview": [
      ],
    • "useSignicatTheming": true,
    • "enableMobileHandover": false,
    • "enableOrientationConfirmation": false,
    • "autoCapture": false,
    • "detectGlare": [
      ],
    • "customRedactionError": false,
    • "takeSelfie": false,
    • "smsDefaultCountry": "NOR",
    • "maxRetries": 3,
    • "showModalBeforeRedirect": true,
    • "mobileHandoverTimeout": 3,
    • "mobileHandoverModes": [
      ],
    • "forceMobileHandover": true,
    • "useNativeCamera": true,
    • "customCss": "html, body {\\n margin: 0;\\n padding: 0;\\n}\\nbody {\\n background-color: #F7F7F7;\\n font-family: 'Roboto Condensed', sans-serif;\\n color: #4F5B63;\\n background-size: cover;\\n background-repeat: no-repeat;\\n min-height:100vh;\\n}\\n.top {\\n width: 512px;\\n margin: 0 auto;\\n}",
    • "onfidoConfig": { },
    • "signicatvideoidConfig": {
      },
    • "showConsentPage": true,
    • "showAccessibilityLink": true,
    • "showDocumentInstructionsScreen": true,
    • "documentInstructionsScreenItems": [],
    • "showPrerequisitesScreen": true,
    • "prerequisitesScreenItems": [
      ],
    • "showCountryBeforeDocumentType": true,
    • "id": "Configuration1",
    • "createdAt": "2022-01-01T09:00:00Z",
    • "updatedAt": "2022-01-01T10:30:00Z"
    }

    Delete capture configuration

    This service deletes an existing capture configuration.The capture configuration impacts the frontend workflow and the graphical interface. For details about the configuration options, see the Capture configurations section in the integration documentation.

    Authorizations:
    basicAuth
    path Parameters
    configurationId
    required
    string
    Example: Configuration1

    The ID of a capture configuration.

    Responses

    Response samples

    Content type
    application/json
    {
    • "instance": "/assure/dossiers/",
    • "method": "POST",
    • "status": 404,
    • "type": "base:client-problem",
    • "title": "Not Found",
    • "detail": "Dossier not found.",
    • "traceId": "034fb8bbc5da31f4dd2cf66e70ef313c"
    }

    Start capture flow

    This service initiates a flow for performing an identity document verification in a web context. Since this service encapsulates all providers’ Web SDKs, you do not have to integrate with the provider’s SDK yourself. When you call this service, it will:

    • Create a new service on your behalf.
    • Integrate directly with the provider's JS SDK and use it to display a web view to the end-user where they can capture and upload the ID images.
    • Request to start the verification.
    When you call this service, you must provide similar request parameters as in the Create process service. For more details, see the parameter descriptions below.

    This service also provides other useful features. For example, you can configure the user interface during the web flow. For more usage details about this, see the general documentation in the Start Capture flow section.

    Authorizations:
    basicAuth
    path Parameters
    dossierId
    required
    string
    Example: 37191afe-25b3-4c30-b42a-b0ab64aa1d64

    This ID is obtained from the "Create dossier" response body.

    Request Body schema: application/json
    required
    required
    Array of objects (CaptureProcessRequest)

    This is a list (array) of providers that perform the verification. Please, use only one provider per request.

    sdk
    required
    string
    Enum: "native" "capture"

    Identifies which SDK will be used to capture and upload the images. The available values are:

    • native: Uses the provider's native SDK. This is default when the provider is eid, readidor onfido.
    • capture: Uses Signicat's SDK. This is default when the provider is signicatpaper.
    See also the general documentation, Using the SDKs available in the Capture service.

    redirectUrl
    required
    string

    Contains the URL where the end-user will be redirected to when the image upload is finished (either successfully, failed or canceled).

    requestDomain
    string

    This specifies the domain you want to use for this specific artifact. The domain will be visible in the end-user's browser. This domain needs to be correctly configured on your account!

    object (CaptureProcessParameters)

    Provider specific process parameters

    eventTags
    Array of strings

    List of tags to be used on events API

    Responses

    Request samples

    Content type
    application/json
    Example

    Example using onfido provider

    {
    • "providers": [
      ],
    • "sdk": "native",
    • "redirectUrl": "https://customer.site.com"
    }

    Response samples

    Get all available capture configuration IDs

    Gets all existing capture configuration IDs.

    Authorizations:
    basicAuth

    Responses

    Response samples

    Content type
    application/json
    [
    • {
      }
    ]