Bankident webview

This section includes step-by-step instructions on how to integrate Bankident webview.

Product overview

Solaris' standalone Bankident identification session in webview enables you to quickly identify your customer in a unified identification session. You only need to start an identification session, whereas Solaris handles the intermediate identification steps, allowing rapid integration and low maintenance efforts.

Webhooks

Solaris recommends subscribing to the following webhook events to better automate your processes. For detailed instructions on implementing Solaris webhooks, check the webhooks documentation.

• IDENTIFICATION_SESSION
• PERSON_CHANGED
• PERSON_DELETED
• PERSONMOBILENUMBER_CREATED
• PERSONMOBILENUMBER_DELETED

Integration flow

Integration steps

Integrate Solaris' Bankident webview by completing the following steps:

Setup

1. Collect the mandatory information and consent to the legal and regulatory requirements from the customer in your sign-up flow.
2. Create a person resource for your customer using POST Create person.
3. Create and verify the customer's mobile number.

Identification session creation

1. Trigger the identification process by creating an identification session using POST Create person identification session.
2. Redirect the customer to the URL returned from the previous call to complete the identification process.

You can find detailed descriptions of these steps and their related endpoints in the following sections.

Step 1: Collect customer data and create person resource

In this step, you must collect the mandatory data points from the customer in your sign-up flow, including all the timestamps of the customer's consent to the legal and compliance screens. Afterward, pass all the data points to Solaris by creating a person resource.

API reference

For a complete list of endpoints, properties, and examples related to the person resource, visit the following links:

• Person resource API reference:

  • POST Create person
  • GET Retrieve a person
  • PATCH Update person

Related webhook events

• PERSON_CHANGED
• PERSON_DELETED

POST Create person

This endpoint creates a person resource for your customer. You must collect the mandatory data points from your customer in the sign-up flow and pass them to Solaris in the request body of this endpoint.

• salutation
• first_name (including all middle names as printed on the ID document)
• last_name (including all name parts as printed on the ID document)
• birth_date
• nationality ISO 3166-1 alpha-2 codes
• address (Street, Number, City, Post Code, Country, State)
• mobile_number
• data_terms_signed_at (UTC timestamp)
• terms_conditions_signed_at (UTC timestamp)

Request URL

POST /v1/persons

Response

The API returns a person object with a unique ID for the person (i.e., the person_id). You will need this id to append the person resource with additional information in the remaining steps of this guide.

Click here to view the full API reference

PATCH Update person

This endpoint updates one or more properties on a person resource. You can only update the following properties using this endpoint:

• title
• salutation
• address (line_1, line_2, postal_code, city, state, country)
• contact_address (line_1, line_2, postal_code, city, state, country)
• employment_status
• job_title
• email
• tax_information (tax_assessment, marital_status)
• fatca_relevant
• fatca_crs_confirmed_at
• business_purpose
• industry
• industry_key
• own_economic_interest_signed_at
• aml_confirmed_on (only with today or tomorrow's date)
• expected_monthly_revenue_cents
• vat_number
• website_social_media
• business_trading_name
• nace_code
• business_address_line_1
• business_address_line_2
• business_postal_code
• business_city
• business_country
• annual_income_range
• data_terms_signed_at
• branch
• birth_province
• birth_post_code
• socioprofessional_category
• purpose_of_account_opening
• main_income_source
• work_country
• work_province
• self_declared_as_pep
• international_operativity_expectation
• registration_number

Request URL

PATCH /v1/persons/{id}

Click here to view the full API reference

Step 2: Create and verify mobile number

In this step, you must collect the customer's mobile number in your sign-up flow and then create a mobile number resource and verify it by sending an SMS OTP to the customer's mobile number. Afterward, the customer enters the received OTP to verify their number.

Mobile number resource

Creating and verifying a mobile number for your customer is a crucial step in the customer onboarding process. With a verified mobile number, customers can use SMS OTPs to complete two-factor authentication (2FA) challenges, which is a requirement for Strong Customer Authentication (SCA).

API reference

Visit the following link to find all the endpoints related to the mobile number resource, including related properties and examples.

• Mobile number resource API reference

Related webhook events

• PERSON_MOBILE_NUMBER_CREATED
• PERSON_MOBILE_NUMBER_DELETED

POST Create mobile number

Collect the customer's mobile number and pass it to Solaris using the following API call, and include the customer's person_id in the request URL.

Request example:

POST /v1/persons/{person_id}/mobile_number
{
  "number": "+15550101"
}

Response example:

The API returns a mobile_number resource with a unique id and attaches it to the person resource.

{
    "id": "91e4d939d781b8eb30d1ee86809761c2cmno",
    "number": "+15550101",
    "verified": false
}

Click here to view the full API reference.

POST Authorize mobile number

Use the following endpoint to verify the ownership of the provided mobile phone number. The endpoint initiates a one-time-password (OTP) flow: Solaris sends a six-digit OTP to the customer's number, and then they must enter it in your UI.

Request example:

POST /v1/persons/{person_id}/mobile_number/authorize
{
  "number": "+15550101"
}

Response example:

{
    "id": "91e4d939d781b8eb30d1ee86809761c2cmno",
    "number": "+15550101",
    "verified": false
}

Click here to view the full API reference..

POST Confirm mobile number

Use this endpoint to submit the SMS OTP the customer received on their mobile number to finalize the mobile number authorization process. You must add the customer's number and token (i.e., the SMS OTP) in the request body. Afterward, the mobile number will be verified and can be used in the context of Strong Customer Authentication (SCA).

Request example:

POST /v1/persons/{person_id}/mobile_number/confirm
{
  "number": "+15550101",
  "token": "212212"
}

Response example:

{
    "id": "91e4d939d781b8eb30d1ee86809761c2cmno",
    "number": "+15550101",
    "verified": true
}

Click here to view the full API reference.

Mobile number management

For more information about how to manage mobile numbers, check the related guide.

Step 3: Create person identification session

In this step, you must create an identification session for the customer to start the identification process. The identification session is a series of screens containing all the intermediate identification steps your customer must complete in a single identification webview session.

(Optional) POST Check identification eligibility

As an initial verification step, you can check whether the relevant customer is eligible for the given identification method or not based on their data, such as nationality, place of residence, or identification document.

This endpoint validates whether the person specified in the request URL is eligible to complete a given identification method. You must add the identification method for which you want to check the customer's eligibility in the request body.

Request example

POST /v1/persons/{person_id}/identification_eligibility_checks
{
  "method": "bank"
}

Response example

The API call returns a response as to whether the person is eligible for identifying with a particular method or not. In case of failure, a reason is provided in the field failure_reason.

{
    "method": "bank",
    "eligible": true,
    "failure_reason": "null"
}

Click here to view the full API reference

(Optional) POST Validate IBAN

Solaris offers an endpoint for validating the IBAN supplied by the customer. If the IBAN is valid, then the API will return information about the account's associated bank.

Request URL

POST /v1/iban_lookups

Click here to view the full API reference.

POST Create person identification session

This endpoint creates an identification session for the person specified in the request URL. You must include a callback_url for the end of the flow and set the identification_methods to be used for the identification.

Request example

POST /v1/persons/:person_id/identification_sessions
{
    "callback_url": "https://www.callbackurl.com",
    "identification_methods": [
        "bank"
    ]
}

Response example

The API call returns an object for the identification session with a unique id and the url to which you must redirect the customer to complete the identification process.

Additionally, the API response includes the status of the identification session. For a list of possible values for this field, check the appendix.

{
    "callback_url": "https://www.callbackurl.com",
    "status": "created",
    "id": "acdede097f821bd8037465d691f69506ises",
    "url": "https://person-onboarding.solaris-staging.de/9AXlUH0ptsZoFef2n8LKiqpEAizdJTjVQ4tzZeu1LpvqbK201REXFG_EBwiGTw0PLlHWCaA7NLOOcUh1u_a7HUpp7wYMNlGnzALka-v_9MVOxOIfN73lFjFg7JMtBdJO",
    "identification_methods": [
        "bank"
    ]
}

Click here to view the full API reference

GET Retrieve person identification session

This endpoint returns the information about the identification session created for a person. Register to the webhook event IDENTIFICATION_SESSION for status updates on the identification session.

Request example

GET /v1/persons/{person_id}/identification_sessions/{session_id}

Response example

200 Ok
{
    "callback_url": "https://www.callbackurl.com",
    "status": "created",
    "id": "acdede097f821bd8037465d691f69506ises",
    "url": "https://person-onboarding.solaris-staging.de/9AXlUH0ptsZoFef2n8LKiqpEAizdJTjVQ4tzZeu1LpvqbK201REXFG_EBwiGTw0PLlHWCaA7NLOOcUh1u_a7HUpp7wYMNlGnzALka-v_9MVOxOIfN73lFjFg7JMtBdJO",
    "identification_methods": [
        "bank"
    ]
}

Click here to view the full API reference

Webview session screens

This section includes information and descriptions about the different screens your customer will interact with to complete the identification process.

Introduction screen

This is the first screen the user interacts with after the URL redirect from your service. It provides context and prepares the customer for the next steps ahead.

Verify mobile number screens

The Bankident KYC session requires a verified mobile number to send OTP SMS for confirmations to the user. Solaris sends an SMS OTP to the customer's mobile number, and the customer must input this OTP into this screen to verify the number.

Customer input on this screen:

• SMS OTP to verify their mobile number

Verify bank account with cent transfer

Within the following screens, Solaris validates the customer's provided IBAN and verifies the bank account ownership with a cent transfer.

Screen 1: IBAN validation

On this screen, the customer is prompted to enter their IBAN. Then Solaris runs identity checks through SCHUFA to verify if the customer has been identified before with the provided IBAN.

Customer input on this screen:

• IBAN

Screen 2: Bank account login

The customer is prompted to log into their bank account to trigger the payment initiation in this screen. Through this step, Solaris verifies the account ownership.

Customer input on this screen:

• User ID
• Password

Screen 3: Confirm transaction

In this screen, the customer verifies that they have access to their account by confirming the cent transfer with the bank's 2FA method.

Customer input on this screen:

• SMS OTP

Confirm with Qualified Electronic Signature (QES)

After a successful payment transfer, the customer can proceed with signing the relevant contracts.

Screen 1: Contract signature

On this screen, the customer should be able to review and read the contracts that must be signed before the QES process starts.

Customer input on this screen:

• Download contract

Screen 2: Contract confirmation

In the following screens, the customer signs the relevant documents by entering an SMS OTP received on their verified mobile number. not

Customer input on this screen:

• SMS OTP

Screen 3: Successful completion

The customers successfully signed the contract(s)

What's next?

Congratulations! You've successfully integrated Solaris' Bankident webview solution.

Check the following appendix section for additional information on enums, testing data, and Bankident FAQs.

For an overview of other KYC methods, check the customer KYC products overview page.

Useful resources

Check the following links for additional related guides and API reference documentation:

• Customer identification (KYC) API reference
• Person Documents API reference

Appendix I: Enums

Identification session status

The following table includes the possible values for identification session status and their descriptions.

Appendix II: Testing data

Test scenarios

Your solution must consider the following edge cases for Bankident:

• The user data was not found.
• The user's IBAN could not be matched to the provided name.
• The account provided is a JOINT account (i.e., shared account).
• An authorized person on the account (i.e., someone who does not own the account) attempts to identify.
• Timeout of 10 minutes between payment initiation and finalization of QES.

You can test edge cases with the following mocked IBANs:

Happy path test scenario

Complete the following steps to simulate a successful identification workflow with Bankident on Sandbox.

1. Create a person

Create a person resource using the following endpoint and add the following fields in the request body.

Request

POST /v1/persons
{
    "salutation": "MR",
    "first_name": "Leander",
    "last_name": "Zierfisch",
    "address": {
        "line_1": "BERLINER STR. 45",
        "line_2": "",
        "postal_code": "14169",
        "city": "Berlin",
        "country": "DE"
    },
    "birth_date": "1978-07-15",
    "birth_city": "Aachen",
    "birth_country": "DE",
    "nationality": "DE",
    "email": "person@example.com",
    "employment_status": "EMPLOYED",
    "fatca_relevant": "false",
    "fatca_crs_confirmed_at": "2019-01-01T00:00:00Z",
    "terms_conditions_signed_at": "2019-01-01T00:00:00Z",
    "own_economic_interest_signed_at": "2019-01-01T00:00:00Z"
}

2. Create and verify a mobile number

You can follow the same steps mentioned in the guide and use the static values.

3. Create an identification

Create an identification resource and specify the identification method as bank in the request body of the following endpoint. Add the person_id returned from the previous API call to the request URL. Additionally, include the iban for a successful identification

Request example

POST /v1/persons/{person_id}/identifications
{
  "method": "bank",
  "iban": "DE11110101010100000020",
  "terms_and_conditions_signed_at": "2020-07-07T11:36:29.000Z"
}

4. Trigger the identification

To trigger the identification flow, call the following endpoint and add the person_id and the identification id returned from the previous API calls to the request URL.

Request example

PATCH /v1/persons/{person_id}/identifications/{id}/request

Response

{
    "id": "a7a57dadfcc83117b5c3b72f4113be25cidt",
    "reference": null,
    "url": "https://fts-payment-initiation-wizard.solaris-sandbox.de/index.html?wizard_session_key=bfo5r16AMLlt6ZEX9Oh3JUWIkTelorupBwzIlJRR&interface_id=da05",
    "status": "pending",
    "completed_at": null,
    "method": "bank",
    "proof_of_address_type": null,
    "proof_of_address_issued_at": null,
    "iban": "DE11110101010100000020",
    "terms_and_conditions_signed_at": "2020-07-07T11:36:29.000Z",
    "authorization_expires_at": null,
    "confirmation_expires_at": null,
    "estimated_waiting_time": null
}

5. Complete the payment transfer step

Go to the URL returned in the previous call and enter any number for the account number and the banking PIN and click NEXT. This screen simulates a login screen, in which the customer must log into their online banking and authorize a 5-cent transfer to validate the account ownership.

After clicking NEXT, another screen will pop up and you have to enter any TAN number to authorize the transaction. This screen simulates the screen in which the customer must enter the SMS OTP they received on their verified mobile number to authorize the transaction.

6. Complete the QES step

After successful payment transfer, complete the QES process by doing the following steps:

1. Call PATCH Start e-signing process. Add the person_id and identification id in the request URL.

Request

PATCH /v1/persons/{person_id}/identifications/{id}/authorize

Response

{
    "id": "a7a57dadfcc83117b5c3b72f4113be25cidt",
    "reference": null,
    "url": "https://fts-payment-initiation-wizard.solaris-sandbox.de/index.html?wizard_session_key=bfo5r16AMLlt6ZEX9Oh3JUWIkTelorupBwzIlJRR&interface_id=da05",
    "status": "confirmation_required",
    "completed_at": null,
    "method": "bank",
    "proof_of_address_type": null,
    "proof_of_address_issued_at": null,
    "iban": "DE11110101010100000020",
    "terms_and_conditions_signed_at": "2020-07-07T11:36:29.000Z",
    "authorization_expires_at": "2022-08-11T08:38:21.000Z",
    "confirmation_expires_at": "2022-08-11T08:37:23.000Z",
    "current_reference_token": "1234-5678",
    "estimated_waiting_time": null
}

2. Call PATCH Confirm e-signing process. Add the person_id and identification id in the request URL.

Request

PATCH /v1/persons/{person_id}/identifications/{id}/confirm

Response

{
    "id": "a7a57dadfcc83117b5c3b72f4113be25cidt",
    "reference": null,
    "url": "https://fts-payment-initiation-wizard.solaris-sandbox.de/index.html?wizard_session_key=bfo5r16AMLlt6ZEX9Oh3JUWIkTelorupBwzIlJRR&interface_id=da05",
    "status": "confirmed",
    "completed_at": null,
    "method": "bank",
    "proof_of_address_type": null,
    "proof_of_address_issued_at": null,
    "iban": "DE11110101010100000020",
    "terms_and_conditions_signed_at": "2020-07-07T11:36:29.000Z",
    "authorization_expires_at": "2022-08-11T08:38:21.000Z",
    "confirmation_expires_at": "2022-08-11T08:37:23.000Z",
    "current_reference_token": "1234-5678"
}

3. Afterward, call GET Retrieve a person identification and the response should include a successful status and the signed documents with their IDs.

Request

GET /v1/persons/{person_id}/identifications/{id}

Response

{
    "id": "a7a57dadfcc83117b5c3b72f4113be25cidt",
    "reference": null,
    "url": "https://fts-payment-initiation-wizard.solaris-sandbox.de/index.html?wizard_session_key=bfo5r16AMLlt6ZEX9Oh3JUWIkTelorupBwzIlJRR&interface_id=da05",
    "status": "successful",
    "completed_at": "2022-08-11T08:29:43.000Z",
    "method": "bank",
    "proof_of_address_type": null,
    "proof_of_address_issued_at": null,
    "address": null,
    "documents": [
        {
            "id": "a6585ea2b053a69fb705a0eb963084cfcdoc",
            "name": "a7a57dadfcc83117b5c3b72f4113be25cidt_prepared_for_signing_kyc_report.pdf",
            "content_type": "application/pdf",
            "document_type": "QES_DOCUMENT",
            "size": 88139,
            "customer_accessible": false,
            "created_at": "2022-08-11T08:25:11.000Z"
        },
        {
            "id": "4d1aa91e091e375e30e94de4ab1cf0f4cdoc",
            "name": "SIGNED_a7a57dadfcc83117b5c3b72f4113be25cidt_prepared_for_signing_kyc_report.pdf",
            "content_type": "application/pdf",
            "document_type": "SIGNED_QES_DOCUMENT",
            "size": 88139,
            "customer_accessible": false,
            "created_at": "2022-08-11T08:29:43.000Z"
        }
    ],
    "iban": "DE11110101010100000020",
    "terms_and_conditions_signed_at": "2020-07-07T11:36:29.000Z",
    "authorization_expires_at": "2022-08-11T08:38:21.000Z",
    "confirmation_expires_at": "2022-08-11T08:37:23.000Z",
    "current_reference_token": "1234-5678"
}

Appendix III: Bankident rejection reasons and error codes

The following table includes the possible failure reasons for Bankident. These failure reasons are also relevant for Bankident+ method.

Appendix IV: Bankident FAQs

The following are common questions and answers related to the integration process of Bankident solution. If you have other questions or use cases not mentioned in this guide, contact your Partner Manager for support.

How many attempts with different IBANs can one "person" submit leading to receiving generic error messages on the identification creation?

20 attempts.

Does the user have to provide a DE IBAN or can it also be an IBAN with a different country code?

Currently, only German IBANs are supported for Bankident. If your customer doesn't have a German IBAN, check the other available identification methods here.

Can the user get their mobile phone number identified using every country code? Or does it have to be +49 for germany? Do you have a list of country codes allowed?

All country codes are supported except for Iran and North Korea.

Can the user have an address outside of Germany? If yes, which countries are allowed?

Yes, the user can have any kind of address. However, the probability that SCHUFA will correctly identify the person will decrease, since SCHUFA checks depend on the person's registered address.

How long is an SMS token valid?

The SMS authorization of the QES process is valid for 10 minutes.

Can a successful identification be "reused" by different companies?

There's no technical restrictions on reusing an identification. However, GDPR measures related to data cleanup must be defined.

Is there any timeout set for finishing the bank connection widget?

There is a 10-minute timeout.