1. Abstract

API to easily integrate a document capture and identification solution in your user acquisition path.

Version

1.4.41.0

Copyright

©IDnow 2023, This document is IDnow property. Diffusion or copy are forbidden without authorisation.
https://www.idcheck.io/terms-of-sales/

Terms of service

https://www.idcheck.io/terms-of-use/

Contact

Support IDnow
https://www.idnow.io/contact/

2. Access

3. Endpoints

3.1. Configuration

Configuration used to customized User experience design (logo, colors, wording) of the application.

3.1.1. Create a new configuration

POST /configuration
Description
Parameters
Body Parameter
Name Description Type

CustomerConf
required

CustomerConf
Return Type

CustomerConf

Content Type

  • application/json;charset=UTF-8

Responses
Code Message Type

201

The configuration has been created.

CustomerConf

400

Illegal input

Error

401

Authentication error.

Error

500

Internal error.

Error
Example HTTP request
Request body
{
  "pathName" : "my-brand",
  "wordings" : [ null, null ],
  "code" : "MyConf_01",
  "options" : {
    "supportEmail" : "john.doe@doe.com",
    "linkValidity" : "PT24H",
    "idCaptureSettings" : {
      "blockUpload" : true,
      "captureModeMobile" : "CAMERA",
      "disableImageBlackAndWhiteChecks" : false,
      "disableImageQualityChecks" : false,
      "captureMode" : "CAMERA",
      "displayUploadPromptOnMobile" : true,
      "captureModeDesktop" : "CAMERA"
    },
    "emailSenderName" : "MyCompany"
  },
  "theme" : {
    "headerBgColor" : "#4c5866",
    "btnBgColor" : "#4c5866",
    "btnHoverBgColor" : "#0a64ce",
    "titleTxtColor" : "#4286f4",
    "hideHeaderBorder" : true,
    "logo" : "base64_encoding",
    "btnBorderRadius" : "15px",
    "bodyBgColor" : "#4c5866",
    "btnTxtColor" : "#aa7814",
    "headerLogoAlign" : "LEFT"
  }
}
Example HTTP response
Response 201
{
  "pathName" : "my-brand",
  "wordings" : [ null, null ],
  "code" : "MyConf_01",
  "options" : {
    "supportEmail" : "john.doe@doe.com",
    "linkValidity" : "PT24H",
    "idCaptureSettings" : {
      "blockUpload" : true,
      "captureModeMobile" : "CAMERA",
      "disableImageBlackAndWhiteChecks" : false,
      "disableImageQualityChecks" : false,
      "captureMode" : "CAMERA",
      "displayUploadPromptOnMobile" : true,
      "captureModeDesktop" : "CAMERA"
    },
    "emailSenderName" : "MyCompany"
  },
  "theme" : {
    "headerBgColor" : "#4c5866",
    "btnBgColor" : "#4c5866",
    "btnHoverBgColor" : "#0a64ce",
    "titleTxtColor" : "#4286f4",
    "hideHeaderBorder" : true,
    "logo" : "base64_encoding",
    "btnBorderRadius" : "15px",
    "bodyBgColor" : "#4c5866",
    "btnTxtColor" : "#aa7814",
    "headerLogoAlign" : "LEFT"
  }
}

3.1.2. Delete a configuration

DELETE /configuration/{code}
Description
Parameters
Path Parameters
Name Description Type

code
required

Configuration code defined by the customer when it created the configuration.
Example: code_example

String
Return Type

No Content

Content Type

  • application/json;charset=UTF-8

Responses
Code Message Type

204

The configuration has been deleted.

No content

400

Illegal input

Error

401

Authentication error.

Error

404

Resource not found.

Error

500

Internal error.

Error

3.1.3. Fetch all configurations

GET /configuration
Description
Return Type

array[CustomerConf]

Content Type

  • application/json;charset=UTF-8

Responses
Code Message Type

200

All the configurations found.

List[CustomerConf]

400

Illegal input

Error

401

Authentication error.

Error

404

Resource not found.

Error

500

Internal error.

Error
Example HTTP response
Response 200
{
  "pathName" : "my-brand",
  "wordings" : [ null, null ],
  "code" : "MyConf_01",
  "options" : {
    "supportEmail" : "john.doe@doe.com",
    "linkValidity" : "PT24H",
    "idCaptureSettings" : {
      "blockUpload" : true,
      "captureModeMobile" : "CAMERA",
      "disableImageBlackAndWhiteChecks" : false,
      "disableImageQualityChecks" : false,
      "captureMode" : "CAMERA",
      "displayUploadPromptOnMobile" : true,
      "captureModeDesktop" : "CAMERA"
    },
    "emailSenderName" : "MyCompany"
  },
  "theme" : {
    "headerBgColor" : "#4c5866",
    "btnBgColor" : "#4c5866",
    "btnHoverBgColor" : "#0a64ce",
    "titleTxtColor" : "#4286f4",
    "hideHeaderBorder" : true,
    "logo" : "base64_encoding",
    "btnBorderRadius" : "15px",
    "bodyBgColor" : "#4c5866",
    "btnTxtColor" : "#aa7814",
    "headerLogoAlign" : "LEFT"
  }
}

3.1.4. Fetch a configuration

GET /configuration/{code}
Description
Parameters
Path Parameters
Name Description Type

code
required

Configuration code defined by the customer when it created the configuration.
Example: code_example

String
Return Type

CustomerConf

Content Type

  • application/json;charset=UTF-8

Responses
Code Message Type

200

Configuration found.

CustomerConf

400

Illegal input

Error

401

Authentication error.

Error

404

Resource not found.

Error

500

Internal error.

Error
Example HTTP response
Response 200
{
  "pathName" : "my-brand",
  "wordings" : [ null, null ],
  "code" : "MyConf_01",
  "options" : {
    "supportEmail" : "john.doe@doe.com",
    "linkValidity" : "PT24H",
    "idCaptureSettings" : {
      "blockUpload" : true,
      "captureModeMobile" : "CAMERA",
      "disableImageBlackAndWhiteChecks" : false,
      "disableImageQualityChecks" : false,
      "captureMode" : "CAMERA",
      "displayUploadPromptOnMobile" : true,
      "captureModeDesktop" : "CAMERA"
    },
    "emailSenderName" : "MyCompany"
  },
  "theme" : {
    "headerBgColor" : "#4c5866",
    "btnBgColor" : "#4c5866",
    "btnHoverBgColor" : "#0a64ce",
    "titleTxtColor" : "#4286f4",
    "hideHeaderBorder" : true,
    "logo" : "base64_encoding",
    "btnBorderRadius" : "15px",
    "bodyBgColor" : "#4c5866",
    "btnTxtColor" : "#aa7814",
    "headerLogoAlign" : "LEFT"
  }
}

3.1.5. Update a configuration

PUT /configuration/{code}
Description
Parameters
Path Parameters
Name Description Type

code
required

Configuration code defined by the customer when it created the configuration.
Example: code_example

String
Body Parameter
Name Description Type

CustomerConf
required

CustomerConf
Return Type

CustomerConf

Content Type

  • application/json;charset=UTF-8

Responses
Code Message Type

200

The configuration has been updated.

CustomerConf

400

Illegal input

Error

401

Authentication error.

Error

404

Resource not found.

Error

500

Internal error.

Error
Example HTTP request
Request body
{
  "pathName" : "my-brand",
  "wordings" : [ null, null ],
  "code" : "MyConf_01",
  "options" : {
    "supportEmail" : "john.doe@doe.com",
    "linkValidity" : "PT24H",
    "idCaptureSettings" : {
      "blockUpload" : true,
      "captureModeMobile" : "CAMERA",
      "disableImageBlackAndWhiteChecks" : false,
      "disableImageQualityChecks" : false,
      "captureMode" : "CAMERA",
      "displayUploadPromptOnMobile" : true,
      "captureModeDesktop" : "CAMERA"
    },
    "emailSenderName" : "MyCompany"
  },
  "theme" : {
    "headerBgColor" : "#4c5866",
    "btnBgColor" : "#4c5866",
    "btnHoverBgColor" : "#0a64ce",
    "titleTxtColor" : "#4286f4",
    "hideHeaderBorder" : true,
    "logo" : "base64_encoding",
    "btnBorderRadius" : "15px",
    "bodyBgColor" : "#4c5866",
    "btnTxtColor" : "#aa7814",
    "headerLogoAlign" : "LEFT"
  }
}
Example HTTP response
Response 200
{
  "pathName" : "my-brand",
  "wordings" : [ null, null ],
  "code" : "MyConf_01",
  "options" : {
    "supportEmail" : "john.doe@doe.com",
    "linkValidity" : "PT24H",
    "idCaptureSettings" : {
      "blockUpload" : true,
      "captureModeMobile" : "CAMERA",
      "disableImageBlackAndWhiteChecks" : false,
      "disableImageQualityChecks" : false,
      "captureMode" : "CAMERA",
      "displayUploadPromptOnMobile" : true,
      "captureModeDesktop" : "CAMERA"
    },
    "emailSenderName" : "MyCompany"
  },
  "theme" : {
    "headerBgColor" : "#4c5866",
    "btnBgColor" : "#4c5866",
    "btnHoverBgColor" : "#0a64ce",
    "titleTxtColor" : "#4286f4",
    "hideHeaderBorder" : true,
    "logo" : "base64_encoding",
    "btnBorderRadius" : "15px",
    "bodyBgColor" : "#4c5866",
    "btnTxtColor" : "#aa7814",
    "headerLogoAlign" : "LEFT"
  }
}

3.2. Monitoring

Monitoring paths, offering health check.

3.2.1. Check API health

GET /monitoring/health
Description
Return Type

HealthIndicator

Content Type

  • application/json;charset=UTF-8

Responses
Code Message Type

200

Result of the health check.

HealthIndicator

500

Internal error.

Error
Example HTTP response
Response 200
{
  "details" : {
    "key" : "{}"
  },
  "status" : "UP"
}

3.3. NotificationEndpoint

Manage notification endpoints where notification will be sent.

3.3.1. Create a new notification endpoint

POST /notification-endpoint
Description
Parameters
Body Parameter
Name Description Type

NotificationEndpoint

NotificationEndpoint
Return Type

NotificationEndpoint

Content Type

  • application/json;charset=UTF-8

Responses
Code Message Type

201

The notification endpoint has been created.

NotificationEndpoint

400

Illegal input

Error

401

Authentication error.

Error

500

Internal error.

Error
Example HTTP request
Request body
{
  "securityHeaderField" : {
    "name" : "Api-key",
    "value" : "IdCheckIo-SDK-Web"
  },
  "code" : "My_Endpoint_01",
  "subscribedEvents" : [ "START_ONBOARDING", "START_ONBOARDING" ],
  "active" : true,
  "url" : "http://my-public-url.com/callback",
  "useSsl" : true
}
Example HTTP response
Response 201
{
  "securityHeaderField" : {
    "name" : "Api-key",
    "value" : "IdCheckIo-SDK-Web"
  },
  "code" : "My_Endpoint_01",
  "subscribedEvents" : [ "START_ONBOARDING", "START_ONBOARDING" ],
  "active" : true,
  "url" : "http://my-public-url.com/callback",
  "useSsl" : true
}

3.3.2. Delete a notification endpoint

DELETE /notification-endpoint/{code}
Description
Parameters
Path Parameters
Name Description Type

code
required

Notification endpoint code defined by the customer when it created it.
Example: code_example

String
Return Type

No Content

Content Type

  • application/json;charset=UTF-8

Responses
Code Message Type

204

The notification endpoint has been removed.

No content

400

Illegal input

Error

401

Authentication error.

Error

404

Resource not found.

Error

500

Internal error.

Error

3.3.3. Fetch all notification endpoints

GET /notification-endpoint
Description
Return Type

array[NotificationEndpoint]

Content Type

  • application/json;charset=UTF-8

Responses
Code Message Type

200

All the notification endpoints found.

List[NotificationEndpoint]

401

Authentication error.

Error

500

Internal error.

Error
Example HTTP response
Response 200
{
  "securityHeaderField" : {
    "name" : "Api-key",
    "value" : "IdCheckIo-SDK-Web"
  },
  "code" : "My_Endpoint_01",
  "subscribedEvents" : [ "START_ONBOARDING", "START_ONBOARDING" ],
  "active" : true,
  "url" : "http://my-public-url.com/callback",
  "useSsl" : true
}

3.3.4. Fetch a notification endpoint

GET /notification-endpoint/{code}
Description
Parameters
Path Parameters
Name Description Type

code
required

Notification endpoint code defined by the customer when it created it.
Example: code_example

String
Return Type

NotificationEndpoint

Content Type

  • application/json;charset=UTF-8

Responses
Code Message Type

200

The requested notification endpoint found.

NotificationEndpoint

400

Illegal input

Error

401

Authentication error.

Error

404

Resource not found.

Error

500

Internal error.

Error
Example HTTP response
Response 200
{
  "securityHeaderField" : {
    "name" : "Api-key",
    "value" : "IdCheckIo-SDK-Web"
  },
  "code" : "My_Endpoint_01",
  "subscribedEvents" : [ "START_ONBOARDING", "START_ONBOARDING" ],
  "active" : true,
  "url" : "http://my-public-url.com/callback",
  "useSsl" : true
}

3.3.5. Update a notification endpoint

PUT /notification-endpoint/{code}
Description
Parameters
Path Parameters
Name Description Type

code
required

Notification endpoint code defined by the customer when it created it.
Example: code_example

String
Body Parameter
Name Description Type

NotificationEndpoint

NotificationEndpoint
Return Type

NotificationEndpoint

Content Type

  • application/json;charset=UTF-8

Responses
Code Message Type

200

The notification endpoint has been modified.

NotificationEndpoint

400

Illegal input

Error

401

Authentication error.

Error

404

Resource not found.

Error

500

Internal error.

Error
Example HTTP request
Request body
{
  "securityHeaderField" : {
    "name" : "Api-key",
    "value" : "IdCheckIo-SDK-Web"
  },
  "code" : "My_Endpoint_01",
  "subscribedEvents" : [ "START_ONBOARDING", "START_ONBOARDING" ],
  "active" : true,
  "url" : "http://my-public-url.com/callback",
  "useSsl" : true
}
Example HTTP response
Response 200
{
  "securityHeaderField" : {
    "name" : "Api-key",
    "value" : "IdCheckIo-SDK-Web"
  },
  "code" : "My_Endpoint_01",
  "subscribedEvents" : [ "START_ONBOARDING", "START_ONBOARDING" ],
  "active" : true,
  "url" : "http://my-public-url.com/callback",
  "useSsl" : true
}

3.4. Onboarding

User onboarding configuration (required documents, e-mail or phone link description, web page wordings) to capture documents.

3.4.1. Fetch the onboardings

GET /onboarding
Description
Parameters
Query Parameters
Name Description Type

uid

filter on onboarding uid.
Example: uid_example

String

status

filter on onboarding status. See OnboardingStatusEnum for accepted values.
Example: status_example

String

errorCode

filter on Error code. See OnboardingEndErrorCodeEnum for accepted values.
Example: errorCode_example

String

dateFrom

filter on onboarding created since. (Format: yyyy-MM-dd)
Example: 2013-10-20

date
(date)

dateTo

filter on onboarding created before. (Format: yyyy-MM-dd)
Example: 2013-10-20

date
(date)

notificationType

filter on how the link was sent to the user. See NotificationTypeEnumApiBean for accepted values.
Example: notificationType_example

String

businessUid

Business related identifier defined by you, must be unique.
Example: businessUid_example

String

page

Pagination page to return, zero-based page index. Number of results per page is returned in the response.
Default: 0
Example: 56

Integer
Return Type

OnboardingPaginatedResults

Content Type

  • application/json;charset=UTF-8

Responses
Code Message Type

200

Object containing the results and other data about the search.

OnboardingPaginatedResults

400

Illegal input

Error

401

Authentication error.

Error

500

Internal error.

Error
Example HTTP response
Response 200
{
  "totalResults" : 168,
  "pageResults" : [ {
    "captures" : [ {
      "code" : "DOC1",
      "failedCapture" : 4,
      "successfullCapture" : 4
    }, {
      "code" : "DOC1",
      "failedCapture" : 4,
      "successfullCapture" : 4
    } ],
    "customerLogin" : "myAccount",
    "link" : "https://sdkweb.idcheck.io/your-path/uid_onboarding/welcome",
    "customerHash" : "08776783fds7982189869787sd93763294ds",
    "confCode" : "myConfCode",
    "lastUseDate" : "2017-07-21T17:32:28Z",
    "notificationType" : "EMAIL",
    "creationDate" : "2017-07-21T17:32:28Z",
    "uid" : "110e8400-e29b-11d4-a716-446655440000",
    "errorCause" : {
      "code" : "USER_ERROR",
      "details" : "details"
    },
    "shortenedLink" : "https://p.idcheck.io/hjghjYUyu",
    "businessUid" : "MY_ID",
    "nbLandingPageLoaded" : 4,
    "expirationDate" : "2017-07-21T17:32:28Z",
    "status" : "CREATED"
  }, {
    "captures" : [ {
      "code" : "DOC1",
      "failedCapture" : 4,
      "successfullCapture" : 4
    }, {
      "code" : "DOC1",
      "failedCapture" : 4,
      "successfullCapture" : 4
    } ],
    "customerLogin" : "myAccount",
    "link" : "https://sdkweb.idcheck.io/your-path/uid_onboarding/welcome",
    "customerHash" : "08776783fds7982189869787sd93763294ds",
    "confCode" : "myConfCode",
    "lastUseDate" : "2017-07-21T17:32:28Z",
    "notificationType" : "EMAIL",
    "creationDate" : "2017-07-21T17:32:28Z",
    "uid" : "110e8400-e29b-11d4-a716-446655440000",
    "errorCause" : {
      "code" : "USER_ERROR",
      "details" : "details"
    },
    "shortenedLink" : "https://p.idcheck.io/hjghjYUyu",
    "businessUid" : "MY_ID",
    "nbLandingPageLoaded" : 4,
    "expirationDate" : "2017-07-21T17:32:28Z",
    "status" : "CREATED"
  } ],
  "distinctBusinessUid" : 0,
  "totalPages" : 4,
  "numberPerPage" : 50,
  "currentPage" : 1,
  "distinctUsers" : 1
}

3.4.2. Get document content.

GET /onboarding/{uid}/doccontent/{docCode}
Description
Parameters
Path Parameters
Name Description Type

uid
required

Uid of the onboarding.
Example: uid_example

String

docCode
required

Code of the document.
Example: docCode_example

String
Return Type

DocumentContent

Content Type

  • application/json;charset=UTF-8

Responses
Code Message Type

200

Document found

DocumentContent

400

Illegal input

Error

401

Authentication error.

Error

404

Resource not found.

Error

500

Internal error.

Error
Example HTTP response
Response 200
{
  "code" : "DOC1",
  "docContents" : [ "docContents", "docContents" ]
}

3.4.3. Retrieve the status of an onboarding

GET /onboarding/{uid}/status
Description
Parameters
Path Parameters
Name Description Type

uid
required

Uid of the onboarding.
Example: uid_example

String
Return Type

OnboardingStatusResults

Content Type

  • application/json;charset=UTF-8

Responses
Code Message Type

200

Status & result of the onboarding.

OnboardingStatusResults

400

Illegal input

Error

401

Authentication error.

Error

404

Resource not found.

Error

500

Internal error.

Error
Example HTTP response
Response 200
{
  "result" : {
    "uid" : "110e8400-e29b-11d4-a716-446655440000",
    "analysisResults" : [ {
      "code" : "code",
      "analysisData" : {
        "owner" : {
          "lastNames" : [ "lastNames", "lastNames" ],
          "firstNames" : [ "firstNames", "firstNames" ],
          "birthDate" : {
            "month" : 6,
            "year" : 1,
            "day" : 0
          }
        },
        "withQualityIssues" : false,
        "docType" : "ID"
      },
      "biometricConsent" : true,
      "listCapturedDocs" : [ "listCapturedDocs", "listCapturedDocs" ],
      "expectedDocTypes" : [ "ID", "ID" ],
      "listCapturedDocUids" : [ "listCapturedDocUids", "listCapturedDocUids" ],
      "cisData" : {
        "cisDocumentUid" : "110e8400-e29b-11d4-a716-446655440000",
        "_links" : [ {
          "rel" : "CIS_FILE",
          "href" : "http://localhost:8080/customer/1"
        }, {
          "rel" : "CIS_FILE",
          "href" : "http://localhost:8080/customer/1"
        } ]
      }
    }, {
      "code" : "code",
      "analysisData" : {
        "owner" : {
          "lastNames" : [ "lastNames", "lastNames" ],
          "firstNames" : [ "firstNames", "firstNames" ],
          "birthDate" : {
            "month" : 6,
            "year" : 1,
            "day" : 0
          }
        },
        "withQualityIssues" : false,
        "docType" : "ID"
      },
      "biometricConsent" : true,
      "listCapturedDocs" : [ "listCapturedDocs", "listCapturedDocs" ],
      "expectedDocTypes" : [ "ID", "ID" ],
      "listCapturedDocUids" : [ "listCapturedDocUids", "listCapturedDocUids" ],
      "cisData" : {
        "cisDocumentUid" : "110e8400-e29b-11d4-a716-446655440000",
        "_links" : [ {
          "rel" : "CIS_FILE",
          "href" : "http://localhost:8080/customer/1"
        }, {
          "rel" : "CIS_FILE",
          "href" : "http://localhost:8080/customer/1"
        } ]
      }
    } ],
    "extraData" : {
      "missingOptionalDocs" : [ "missingOptionalDocs", "missingOptionalDocs" ],
      "device" : {
        "userAgent" : "userAgent"
      }
    },
    "businessUid" : "MY_ID",
    "cisData" : {
      "fileCheckUid" : "110e8400-e29b-11d4-a716-446655440000",
      "livenessCheckTaskUid" : "110e8400-e29b-11d4-a716-446655440000",
      "fileCheckTaskUid" : "110e8400-e29b-11d4-a716-446655440000",
      "_links" : [ {
        "rel" : "CIS_FILE",
        "href" : "http://localhost:8080/customer/1"
      }, {
        "rel" : "CIS_FILE",
        "href" : "http://localhost:8080/customer/1"
      } ],
      "cisFileUid" : "110e8400-e29b-11d4-a716-446655440000",
      "realm" : "myRealm",
      "fileCheckTaskStatus" : "ENDED"
    },
    "status" : "SUCCESS"
  },
  "uid" : "110e8400-e29b-11d4-a716-446655440000",
  "errorCause" : {
    "code" : "USER_ERROR",
    "details" : "details"
  },
  "message" : "OnboardingResults not available anymore, the delay of 24 hours expired.",
  "status" : "CREATED"
}

3.4.4. Send a link to a user

POST /onboarding/sendlink
Description
Parameters
Body Parameter
Name Description Type

OnboardingDefinition
required

OnboardingDefinition
Return Type

LinkInfo

Content Type

  • application/json;charset=UTF-8

Responses
Code Message Type

201

Link sent to the user and itinerary registered.

LinkInfo

400

Illegal input

Error

401

Authentication error.

Error

402

Your account ran out of token.

Error

500

Internal error.

Error
Example HTTP request
Request body
{
  "contactData" : {
    "notificationType" : "EMAIL",
    "value" : "user-email@mydomain.com"
  },
  "documentsToCapture" : [ {
    "docTypes" : [ "ID", "ID" ],
    "withDocLiveness" : false,
    "versoHandling" : "MANDATORY",
    "code" : "OWNER_ID",
    "description" : "Please, take a picture of the trunk owner national identity card.",
    "optional" : false,
    "label" : "Car owner ID card",
    "livenessReferenceDoc" : {
      "location" : "ONBOARDING",
      "value" : "MY_ONBOARDING_DOCUMENT_REFERENCE_CODE"
    }
  }, {
    "docTypes" : [ "ID", "ID" ],
    "withDocLiveness" : false,
    "versoHandling" : "MANDATORY",
    "code" : "OWNER_ID",
    "description" : "Please, take a picture of the trunk owner national identity card.",
    "optional" : false,
    "label" : "Car owner ID card",
    "livenessReferenceDoc" : {
      "location" : "ONBOARDING",
      "value" : "MY_ONBOARDING_DOCUMENT_REFERENCE_CODE"
    }
  } ],
  "businessUid" : "MY_ID",
  "options" : {
    "identificationCode" : "ABC-1234-def",
    "captureModeMobile" : "CAMERA",
    "iframeDisplay" : false,
    "iframeRedirectParent" : false,
    "captureMode" : "CAMERA",
    "consent" : {
      "biometricConsent" : true
    },
    "legalMentions" : {
      "externalLink" : "externalLink",
      "hideLink" : false
    },
    "captureModeDesktop" : "CAMERA"
  },
  "resultHandler" : {
    "cisConf" : {
      "realm" : "myRealm",
      "fileLaunchCheck" : false,
      "fileCheckWait" : false,
      "docTypeOverrides" : [ {
        "docCode" : "OWNER_ID",
        "cisDocType" : "ID"
      }, {
        "docCode" : "OWNER_ID",
        "cisDocType" : "ID"
      } ],
      "fileUid" : "myFile",
      "fileTags" : [ "fileTags", "fileTags" ]
    }
  },
  "endpointsToNotify" : [ "endpointsToNotify", "endpointsToNotify" ],
  "interfaceSettings" : {
    "widgetConf" : "{}",
    "language" : "EN",
    "confCode" : "MyConf_01"
  },
  "redirectionData" : {
    "errorRedirectUrl" : "http://mybrand.com/userform/uid/restart",
    "successRedirectUrl" : "http://mybrand.com/userform/uid?capture=done",
    "autoRedirect" : false
  }
}
Example HTTP response
Response 201
{
  "uid" : "110e8400-e29b-11d4-a716-446655440000",
  "shortenedLink" : "https://p.idcheck.io/hjghjYUyu",
  "dispatchInfo" : {
    "msg" : "Click here https://goo.gl/NqMoXJ to start capturing documents for your car rental application.",
    "subject" : "subject",
    "notificationType" : "EMAIL"
  },
  "url" : "https://sdkweb.idcheck.io/your-path/uid_onboarding/welcome",
  "expirationDate" : "2017-07-21T17:32:28Z"
}

3.5. OnboardingIps

User configuration for identity proofing onboardings (required documents, e-mail or phone link description, web page wordings) to capture documents.

3.5.1. Send an identity proofing onboarding link to a user

POST /onboarding-ips
Description
Parameters
Body Parameter
Name Description Type

OnboardingIpsDefinition
required

OnboardingIpsDefinition
Return Type

LinkInfo

Content Type

  • application/json;charset=UTF-8

Responses
Code Message Type

201

Link sent to the user and itinerary registered.

LinkInfo

400

Illegal input

Error

401

Authentication error.

Error

402

Your account ran out of token.

Error

500

Internal error.

Error
Example HTTP request
Request body
{
  "identityProofingId" : "identityProofingId",
  "contactData" : {
    "notificationType" : "EMAIL",
    "value" : "user-email@mydomain.com"
  },
  "options" : {
    "iframeRedirectParent" : false
  },
  "redirectionData" : {
    "errorRedirectUrl" : "http://mybrand.com/userform/uid/restart",
    "successRedirectUrl" : "http://mybrand.com/userform/uid?capture=done",
    "autoRedirect" : false
  },
  "interfaceSettings" : {
    "widgetConf" : "{}",
    "language" : "EN",
    "confCode" : "MyConf_01"
  }
}
Example HTTP response
Response 201
{
  "uid" : "110e8400-e29b-11d4-a716-446655440000",
  "shortenedLink" : "https://p.idcheck.io/hjghjYUyu",
  "dispatchInfo" : {
    "msg" : "Click here https://goo.gl/NqMoXJ to start capturing documents for your car rental application.",
    "subject" : "subject",
    "notificationType" : "EMAIL"
  },
  "url" : "https://sdkweb.idcheck.io/your-path/uid_onboarding/welcome",
  "expirationDate" : "2017-07-21T17:32:28Z"
}

4. Models

4.1. AnalysisData

The data extracted from the analysis. May contain OwnerData if the document carried a MRZ.

Field Name Description Type

docType
required

DocToCaptureTypeEnum

withQualityIssues

Flag to indicate if the document captured has quality issues (true).
This happens when the user is not able to push an issue less document after several tries.
Default: false

Boolean

owner

OwnerData

4.2. AnalysisResults

Returned to the client callback url and contains the analysis results extracted for a document.

Field Name Description Type

code
required

Code from the DocToCapture description, client defined capture identifier.

String

expectedDocTypes
required

Expected docTypes that should be confirmed by the analysis.

List of DocToCaptureTypeEnum

listCapturedDocs
required

List containing the document base64 contents that were captured, either one or both sides.
Will be empty if the flag payloadTooLarge is at true

List of
String

listCapturedDocUids
required

List containing the document ids that were captured, either one or both sides.

List of
String

biometricConsent

The user consent for automated processing of Biometric documents (Only Selfie & Liveness).

Boolean

analysisData

AnalysisData

cisData

CisDocumentData

captureSource

CaptureSourceEnum

4.3. CaptureDocData

Data about the doc captures.

Field Name Description Type

code
required

docCode of the document
Example: DOC1

String

successfullCapture
required

Number of time the document was successfully captured.
Example: 4

Integer (int32)

failedCapture
required

Number of time the document capture failed.
Example: 4

Integer (int32)

4.4. CaptureModeEnum

Capture mode used to define the way document are captured :
- CAMERA : open the camera widget
- UPLOAD : upload only
- PROMPT : user can choose camera or upload

Allowed values: PROMPT, CAMERA, UPLOAD

4.5. CaptureSourceEnum

Source of the captured document
- WIDGET_CAMERA : Capture has been done with a camera inside the browser (automatic capture).
- NATIVE_CAMERA : Capture has been done with a native camera outside the browser.
- UPLOAD : Document has been uploaded from the device.
- DRAGNDROP: Document has been uploaded from the device.
- UNKNOWN : Mobile user chose between NATIVE_CAMERA or UPLOAD and we don’t know the capture source.

Allowed values: WIDGET_CAMERA, NATIVE_CAMERA, UPLOAD, DRAGNDROP, UNKNOWN

4.6. CisConf

Configuration used to push document directly in the CIS.

Field Name Description Type

realm
required

CIS Realm where the file is created
Example: myRealm

String
max-length: 200

fileUid

Id of the file where to add the captured documents.
This might be mandatory depending on your CIS configuration (See with CSMs for details).
(Max: 45 chars)
Example: myFile

String
max-length: 45

fileLaunchCheck

launch file check at the end of the capture.
Default: false

Boolean

fileCheckWait

Wait the end of the file check to do the callback.
Default: false

Boolean

fileTags

Tags to add to the CIS file (help with search).
Cannot be larger than 175 char when summed.

List of
String

docTypeOverrides

Allow to override the document type pushed to CIS, so that it’s not the same as the type described on the itinerary.
Use case ⇒ Don’t launch analysis by using OTHER but push in CIS as ID.
Check with support before using that feature.

List of CisDocTypeOverride

4.7. CisDocTypeOverride

Allow to override the document type pushed to CIS, so that it’s not the same as the type described on the itinerary.
Use case ⇒ Don’t launch analysis by using OTHER but push in CIS as ID.

Field Name Description Type

docCode
required

Code of the doc in the itinerary.
Example: OWNER_ID

String
max-length: 20

cisDocType
required

DocToCaptureTypeEnum

4.8. CisDocumentData

Data containing CIS related information on document if the onboarding was pushed to the CIS.

Field Name Description Type

cisDocumentUid

The CIS document UID if the document was analyzed on CIS.
Example: 110e8400-e29b-11d4-a716-446655440000

String

links
_required

Hateoas links associated with the file.

List of HateoasLinks

4.9. CisFileData

Data containing CIS related File information if the onboarding was pushed to a CIS File.

Field Name Description Type

cisFileUid
required

Id of the CIS file where the document have been pushed.
Example: 110e8400-e29b-11d4-a716-446655440000

String

fileCheckUid

Only if a synchronous file check was requested: id of the check in the CIS.
Example: 110e8400-e29b-11d4-a716-446655440000

String

fileCheckTaskUid

Only if an asynchronous file check was requested: id of the CIS task associated with the file check, that can be polled.
Example: 110e8400-e29b-11d4-a716-446655440000

String

livenessCheckTaskUid

Only if no file check was requested, but the onboarding contains a liveness document: id of the CIS task associated with the liveness analysis, that can be polled.
Example: 110e8400-e29b-11d4-a716-446655440000

String

fileCheckTaskStatus
required

CisTaskStatus

links
_required

Hateoas links associated with the file.

List of HateoasLinks

realm

CIS realm
Example: myRealm

String

4.10. CisTaskStatus

Status of the file check task
- ENDED Task ended
- ONGOING Task started and is on going
- FAILED Task suffering a technical error
- WAITING_MANUAL_ANALYSIS Task is waiting for a manual analysis
- WAITING_LIVENESS_ANALYSIS Task is waiting liveness analysis

Allowed values: ENDED, FAILED, ONGOING, WAITING_MANUAL_ANALYSIS, WAITING_LIVENESS_ANALYSIS

4.11. ConfOptions

Optionals settings to further the customisation.

Field Name Description Type

emailSenderName

Name used to send the link by email.
Example: MyCompany

String
max-length: 30

linkValidity

Duration before which the onboarding generated can be closed as expired (Default 24h, Min 5 minutes, Max 24h).
Format: ISO-8601 string or Integer (number of hours).
Default: 24
Example: PT24H

String (100)

supportEmail

Email used to send warnings when there are callbacks issue.
For example if your callback server is not available or throw an error.
Example: john.doe@doe.com

String
max-length: 100

idCaptureSettings

ConfOptionsIdCaptureSettings

4.12. ConfOptionsIdCaptureSettings

Optionals settings to customize ID capture.

Field Name Description Type

blockUpload

[EXPERIMENTAL] Force the user to capture his ID document with his device’s camera. Please contact a CSM to activate this feature.
Default: false
Example: true

Boolean

captureMode

DeprecatedCaptureModeEnum

captureModeDesktop

CaptureModeEnum

captureModeMobile

CaptureModeEnum

displayUploadPromptOnMobile

If true, when capturing an ID document (ID card, driving license…​), the user will always be asked if he wants to take a picture with his camera or use a file on the device’s file system.
If false, it will always open the camera app to take a picture. Please note that if there is an issue with the device’s camera or if the browser does not allow the access to the camera app, then the user will still have the option to select a file from the device’s file system.
Default: false
Example: true

Boolean

disableImageBlackAndWhiteChecks

Disable black and white quality issue
Default: false

Boolean

disableImageQualityChecks

Disable all quality issues
Default: false

Boolean

4.13. ConfWording

Customise the wording seen by your users during the capture process.
⇒ If any message is null, its default value will be used.
The priority order is OnboardingDefinition wording, then CustomerConf wording and at last default API wording.

Field Name Description Type

homeTitle

Title displayed on the landing page.
Example: MyBrand mobile capture exp'

String
max-length: 30

homeMsg

Message displayed on the landing page.
Example: Welcome to the first step of your registration with MyBrand.

String
max-length: 150

authentInputMsg

Text displayed into the input of Home page.
Example: Identification code

String
max-length: 30

authentHelpMsg

Text displayed under the connect button to help user retrieve its connexion code.
Example: Your Identification code has been communicated on the previous

String
max-length: 150

errorMsg

Message to display when a user associated with this configuration gets a device error or a technical error (Should not happen).
Example: The onboarding cannot go further because of an issue with your device or the service. Please go back to our platform

String
max-length: 150

onboardingEndMsg

Message to display on the end page (Above the redirect button when using redirection mode).
Example: Click the link bellow to go back to your web form.

String
max-length: 150

expiredMsg

Message to display when a user click an expired link associated with this configuration.
Example: The link you clicked has expired, please go back to my-brand.com to generate a new one.

String
max-length: 150

linkEmailSubject

Subject of the mail containing the link.
Example: MyBrand car rental mobile capture

String
max-length: 150

linkEmailMsg

Message displayed in the e-mail to invite the client to begin the capture.
The link can be positioned in the message by using {} else it’ll be added at the end of the message.
Allows the following HTML tags, a, b, blockquote, br, cite, code, dd, dl, dt, em, i, li, ol, p, pre, q, small, span, strike, strong, sub, sup, u, ul and appropriate attributes.
Links can point to http, https, ftp, mailto.
Escape double quotes with a backslash.
Example: <a href="{}">Click me</a> to start capturing documents for your car rental application.

String
max-length: 1500

linkEmailSignature

Signature displayed in the e-mail after linkEmailMsg.
Allows the following HTML tags, a, b, blockquote, br, cite, code, dd, dl, dt, em, i, li, ol, p, pre, q, small, span, strike, strong, sub, sup, u, ul and appropriate attributes.
Links can point to http, https, ftp, mailto.
Escape double quotes with a backslash.
Example: Mr EXAMPLE Example <br> Developer at <a href="http://my-company.com">My Company</a>

String
max-length: 1000

linkSmsMsg

Message displayed in the SMS to invite the client to begin the capture.
The link can be positioned in the message by using {} else it’ll be added at the end of the message.
Only GSM 7-bit alphabet characters are accepted. See Standard GSM 03.38 : https://en.wikipedia.org/wiki/GSM_03.38
Example: Click here {} to start capturing documents for your car rental application.

String
max-length: 120

language
required

LanguageEnum

4.14. ConfWordingAllOf

Field Name Description Type

language

LanguageEnum

4.15. ContactData

Defined the way used to send the link to capture documents.

Field Name Description Type

notificationType
required

NotificationTypeEnum

value
required

Contact value, depends on the medium: email or mobile number.
For mobile number, the format expected for international number is E164, the leading '+' being optional. (Ex: +33611111111)
For French phone number, the national format will also work. (Ex: 0611111111)
Example: user-email@mydomain.com

String
max-length: 200

4.16. CustomerConf

Configuration defined by a Customer for all his Onboardings.

Field Name Description Type

code
required

Unique identifier defined by the user.
Example: MyConf_01

String
max-length: 20

pathName
required

Custom path that will be part of the link sent.
Example: my-brand

String
max-length: 20

theme

Theme

wordings

Custom wordings to use instead of the default one for all your users, by language.

List of ConfWording

options

ConfOptions

4.17. DateObject

Date definition.

Field Name Description Type

day

day number of date.

Integer (int32)

month

month number of date.

Integer (int32)

year

year of date.

Integer (int32)

4.18. DeprecatedCaptureModeEnum

Capture mode used to define the way document are captured :
- CAMERA : open the camera widget
- CAMERA_WITH_UPLOAD_FALLBACK : (default) open the camera widget but allow upload in some cases
- UPLOAD : upload only

Allowed values: CAMERA, CAMERA_WITH_UPLOAD_FALLBACK, UPLOAD

4.19. Device

Info about the device used to do the onboarding.

Field Name Description Type

userAgent

user-agent of the browser used to do the onboarding.

String

4.20. DispatchInfo

Information about what was sent to the user.

Field Name Description Type

notificationType
required

NotificationTypeEnum

subject

If link was sent by email, the subject of the mail received by the user.

String

msg
required

Message encapsulating the link that the user received.
Example: Click here https://goo.gl/NqMoXJ to start capturing documents for your car rental application.

String

4.21. DocToCapture

Describe a document to capture.

Field Name Description Type

code
required

Code to associate with the captured document when returning the result.
Example: OWNER_ID

String
max-length: 20

docTypes
required

List of accepted document type.

List of DocToCaptureTypeEnum

optional

Flag indicating that the document capture is optional, SELFIE and LIVENESS documents can not be optional.
Default: false

Boolean

versoHandling

VersoHandlingEnum

livenessReferenceDoc

LivenessReferenceDoc

withDocLiveness

[NOT WORKING] This flag indicates the document must be captured as a video, only allowed for ID documents (and only some models). Please get in touch with your CSM for more information.
Default: false

Boolean

label

Title of the page used to capture the document.
⇒ If null, the default value will be used.
WARNING, mandatory for document of type OTHER
Example: Car owner ID card

String
max-length: 30

description

Description of the document, to display in the web page used to capture the document.
⇒ If null, the default value will be used.
WARNING, mandatory for document of type OTHER
Example: Please, take a picture of the trunk owner national identity card.

String
max-length: 150

4.22. DocToCaptureTypeEnum

Indicate the type of document.
- ID national identity card (Identity analysis)
- P passport (Identity analysis)
- V visa (Identity analysis)
- DL driving license (Identity analysis)
- HC health card (Identity analysis)
- RP resident permit (Identity analysis)
- SELFIE picture of user (Face detection)
- LIVENESS Liveness detection (Liveness analysis)
- KBIS company registration (not analysed)
- RIB bank account identity (not analysed)
- ADR_PROOF residence certificate (not analysed)
- PAY_SHEET remuneration statement (not analysed)
- TAX_SHEET tax bill (not analysed)
- CAR_REG car registration (Identity analysis)
- OTHER other type of document (not analysed)

Allowed values: ID, P, V, DL, HC, RP, SELFIE, KBIS, RIB, ADR_PROOF, PAY_SHEET, TAX_SHEET, CAR_REG, LIVENESS, OTHER

4.23. DocumentContent

Content of a captured document.

Field Name Description Type

code
required

docCode of the document
Example: DOC1

String

docContents
required

List containing the document base64 contents that were captured, either one or both sides, base64 encoded.

List of
String

4.24. Error

Object returned when there is an error and which shows detail about the error.

Field Name Description Type

httpCode
required

http code associated with the error.
Example: 400

Integer (int32)

errorCode
required

error business identifier.
Example: V_CONF_CODE_TAKEN

String

message
required

readable explanation of the error.
Example: The configuration referenced for your onboarding does not exist, code : FakeCode.

String

data

can contain extra data about the error.

Object

4.25. ExtraData

Extra information about the payload.

Field Name Description Type

missingOptionalDocs
required

List of the optional documents codes that the user chose not to capture.

List of
String

device

Device

4.26. HateoasLinkRel

Type of link available.
- CIS_FILE link to the CIS File resource where the captured documents have been pushed.
- CIS_FILE_CHECK if fileLaunchCheck and fileCheckWait are true, link to the CIS File check.
- CIS_FILE_CHECK_TASK if fileLaunchCheck is true and fileCheckWait is false, link to the CIS task handling the CIS File check.
- CIS_DOCUMENT link to the CIS Document resource where the capture has been analysed.
- CIS_DOCUMENT_CHECK link to the CIS Document check result.
- CIS_DOCUMENT_CHECK_TASK link to the CIS Document task being analysed.
- CIS_LIVENESS_CHECK_TASK link to the CIS Liveness document task being analysed.
- ONBOARDING_STATUS link to the current onboarding status

Allowed values: CIS_FILE, CIS_FILE_CHECK, CIS_FILE_CHECK_TASK, CIS_DOCUMENT, CIS_DOCUMENT_CHECK, CIS_DOCUMENT_CHECK_TASK, CIS_LIVENESS_CHECK_TASK, ONBOARDING_STATUS

Link related to the resource.

Field Name Description Type

rel
required

HateoasLinkRel

href
required

a complete URL that uniquely defines the relationship
Example: http://localhost:8080/customer/1

String

4.28. HeaderLogoAlignEnum

Header logo alignment.
- LEFT (default)
- RIGHT
- CENTER

Allowed values: LEFT, RIGHT, CENTER

4.29. HealthIndicator

Health indicator for the SDK-Web service.

Field Name Description Type

status
required

HealthStatus

details

Map containing the version of the application with key 'version'

Map of
Object

4.30. HealthStatus

Health status.
- UP indicating that the component or subsystem is functioning as expected.
- DOWN indicating that the component or subsystem has suffered an unexpected failure.
- UNKNOWN indicating that the component or subsystem is in an unknown state.
- OUT_OF_SERVICE indicating that the component or subsystem has been taken out of service and should not be used.

Allowed values: UP, DOWN, UNKNOWN, OUT_OF_SERVICE

4.31. InterfaceSettings

Settings to personalise the capture web application interface.

Field Name Description Type

confCode

Identifier of the configuration to use.
Example: MyConf_01

String
max-length: 20

wording

ItineraryWording

language
required

LanguageEnum

widgetConf

Components’s configuration in raw JSON

Object

4.32. IpsInterfaceSettings

Settings to personalise the capture web application interface for Identity Proofing flow.

Field Name Description Type

confCode

Identifier of the configuration to use.
Example: MyConf_01

String
max-length: 20

language
required

LanguageEnum

widgetConf

Components’s configuration in raw JSON

Object

4.33. ItineraryWording

indicate how to handled verso of the document.
- DEFAULT trust IDnow algorithm on verso handling (No verso requested if the document is not analysed).
- MANDATORY always ask for a verso, user is not allowed to skip its capture (Useful for documents that are not analysed).
- OPTIONAL always ask for a verso, but user is allowed to skip its capture (Useful for documents that are not analysed).

Field Name Description Type

homeTitle

Title displayed on the landing page.
Example: MyBrand mobile capture exp'

String
max-length: 30

homeMsg

Message displayed on the landing page.
Example: Welcome to the first step of your registration with MyBrand.

String
max-length: 150

authentInputMsg

Text displayed into the input of Home page.
Example: Identification code

String
max-length: 30

authentHelpMsg

Text displayed under the connect button to help user retrieve its connexion code.
Example: Your Identification code has been communicated on the previous

String
max-length: 150

errorMsg

Message to display when a user associated with this configuration gets a device error or a technical error (Should not happen).
Example: The onboarding cannot go further because of an issue with your device or the service. Please go back to our platform

String
max-length: 150

onboardingEndMsg

Message to display on the end page (Above the redirect button when using redirection mode).
Example: Click the link bellow to go back to your web form.

String
max-length: 150

expiredMsg

Message to display when a user click an expired link associated with this configuration.
Example: The link you clicked has expired, please go back to my-brand.com to generate a new one.

String
max-length: 150

linkEmailSubject

Subject of the mail containing the link.
Example: MyBrand car rental mobile capture

String
max-length: 150

linkEmailMsg

Message displayed in the e-mail to invite the client to begin the capture.
The link can be positioned in the message by using {} else it’ll be added at the end of the message.
Allows the following HTML tags, a, b, blockquote, br, cite, code, dd, dl, dt, em, i, li, ol, p, pre, q, small, span, strike, strong, sub, sup, u, ul and appropriate attributes.
Links can point to http, https, ftp, mailto.
Escape double quotes with a backslash.
Example: <a href="{}">Click me</a> to start capturing documents for your car rental application.

String
max-length: 1500

linkEmailSignature

Signature displayed in the e-mail after linkEmailMsg.
Allows the following HTML tags, a, b, blockquote, br, cite, code, dd, dl, dt, em, i, li, ol, p, pre, q, small, span, strike, strong, sub, sup, u, ul and appropriate attributes.
Links can point to http, https, ftp, mailto.
Escape double quotes with a backslash.
Example: Mr EXAMPLE Example <br> Developer at <a href="http://my-company.com">My Company</a>

String
max-length: 1000

linkSmsMsg

Message displayed in the SMS to invite the client to begin the capture.
The link can be positioned in the message by using {} else it’ll be added at the end of the message.
Only GSM 7-bit alphabet characters are accepted. See Standard GSM 03.38 : https://en.wikipedia.org/wiki/GSM_03.38
Example: Click here {} to start capturing documents for your car rental application.

String
max-length: 120

4.34. ItineraryWordingAllOf

Field Name Description Type

linkEmailSubject

Subject of the mail containing the link.
Example: MyBrand car rental mobile capture

String
max-length: 150

linkEmailMsg

Message displayed in the e-mail to invite the client to begin the capture.
The link can be positioned in the message by using {} else it’ll be added at the end of the message.
Allows the following HTML tags, a, b, blockquote, br, cite, code, dd, dl, dt, em, i, li, ol, p, pre, q, small, span, strike, strong, sub, sup, u, ul and appropriate attributes.
Links can point to http, https, ftp, mailto.
Escape double quotes with a backslash.
Example: <a href="{}">Click me</a> to start capturing documents for your car rental application.

String
max-length: 1500

linkEmailSignature

Signature displayed in the e-mail after linkEmailMsg.
Allows the following HTML tags, a, b, blockquote, br, cite, code, dd, dl, dt, em, i, li, ol, p, pre, q, small, span, strike, strong, sub, sup, u, ul and appropriate attributes.
Links can point to http, https, ftp, mailto.
Escape double quotes with a backslash.
Example: Mr EXAMPLE Example <br> Developer at <a href="http://my-company.com">My Company</a>

String
max-length: 1000

linkSmsMsg

Message displayed in the SMS to invite the client to begin the capture.
The link can be positioned in the message by using {} else it’ll be added at the end of the message.
Only GSM 7-bit alphabet characters are accepted. See Standard GSM 03.38 : https://en.wikipedia.org/wiki/GSM_03.38
Example: Click here {} to start capturing documents for your car rental application.

String
max-length: 120

4.35. LanguageEnum

Define the language (ISO_639-1) of the screens.
Careful, customized Wording messages (onboarding or configuration) have to be in the correct language.

Allowed values: EN, FR, IT, ES, DE, RO, CS, PL, PT, NL, AR, UK, SK, HU, BG, SQ, SR

4.36. LinkInfo

Response when the link was successfully sent to the user.

Field Name Description Type

uid
required

unique identifier of the onboarding.
Example: 110e8400-e29b-11d4-a716-446655440000

String

url
required

Full url of the link.
Example: https://sdkweb.idcheck.io/your-path/uid_onboarding/welcome

String

shortenedLink
required

Shortened link of the onboarding (to lower message size if you use your own SMS broker)
Example: https://p.idcheck.io/hjghjYUyu

String

expirationDate
required

Date after which the onboarding can be closed as expired. (Format: RFC3339)
Example: 2017-07-21T17:32:28Z

Date (date-time)

dispatchInfo

DispatchInfo

4.37. LivenessReferenceDoc

For Liveness analysis, define how to find the reference document needed for comparison into liveness analysis.

Field Name Description Type

location
required

LivenessReferenceDocLocationEnum

value
required

The CIS ID or document code for reference document.
Example: MY_ONBOARDING_DOCUMENT_REFERENCE_CODE

String
max-length: 50

4.38. LivenessReferenceDocLocationEnum

Where to find the Liveness reference document:
- ONBOARDING: the reference document is into the current list of documents to be captured during this onboarding.
- CIS: the reference document is already into the CIS.

Allowed values: ONBOARDING, CIS

4.39. NotificationEndpoint

Notification endpoint defined by a Customer.

Field Name Description Type

code
required

Unique identifier defined by the user.
Example: My_Endpoint_01

String
max-length: 20

url
required

Url used for the callback. Must be public.
Example: http://my-public-url.com/callback

String
max-length: 256

securityHeaderField

SecurityHeaderField

subscribedEvents
required

List of subscribed events.

List of NotificationEventEnum

active

Optional activation field.
Default: true

Boolean

useSsl

Flag to indicate if the call has to use SSL.
Default: true

Boolean

4.40. NotificationEventData

Part of the notification payload that is specific to SDK-Web and set in the eventData attribute.

Field Name Description Type

businessUid

The onboarding businessUid you might have set at creation
Example: my_business_identifier

String
max-length: 50

endpointCode
required

The Notification endpoint associated with the notification.
Example: my_endpoint_code

String
max-length: 20

onboardingStatus
required

OnboardingStatusEnum

withQualityIssues

Flag to indicate if at least one document captured has quality issues (true).
This happens when the user is not able to push an issue less document after several tries.
Default: false

Boolean

cisData

CisFileData

errorCause

OnboardingEndErrorCause

4.41. NotificationEventEnum

The notification events available to subscribe to

Allowed values: START_ONBOARDING, END_ONBOARDING

4.42. NotificationTypeEnum

Canal used to contact the user.
NONE value is only allowed when doing onboarding search.

Allowed values: EMAIL, PHONE, NONE

4.43. OnboardingDefinition

Object sent to require onboarding initialization, can also trigger the link to be sent to the user and allow wording customizing.

Field Name Description Type

businessUid

Business related identifier defined by you, must be unique.
Example: MY_ID

String
max-length: 50

interfaceSettings
required

InterfaceSettings

redirectionData

RedirectionData

contactData

ContactData

resultHandler

ResultHandler

documentsToCapture
required

List of documents definitions.

List of DocToCapture

endpointsToNotify

List of notification endpoints code to notify during the onboarding

List of
String

options

OnboardingOptions

4.44. OnboardingDescription

The description of an onboarding are returned by the /onboarding path

Field Name Description Type

uid
required

unique identifier of the onboarding.
Example: 110e8400-e29b-11d4-a716-446655440000

String

businessUid

Business related identifier defined by you, must be unique.
Example: MY_ID

String
max-length: 50

link
required

Full url of the link.
Example: https://sdkweb.idcheck.io/your-path/uid_onboarding/welcome

String

shortenedLink
required

Shortened link of the onboarding (to lower message size if you use your own SMS broker)
Example: https://p.idcheck.io/hjghjYUyu

String

customerLogin
required

Customer associated with the onboarding.
Example: myAccount

String

confCode
required

Customer associated with the onboarding.
Example: myConfCode

String

creationDate
required

Date at which the onboarding was created. (Format: RFC3339)
Example: 2017-07-21T17:32:28Z

Date (date-time)

lastUseDate
required

Latest date at which the user used the link. (Format: RFC3339)
Example: 2017-07-21T17:32:28Z

Date (date-time)

expirationDate
required

Date after which the onboarding can be closed as expired. (Format: RFC3339)
Example: 2017-07-21T17:32:28Z

Date (date-time)

notificationType
required

NotificationTypeEnum

status
required

OnboardingStatusEnum

errorCause

OnboardingEndErrorCause

nbLandingPageLoaded
required

Number of time the landing page was loaded (Link click or Page refresh).
Example: 4

Integer (int32)

customerHash
required

Hash of the customer identifier
Example: 08776783fds7982189869787sd93763294ds

String

captures

Data about the doc captures.

List of CaptureDocData

4.45. OnboardingEndErrorCause

Cause of the error that terminated the onboarding.

Field Name Description Type

code
required

OnboardingEndErrorCauseCodeEnum

details

More details about the origin of the error
- WRONG_TYPE The document was identified but did not match the expected types (outside PVID).
- MODEL_REJECTED The document was identified but did not match the eligible types (based on Customer Configuration filtering list).
- ANALYSIS_EXPIRED_DOC The document was identified but its expiration date is not valid.
- UNIDENTIFIED The document was not identified.
- INVALID_VERSO The verso is not compatible with recto.
- NO_FACE The document do not have the needed Face.
- DOC_NOT_USABLE_FACEREC (outside PVID) The document is not eligible for Biometric check.
- PVID_NOT_ELIGIBLE IPS The document is not eligible for PVID Onboarding.
- ETSI_NOT_ELIGIBLE IPS The document is not eligible for ETSI Onboarding.
- QUALITY_ISSUES (outside PVID).
- OPENTOK_API_ERROR (outside PVID).
- SESSION_CLOSED_BY_USER Session closed by user.
- NETWORK_TOO_SLOW_ERROR Network too slow.
- DEVICE_ROTATED_ERROR Device rotated.
- CAMERA_NOT_FOUND No camera detected.
- CAMERA_ACCESS_DENIED Access to camera is forbidden.
- CAMERA_ACCESS_TIMEOUT Timeout while trying to get camera access.
- CAMERA_NOT_READABLE Camera already used by another application.
- BROWSER_NOT_SUPPORTED Browser or device not supported.
- NO_AUDIO_DETECTED (outside PVID) Invalid video.
- VIDEO_ERROR Video quality error (resolution or framerate too low).
- ONBOARDING_ALREADY_CONSUMED User tries to launch a link of an onboarding already started

String

4.46. OnboardingEndErrorCauseCodeEnum

Code of the error that terminated the onboarding.
- NETWORK_ERROR Connectivity error
- USER_ERROR Related to a user action.
- DEVICE_ERROR Related to the device’s capabilities (unsupported browser, camera…​).
- DOCUMENT_ERROR Related to the document pushed by user (rejected, unidentified…​).
- INTERNAL_ERROR There was an unexpected technical error during the onboarding.

Allowed values: NETWORK_ERROR, USER_ERROR, DEVICE_ERROR, DOCUMENT_ERROR, INTERNAL_ERROR

4.47. OnboardingEndStatusEnum

Indicate if the onboarding was successful or not.
- SUCCESS capture was successful, analysis results are available.
- ERROR there was an error during the capture or while pushing the captured document, see errorDetail.

Allowed values: SUCCESS, ERROR

4.48. OnboardingIpsDefinition

Object sent to require PVID onboarding initialization, can also trigger the link to be sent to the user.

Field Name Description Type

identityProofingId
required

Must be equal to the Identity Proofing UID corresponding to the onboarding.

String

redirectionData

RedirectionData

contactData

ContactData

interfaceSettings
required

IpsInterfaceSettings

options

OnboardingIpsOptions

4.49. OnboardingIpsOptions

Options used for configuring.

Field Name Description Type

iframeRedirectParent

Indicates if the redirection in the iframe should be applied to parent window (true) or just to iframe (false)
Default: false

Boolean

4.50. OnboardingNotification

The notification payload sent to your server

Field Name Description Type

accountId
required

Unique identifier for the user.
Example: user.sdkweb.cis

String
max-length: 64

appId
required

Identifier of the App which triggered the notification. It’ll always be SDK-Web
Example: SDK-Web

String
max-length: 20

resourceId
required

The uid returned when you created the onboarding.
Example: 26324621-2688-47c4-904d-3cbc07ed4a56

String
max-length: 36

resourceType

The type of the resource, it’ll always be ONBOARDING.
Example: ONBOARDING

String
max-length: 20

event
required

NotificationEventEnum

eventDate
required

Notification date creation
Example: 2017-07-21T17:32:28Z

String

eventData
required

NotificationEventData

links
_required

Hateoas links associated with the onboarding.

List of HateoasLinks

4.51. OnboardingOptions

Options used for configuring.

Field Name Description Type

identificationCode

The identification code needed for authentication.
Example: ABC-1234-def

String
max-length: 50

iframeDisplay

Indicates if the itinerary will be displayed into iframe so header is hidden and responsiveness is disabled.
Default: false

Boolean

iframeRedirectParent

Indicates if the redirection in the iframe should be applied to parent window (true) or just to iframe (false)
Default: false

Boolean

consent

OnboardingOptionsConsent

legalMentions

OnboardingOptionsLegalMentions

captureMode

DeprecatedCaptureModeEnum

captureModeDesktop

CaptureModeEnum

captureModeMobile

CaptureModeEnum

4.52. OnboardingOptionsConsent

Object for user consent.

Field Name Description Type

biometricConsent

The user consent for automated processing of Biometric documents (Selfie & Liveness).
If undefined, a consent page will be displayed before the biometric document capture.
If set to true, no consent page will be shown, the user is considered as having given his consent, so the biometric document will be analysed automatically.
If set to false, no consent page will be shown, the user is considered as having declined his consent, so the biometric document will be captured but not automatically analysed.

Boolean

4.53. OnboardingOptionsLegalMentions

Object containing various options concerning legal mentions

Field Name Description Type

hideLink

Indicates if Legal Mentions (Cookies handling, automatic data processing…​) are displayed outside SDK-Web.
Thus IDnow default legal mentions should not be displayed in the itinerary.
Default: false

Boolean

externalLink

Indicates the url of an external web page containing the legal mentions (Cookies handling, automatic data processing…​).
If this option is not set, the IDnow default legal mentions will be displayed in the itinerary

String

4.54. OnboardingPaginatedResults

The description of an onboarding are returned by the /onboarding path

Field Name Description Type

totalResults
required

Total number of results.
Example: 168

Integer (int32)

totalPages
required

Total number of pages to display those results
Example: 4

Integer (int32)

numberPerPage
required

Number of result per page
Example: 50

Integer (int32)

currentPage
required

Active page.
Example: 1

Integer (int32)

distinctUsers
required

Number of distinct user, each clicked link count for a distinct one.
Example: 1

Integer (int32)

distinctBusinessUid
required

Number of distinct businessUid in the results. Onboarding without business uid does not count.

Integer (int32)

pageResults
required

Results matching that page.

List of OnboardingDescription

4.55. OnboardingResults

Object containing the final results of the onboarding, once it’s complete.
If status is OK, it will contain missingOptionalDocs & analysisResults.
If status is not OK, it will contain errorDetail.

Field Name Description Type

uid
required

unique identifier of the onboarding.
Example: 110e8400-e29b-11d4-a716-446655440000

String

businessUid

Business related identifier defined by you.
Example: MY_ID

String
max-length: 50

status
required

OnboardingEndStatusEnum

analysisResults

List of AnalysisResults

cisData

CisFileData

extraData

ExtraData

4.56. OnboardingStatusEnum

Status of the onboarding.
- CREATED the onboarding was initialized (Onboarding still active).
- CLICKED the user reached the onboarding starting page (Onboarding still active).
- CAPTURE_ONGOING the user captured at least one document but did not yet complete the onboarding (Onboarding still active).
- SUCCESS the onboarding was completed.
- EXPIRED the onboarding expired before the user completed it and was automatically closed.
- ERROR the onboarding was terminated because of an error, see errorDetail.

Allowed values: CREATED, CLICKED, CAPTURE_ONGOING, SUCCESS, EXPIRED, ERROR

4.57. OnboardingStatusResults

Status if the onboarding, contains results as well if the onboarding reached the end.

Field Name Description Type

uid
required

unique identifier of the onboarding.
Example: 110e8400-e29b-11d4-a716-446655440000

String

status
required

OnboardingStatusEnum

errorCause

OnboardingEndErrorCause

result

OnboardingResults

message

Information message.(Like to warn that the results are not available anymore if delay expired).
Example: OnboardingResults not available anymore, the delay of 24 hours expired.

String

4.58. OnboardingWording

The customisable wording used during the capture process.

Field Name Description Type

homeTitle

Title displayed on the landing page.
Example: MyBrand mobile capture exp'

String
max-length: 30

homeMsg

Message displayed on the landing page.
Example: Welcome to the first step of your registration with MyBrand.

String
max-length: 150

authentInputMsg

Text displayed into the input of Home page.
Example: Identification code

String
max-length: 30

authentHelpMsg

Text displayed under the connect button to help user retrieve its connexion code.
Example: Your Identification code has been communicated on the previous

String
max-length: 150

errorMsg

Message to display when a user associated with this configuration gets a device error or a technical error (Should not happen).
Example: The onboarding cannot go further because of an issue with your device or the service. Please go back to our platform

String
max-length: 150

onboardingEndMsg

Message to display on the end page (Above the redirect button when using redirection mode).
Example: Click the link bellow to go back to your web form.

String
max-length: 150

expiredMsg

Message to display when a user click an expired link associated with this configuration.
Example: The link you clicked has expired, please go back to my-brand.com to generate a new one.

String
max-length: 150

4.59. OwnerData

Data related to the document owner (Only extracted from MRZ documents).

Field Name Description Type

lastNames

List of
String

firstNames

List of
String

birthDate

DateObject

4.60. RedirectionData

Configuration used to redirect the user’s browser to you at the end of the onboarding.

Field Name Description Type

successRedirectUrl
required

Url to redirect the user once the capture process is done and results have been sent to the callback url.
This is useful when the user is already on mobile before onboarding.
Example: http://mybrand.com/userform/uid?capture=done

String
max-length: 300

errorRedirectUrl

Url to redirect the user if there is an issue with the onboarding.
This is useful when the user is already on mobile before onboarding.
Example: http://mybrand.com/userform/uid/restart

String
max-length: 300

autoRedirect

By default at the end of the onboarding (success), there is a page with a customisable message and a button which trigger redirection.
If autoRedirect is at true, this last page is skipped and redirection occurs as soon as the onboarding and callback / CIS is done.
Default: false

Boolean

4.61. ResultHandler

How are the results forwarded at the end of the onboarding.
At least one solution is mandatory.

Field Name Description Type

cisConf

CisConf

4.62. SecurityHeaderField

Optional header field to authenticate the request as coming from IdCheckIo-SDK-Web.

Field Name Description Type

name
required

Name of the header.
Example: Api-key

String
max-length: 40

value
required

Value of the header.
Example: IdCheckIo-SDK-Web

String
max-length: 256

4.63. Theme

Theme to be applied to the mobile capture experience.

Field Name Description Type

logo

Logo displayed in the top left corner.
It should be a .png image with translucent background, encoded in base64 and weighting 256ko max.
For optimal display, keep a ratio equivalent to 186x40px.
Example: base64_encoding

String

titleTxtColor

Color applied to the Webapp home page title.
Has to be a valid hexadecimal color code.
Example: #4286f4

String
max-length: 10

headerBgColor

Background color for the header.
Has to be a valid hexadecimal color code.
Example: #4c5866

String
max-length: 10

bodyBgColor

Background color for the body.
Has to be a valid hexadecimal color code.
Example: #4c5866

String
max-length: 10

btnBgColor

Background color for the buttons.
Has to be a valid hexadecimal color code.
Example: #4c5866

String
max-length: 10

btnHoverBgColor

Background color when hovering over buttons.
Has to be a valid hexadecimal color code.
Example: #0a64ce

String
max-length: 10

btnTxtColor

Color for buttons text.
Has to be a valid hexadecimal color code.
Example: #aa7814

String
max-length: 10

btnBorderRadius

Defines the radius of the buttons corners.
Should be a valid border-radius value (no api validation is done).
see https://www.w3schools.com/cssref/css3_pr_border-radius.asp.
Example: 15px

String
max-length: 25

headerLogoAlign

HeaderLogoAlignEnum

hideHeaderBorder

Flag to indicate if the header border should be hidden (default:false)

Boolean

4.64. VersoHandlingEnum

indicate how to handled verso of the document.
- DEFAULT trust IDnow algorithm on verso handling (No verso requested if the document is not analysed).
- MANDATORY always ask for a verso, user is not allowed to skip its capture (Useful for documents that are not analysed).
- OPTIONAL always ask for a verso, but user is allowed to skip its capture (Useful for documents that are not analysed).

Allowed values: DEFAULT, OPTIONAL, MANDATORY