Skip to content
Customer Identification (...
/
/
Index all person identifi...

Customer Identification (KYC) (1.0)

All endpoints related to customer identifications (KYC).

Download OpenAPI description
identifications.json
identifications.yaml
Languages
Servers
Mock Server

https://docs.solarisgroup.com/_mock/api-reference/identity/identifications/

Person identifications

Operations

Retrieve a person identification

Request

Returns a completed person identification (i.e., the person identification process was successful). If you use the include_documents filter, this method will also return the documents submitted by the customer during the identification process.

Path
person_idstringrequired

The unique ID of the person resource created for a customer.

Example: dc1a6812a14f6cc338cd084208535bcdcper
idstringrequired

The unique ID of the identification resource created for a customer.

Example: 6dc54352d6793a892e0702850d07b831cidt
Query
include_documentsboolean

Specifies whether this method should include the documents submitted during the identification process in the response.

Default true
No request payload

Responses

Successful result of the operation

Bodyapplication/json
idstring

ID of the person identification.

Example: "9dfe2f4edaa67138be0c0c1cd3a7d849cidt"
referencestring

Reference generated by the identification provider.

Example: "TST-ELCCJ"
urlstring

(IDnow only) Redirect URL used to start the identification process.

Example: "https://go.test.idnow.de/company_id/identifications/identification_id"
statusstring

The current status of the identification. Note The status value depends on the identification method, check the KYC guides for more information.

Enum"aborted""authorization_required""confirmation_required""confirmed""created""canceled""expired""failed""identification_data_required""pending"
Example: "successful"
completed_atstring

Date and time when the identification was completed.

Example: "2021-09-14T18:18:28.000Z"
methodstring

The method used for the identification.

Enum"bank""bank_id""bank_plus""fourthline""idnow""idnow_autoident""idnow_custom""manual""postident"
Example: "idnow"
proof_of_address_typestring

The type of document submitted by the customer as a proof of address if their identification document did not include their address.

Enum"BANK_ACCOUNT_STATEMENT""CERTIFICATE_OF_REGISTRATION""ELECTRICITY_BILL""GAS_BILL""HEATING_BILL""INTERNET_BILL""TELEPHONE_BILL""WATER_BILL"
Example: "GAS_BILL"
proof_of_address_issued_atstring

The date when the proof of address document was issued.

Example: "2021-12-03"
languagestring

(IDnow only) The customer's preferred language for the identification process.

Enum"DE""EN"
Example: "EN"
person_idstring

ID of the person for whom the identification was initiated.

Example: "992de312a545bb24a88ddbf57ae8b1ffcper"
addressobject

The customer's address.

documentsArray of objects

Documents provided by the customer during the identification process.

Example: [{"id":"448b75fa1c57eecda41d91c66c22faa6cdoc","name":"file1.pdf","content_type":"application/json","document_type":"KYC_REPORT","size":803580},{"id":"94eb22a9311be9a1fbb698c448b0b337cdoc","name":"file2.jpg","content_type":"image/jpeg","document_type":"SIGNATURE","size":25349}]
failure_reasonstring or null

Additional context around why the identification failed. Value depends on the identification method.

ibanstring

Optional IBAN provided for bank and bank_id identifications. Please note that Solaris only accepts certain banks for the Bankident KYC flow. See the full list here.

Example: "DE11010101010101010100"
authorization_expires_atstring or null

The date and time by which the authorization for the end customer must be requested.

confirmation_expires_atstring or null

The date and time by which the customer must input the OTP sent to their mobile number for the QES process.

provider_status_codeinteger or null

(Fourthline only) Status code returned by the identification provider.

Enum1000100110021003100410051006100710081009
account_verification_errorstring or null

Session Error returned by Tink in the account verification process. Will only be populated when failure_reason is account_snaphot_failed or account_snapshot_expired. Only present for identifications within identification session.

Enum"accounts_failed""client_aborted""init_failed""login_failed""login_next_failed""max_login_tries""max_tan_tries""no_compatible_accounts""pinned_iban_not_found""security_setting_rejection"
idnow_process_typestring

When method idnow is selected, the process type will reflect which idnow process was chosen.

Example: "eid"
Response
application/json
{
  "id": "9dfe2f4edaa67138be0c0c1cd3a7d849cidt",
  "reference": "TST-ELCCJ",
  "url": "https://go.test.idnow.de/company_id/identifications/identification_id",
  "status": "successful",
  "completed_at": "2021-09-14T18:18:28.000Z",
  "method": "idnow",
  "proof_of_address_type": "GAS_BILL",
  "proof_of_address_issued_at": "2021-12-03",
  "language": "EN",
  "person_id": "992de312a545bb24a88ddbf57ae8b1ffcper",
  "address": {
    "line_1": "BERLINER STR. 45",
    "line_2": "Erste Etage",
    "postal_code": "14169",
    "city": "Berlin",
    "country": "DE",
    "state": "BE"
  },
  "documents": [
    { … },
    { … }
  ],
  "failure_reason": "string",
  "iban": "DE11010101010101010100",
  "authorization_expires_at": "string",
  "confirmation_expires_at": "string",
  "provider_status_code": 1000,
  "account_verification_error": "accounts_failed",
  "idnow_process_type": "eid"
}

Index all person identifications

Request

Returns all identifications for all of your customers.

Query
page[number]string

Page Number

page[size]string

Determines the size of each page of results.

filter[reference]string

Filters the returned identifications by a specific reference.

filter[id]string

Filters the returned identifications by a specific identification ID.

filter[status]string

Filters the returned identifications by a specific status.

filter[person_id]string

Filters the returned identifications by a specific person ID.

No request payload

Responses

Successful result of the operation

Bodyapplication/json
idstring

ID of the person identification.

Example: "9dfe2f4edaa67138be0c0c1cd3a7d849cidt"
referencestring

Reference generated by the identification provider.

Example: "TST-ELCCJ"
urlstring

(IDnow only) Redirect URL used to start the identification process.

Example: "https://go.test.idnow.de/company_id/identifications/identification_id"
statusstring

The current status of the identification. Note The status value depends on the identification method, check the KYC guides for more information.

Enum"aborted""authorization_required""confirmation_required""confirmed""created""canceled""expired""failed""identification_data_required""pending"
Example: "successful"
completed_atstring

Date and time when the identification was completed.

Example: "2021-09-14T18:18:28.000Z"
methodstring

The method used for the identification.

Enum"bank""bank_id""bank_plus""fourthline""idnow""idnow_autoident""idnow_custom""manual""postident"
Example: "idnow"
proof_of_address_typestring

The type of document submitted by the customer as a proof of address if their identification document did not include their address.

Enum"BANK_ACCOUNT_STATEMENT""CERTIFICATE_OF_REGISTRATION""ELECTRICITY_BILL""GAS_BILL""HEATING_BILL""INTERNET_BILL""TELEPHONE_BILL""WATER_BILL"
Example: "GAS_BILL"
proof_of_address_issued_atstring

The date when the proof of address document was issued.

Example: "2021-12-03"
languagestring

(IDnow only) The customer's preferred language for the identification process.

Enum"DE""EN"
Example: "EN"
person_idstring

ID of the person for whom the identification was initiated.

Example: "992de312a545bb24a88ddbf57ae8b1ffcper"
addressobject

The customer's address.

documentsArray of objects

Documents provided by the customer during the identification process.

Example: [{"id":"448b75fa1c57eecda41d91c66c22faa6cdoc","name":"file1.pdf","content_type":"application/json","document_type":"KYC_REPORT","size":803580},{"id":"94eb22a9311be9a1fbb698c448b0b337cdoc","name":"file2.jpg","content_type":"image/jpeg","document_type":"SIGNATURE","size":25349}]
failure_reasonstring or null

Additional context around why the identification failed. Value depends on the identification method.

ibanstring

Optional IBAN provided for bank and bank_id identifications. Please note that Solaris only accepts certain banks for the Bankident KYC flow. See the full list here.

Example: "DE11010101010101010100"
authorization_expires_atstring or null

The date and time by which the authorization for the end customer must be requested.

confirmation_expires_atstring or null

The date and time by which the customer must input the OTP sent to their mobile number for the QES process.

provider_status_codeinteger or null

(Fourthline only) Status code returned by the identification provider.

Enum1000100110021003100410051006100710081009
account_verification_errorstring or null

Session Error returned by Tink in the account verification process. Will only be populated when failure_reason is account_snaphot_failed or account_snapshot_expired. Only present for identifications within identification session.

Enum"accounts_failed""client_aborted""init_failed""login_failed""login_next_failed""max_login_tries""max_tan_tries""no_compatible_accounts""pinned_iban_not_found""security_setting_rejection"
idnow_process_typestring

When method idnow is selected, the process type will reflect which idnow process was chosen.

Example: "eid"
Response
application/json
{
  "id": "9dfe2f4edaa67138be0c0c1cd3a7d849cidt",
  "reference": "TST-ELCCJ",
  "url": "https://go.test.idnow.de/company_id/identifications/identification_id",
  "status": "successful",
  "completed_at": "2021-09-14T18:18:28.000Z",
  "method": "idnow",
  "proof_of_address_type": "GAS_BILL",
  "proof_of_address_issued_at": "2021-12-03",
  "language": "EN",
  "person_id": "992de312a545bb24a88ddbf57ae8b1ffcper",
  "address": {
    "line_1": "BERLINER STR. 45",
    "line_2": "Erste Etage",
    "postal_code": "14169",
    "city": "Berlin",
    "country": "DE",
    "state": "BE"
  },
  "documents": [
    { … },
    { … }
  ],
  "failure_reason": "string",
  "iban": "DE11010101010101010100",
  "authorization_expires_at": "string",
  "confirmation_expires_at": "string",
  "provider_status_code": 1000,
  "account_verification_error": "accounts_failed",
  "idnow_process_type": "eid"
}

Start e-signing authorization process

Request

This method begins the authorization process for a person identification via BankIdent. When called, it triggers a Swisscom iframe and it also prompts Swisscom to send an SMS OTP to the customer. Call this endpoint when an identification reaches the authorization_required status.

Path
person_idstringrequired

The unique ID of the person resource created for a customer.

Example: dc1a6812a14f6cc338cd084208535bcdcper
idstringrequired

The unique ID of the identification resource created for a customer.

Example: 6dc54352d6793a892e0702850d07b831cidt
No request payload

Responses

The QES process has been triggered. The customer must confirm by entering the received SMS OTP.

Bodyapplication/json
idstring

The unique ID of the identification resource.

Example: "a7a57dadfcc83117b5c3b72f4113be25cidt"
referencestring

A reference supplied by the identification provider.

Example: "null"
urlstring

The URL returned from FinTechSystem to which you must redirect the customer for the bank account login and payment authorization.

Example: "https://fts-payment-initiation-wizard.solaris-sandbox.de/index.html?wizard_session_key=bfo5r16AMLlt6ZEX9Oh3JUWIkTelorupBwzIlJRR&interface_id=da05"
statusstring

The current status of the identification. Note The status value depends on the identification method, check the KYC guides for more information.

Enum"aborted""authorization_required""confirmation_required""confirmed""created""canceled""expired""failed""identification_data_required""pending"
Example: "confirmation_required"
completed_atstring

Date and time when the identification process was completed.

Example: "null"
methodstring

The identification method to use for the person identification.

Enum"bank""bank_id""fourthline""idnow""manual""postident"
Example: "bank"
proof_of_address_typestring or null

The type of document submitted by the customer as a proof of address. This field is mandatory if the customer's identification document does not include their address.

Enum"BANK_ACCOUNT_STATEMENT""CERTIFICATE_OF_REGISTRATION""ELECTRICITY_BILL""GAS_BILL""HEATING_BILL""INTERNET_BILL""TELEPHONE_BILL""WATER_BILL"
proof_of_address_issued_atstring or null(date)

The date when the proof of address document was issued. This field is mandatory if the customer's identification document does not include their address.

ibanstring

The customer's IBAN. This field is mandatory if the identification method is bank or bank_id.

Example: "DE11110101010100000020"
terms_and_conditions_signed_atstring or null

The date and time from when the customer signed Swisscom's terms and conditions.

Example: "2020-07-07T11:36:29.000Z"
authorization_expires_atstring or null

The date and time by which the authorization for the end customer must be requested.

Example: "2022-08-11T08:38:21.000Z"
confirmation_expires_atstring or null

The date and time by which the customer must input the OTP sent to their mobile number for the QES process.

Example: "2022-08-11T08:37:23.000Z"
current_reference_tokenstring
Example: "1234-5678"
estimated_waiting_timestring

(IDnow only) Estimated waiting time until an agent is available.

Example: "null"
Response
application/json
{
  "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",
  "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"
}

Device Monitoring

Operations

Identification sessions

Operations

Person signings

Operations

IDnow

Operations

Business identifications

Operations

Business screener hits

Operations