Require Identification

Additional user identification can be added to the sign process. These extra steps first need to be completed before the user can sign the document. This extra information is included in the audit report. Please note that the identification methods first need to be configured for your account. Please contact your account manager if you want to use this feature.

Supported identification methods:

  • One Time Password via SMS (otp_sms): A code is sent separately to the invitee via SMS. They enter the verification code on the sign page. An E.164 phone number must be provided for the invitee in a phoneNumber field.
  • One Time Password via Email (otp_email): A code is sent separately to the invitee via Email. They enter the verification code on the sign page.
  • One Time Password via WhatsApp (otp_whatsapp): A code is sent separately to the invitee via WhatsApp. They enter the verification code on the sign page. An E.164 phone number must be provided for the invitee in a phoneNumber field.
  • One Time Password via Voice (otp_voice): A code is sent separately to the invitee via a phone call. They enter the verification code on the sign page. An E.164 phone number must be provided for the invitee in a phoneNumber field.
  • IBAN verification (iban): The user makes a one cent payment via their bank using iDEAL. After payment we receive the IBAN of their bank account.
  • iDIN (idin): The user performs an online identification via their bank. The name and date of birth will be requested.
  • Qualified signature (qualified): The user verifies their identity in a mobile app. The process includes a liveness check and requires an ID Document with NFC chip. When this identification method is used the invitee must have a unique position.

To add an identification for an invite set the following field on an invitee:

{
    "identificationMethods": [
        "idin"
    ]
}

identificationMethods: An array containing one or more identification methods.

Retrieve identification status

To retrieve the identification status the request below can be sent.

GET /dossiers/{dossierId}/invitees/{inviteeId}/identifications

Response

[
    {
        "identificationMethod": "idin",
        "status": "success",
        "result": {
            "transactionId": "123456789123456789",
            "issuerId": "ABNANL2A",
            "status": "success",
            "bin": "ABNANL2A3xOcyYKUhR8s0mS+tbkNO2xF2/U/Ns3eIyMOWYWmOZeUGw8StPKPhAdRTyN1XWne1rgJQA",
            "name": {
                "initials": "A",
                "firstName": "Andre",
                "lastName": "Dijk",
                "lastNamePrefix": "van"
            },
            "age": {
                "dateOfBirth": "1974-01-31",
                "18yOrOlder": true
            }
        }
    }
]

You usually don't have to retrieve the identification status, because a dossier can only be signed after the identification has been completed. When you received the dossier completed webhook or email, you know that the invitee has successfully identified themselves.