Skip to content
Customer Identification (...
/
/
Index business identifica...

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

Device Monitoring

Operations

Identification sessions

Operations

Person signings

Operations

IDnow

Operations

Business identifications

Operations

Create a business identification

Request

Creates the business identification resource (BKYC) for a business, which automatically triggers both the legal identification of the business (handled by Solaris) and the video identification of all applicable natural person(s), such as legal representative(s).

Path
business_idstringrequired

The unique business ID, generated after completing the business onboarding process.

Bodyapplication/json

the content of the request

methodstring

The identification method. Default value is idnow.

Enum"idnow""itm""import"
Example: "idnow"
original_completed_atstring(date-time)

The date and time when the original identification was completed. This field is only relevant if the identification method is import.

application/json
{
  "method": "idnow"
}

Responses

Successful result of the operation

Bodyapplication/json
idstring

The unique ID of the business identification resource.

Example: "4c74c804eaea5d2a2d64ef400a27a4d3bid"
methodstring

The identification method. Default value is idnow.

Enum"idnow""itm""import"
Example: "idnow"
referencestring

The reference of the itm identification request. Empty when the identification method is idnow.

Example: "TST-VWKRA"
statusstring

The status of the business identification process.

Enum"created""pending""successful""failed""expired"
Example: "pending"
completed_atstring

The date and time when the business identification was completed.

Example: "null"
legal_representativesArray of strings

The legal representatives with their video identification details, such as idnow URLs, status, and timestamps of creation and completion.

legal_identification_statusstring

The status of the business legal identification.

Enum"created""information_required""blocked_internally""successful""failed""expired"
Example: "information_required"
legal_identification_reasonstring

The reasons for a failed legal identification.

Example: "null"
legal_identification_missing_informationArray of strings

Missing information or documents that Solaris needs from the business to complete the legal identification process.

Items Enum"COMPLIANCE_QUESTIONS""FOUNDATION_DOCUMENT""OTHER""REGISTER_APPLICATION""SCHUFA_EXTRACT""SCHUFA_GWG_REPORT""SEALED_FOUNDATION_DOCUMENT""SHAREHOLDERS_AGREEMENT""SHAREHOLDERS_LIST""SHAREHOLDERS_LIST_MOTHER_COMPANY"
Example: ["COMPLIANCE_QUESTIONS"]
legal_identification_missing_information_detailsstring

Field that includes extra details or clarification on the missing information and/or documents Solaris requires.

business_idstring

The unique business ID, generated after completing the business onboarding process.

Example: "880bbac68a34add190786b9c74f4c82fcbiz"
Response
application/json
{
  "id": "4c74c804eaea5d2a2d64ef400a27a4d3bid",
  "method": "idnow",
  "reference": "TST-VWKRA",
  "status": "pending",
  "completed_at": "null",
  "legal_representatives": [
    "string"
  ],
  "legal_identification_status": "information_required",
  "legal_identification_reason": "null",
  "legal_identification_missing_information": [
    "COMPLIANCE_QUESTIONS"
  ],
  "legal_identification_missing_information_details": "string",
  "business_id": "880bbac68a34add190786b9c74f4c82fcbiz"
}

Index business identifications for a business

Request

Retrieves all identifications for a business. You can filter the results by page number, page size, identification status, legal identification status, etc.

Path
business_idstringrequired

Your unique business ID, generated after completing the business onboarding process.

No request payload

Responses

Successful result of the operation

Bodyapplication/json
idstring

The unique ID of the business identification resource.

Example: "4c74c804eaea5d2a2d64ef400a27a4d3bid"
methodstring

The identification method. Default value is idnow.

Enum"idnow""itm""import"
Example: "idnow"
referencestring

The reference of the itm identification request. Empty when the identification method is idnow.

Example: "TST-VWKRA"
statusstring

The status of the business identification process.

Enum"created""pending""successful""failed""expired"
Example: "pending"
completed_atstring

The date and time when the business identification was completed.

Example: "null"
legal_representativesArray of strings

The legal representatives with their video identification details, such as idnow URLs, status, and timestamps of creation and completion.

legal_identification_statusstring

The status of the business legal identification.

Enum"created""information_required""blocked_internally""successful""failed""expired"
Example: "information_required"
legal_identification_reasonstring

The reasons for a failed legal identification.

Example: "null"
legal_identification_missing_informationArray of strings

Missing information or documents that Solaris needs from the business to complete the legal identification process.

Items Enum"COMPLIANCE_QUESTIONS""FOUNDATION_DOCUMENT""OTHER""REGISTER_APPLICATION""SCHUFA_EXTRACT""SCHUFA_GWG_REPORT""SEALED_FOUNDATION_DOCUMENT""SHAREHOLDERS_AGREEMENT""SHAREHOLDERS_LIST""SHAREHOLDERS_LIST_MOTHER_COMPANY"
Example: ["COMPLIANCE_QUESTIONS"]
legal_identification_missing_information_detailsstring

Field that includes extra details or clarification on the missing information and/or documents Solaris requires.

business_idstring

The unique business ID, generated after completing the business onboarding process.

Example: "880bbac68a34add190786b9c74f4c82fcbiz"
Response
application/json
{
  "id": "4c74c804eaea5d2a2d64ef400a27a4d3bid",
  "method": "idnow",
  "reference": "TST-VWKRA",
  "status": "pending",
  "completed_at": "null",
  "legal_representatives": [
    "string"
  ],
  "legal_identification_status": "information_required",
  "legal_identification_reason": "null",
  "legal_identification_missing_information": [
    "COMPLIANCE_QUESTIONS"
  ],
  "legal_identification_missing_information_details": "string",
  "business_id": "880bbac68a34add190786b9c74f4c82fcbiz"
}

Create an approval for business identification

Request

Creates an additional final verification step to allow partners to approve or reject the business identification based on their internal compliance assessments. This is an optional endpoint for partners with this specific use case.

Path
business_idstringrequired

The unique business ID, generated after completing the business onboarding process.

business_identification_idstringrequired

The unique ID of the business identification resource.

Bodyapplication/json

the content of the request

approvedbooleanrequired

The partner identification approval status.

application/json
{
  "approved": true
}

Responses

Successful result of the operation

Bodyapplication/json
business_identification_idstring

The unique ID of the business identification resource.

Example: "4c74c804eaea5d2a2d64ef400a27a4d3bid"
approvedboolean

The partner approval status.

Example: true
Response
application/json
{
  "business_identification_id": "4c74c804eaea5d2a2d64ef400a27a4d3bid",
  "approved": true
}

Retrieve a single business identification

Request

Retrieves the details of a single business identification, including the status of the overall business identification process, video identification status and the URLs for the business's legal_representatives, and the legal identification status. You can use this endpoint to check status updates or any changes to the fields.

Path
business_idstringrequired

The unique business ID, generated after completing the business onboarding process.

business_identification_idstringrequired

The unique ID of the business identification resource.

No request payload

Responses

Successful result of the operation

Bodyapplication/json
idstring

The unique ID of the business identification resource.

Example: "4c74c804eaea5d2a2d64ef400a27a4d3bid"
methodstring

The identification method. Default value is idnow.

Enum"idnow""itm""import"
Example: "idnow"
referencestring

The reference of the itm identification request. Empty when the identification method is idnow.

Example: "TST-VWKRA"
statusstring

The status of the business identification process.

Enum"created""pending""successful""failed""expired"
Example: "pending"
completed_atstring

The date and time when the business identification was completed.

Example: "null"
legal_representativesArray of strings

The legal representatives with their video identification details, such as idnow URLs, status, and timestamps of creation and completion.

legal_identification_statusstring

The status of the business legal identification.

Enum"created""information_required""blocked_internally""successful""failed""expired"
Example: "information_required"
legal_identification_reasonstring

The reasons for a failed legal identification.

Example: "null"
legal_identification_missing_informationArray of strings

Missing information or documents that Solaris needs from the business to complete the legal identification process.

Items Enum"COMPLIANCE_QUESTIONS""FOUNDATION_DOCUMENT""OTHER""REGISTER_APPLICATION""SCHUFA_EXTRACT""SCHUFA_GWG_REPORT""SEALED_FOUNDATION_DOCUMENT""SHAREHOLDERS_AGREEMENT""SHAREHOLDERS_LIST""SHAREHOLDERS_LIST_MOTHER_COMPANY"
Example: ["COMPLIANCE_QUESTIONS"]
legal_identification_missing_information_detailsstring

Field that includes extra details or clarification on the missing information and/or documents Solaris requires.

business_idstring

The unique business ID, generated after completing the business onboarding process.

Example: "880bbac68a34add190786b9c74f4c82fcbiz"
Response
application/json
{
  "id": "4c74c804eaea5d2a2d64ef400a27a4d3bid",
  "method": "idnow",
  "reference": "TST-VWKRA",
  "status": "pending",
  "completed_at": "null",
  "legal_representatives": [
    "string"
  ],
  "legal_identification_status": "information_required",
  "legal_identification_reason": "null",
  "legal_identification_missing_information": [
    "COMPLIANCE_QUESTIONS"
  ],
  "legal_identification_missing_information_details": "string",
  "business_id": "880bbac68a34add190786b9c74f4c82fcbiz"
}

Index business identifications of a partner

Request

Returns all business identifications for all of your customers. You can add filters to your query to filter results.

Query
page[number]string

The number of pages to be returned.

page[size]string

The size to apply to each page of the API response.

filter[provider]string

Filter by identification providers.

filter[reference]string

Filter by identification reference numbers.

filter[status]string

Filter by the business identification status.

filter[completed_at]string

Filter by the date and time when the business identification was completed.

filter[created_at]string

Filter by the date and time when the business identification was created.

filter[updated_at]string

Filter by the date and time when the business identification was last updated.

filter[legal_identification_status]string

Filter by the business legal identification status.

No request payload

Responses

Successful result of the operation

Bodyapplication/json
idstring

The unique ID of the business identification resource.

Example: "4c74c804eaea5d2a2d64ef400a27a4d3bid"
methodstring

The identification method. Default value is idnow.

Enum"idnow""itm""import"
Example: "idnow"
referencestring

The reference of the itm identification request. Empty when the identification method is idnow.

Example: "TST-VWKRA"
statusstring

The status of the business identification process.

Enum"created""pending""successful""failed""expired"
Example: "pending"
completed_atstring

The date and time when the business identification was completed.

Example: "null"
legal_representativesArray of strings

The legal representatives with their video identification details, such as idnow URLs, status, and timestamps of creation and completion.

legal_identification_statusstring

The status of the business legal identification.

Enum"created""information_required""blocked_internally""successful""failed""expired"
Example: "information_required"
legal_identification_reasonstring

The reasons for a failed legal identification.

Example: "null"
legal_identification_missing_informationArray of strings

Missing information or documents that Solaris needs from the business to complete the legal identification process.

Items Enum"COMPLIANCE_QUESTIONS""FOUNDATION_DOCUMENT""OTHER""REGISTER_APPLICATION""SCHUFA_EXTRACT""SCHUFA_GWG_REPORT""SEALED_FOUNDATION_DOCUMENT""SHAREHOLDERS_AGREEMENT""SHAREHOLDERS_LIST""SHAREHOLDERS_LIST_MOTHER_COMPANY"
Example: ["COMPLIANCE_QUESTIONS"]
legal_identification_missing_information_detailsstring

Field that includes extra details or clarification on the missing information and/or documents Solaris requires.

business_idstring

The unique business ID, generated after completing the business onboarding process.

Example: "880bbac68a34add190786b9c74f4c82fcbiz"
Response
application/json
{
  "id": "4c74c804eaea5d2a2d64ef400a27a4d3bid",
  "method": "idnow",
  "reference": "TST-VWKRA",
  "status": "pending",
  "completed_at": "null",
  "legal_representatives": [
    "string"
  ],
  "legal_identification_status": "information_required",
  "legal_identification_reason": "null",
  "legal_identification_missing_information": [
    "COMPLIANCE_QUESTIONS"
  ],
  "legal_identification_missing_information_details": "string",
  "business_id": "880bbac68a34add190786b9c74f4c82fcbiz"
}

List all legal identification compliance questions

Request

Returns all the compliance questions raised by Solaris in relation to a business legal identification. The API response returns the compliance questions' IDs and texts. Each question has its own unique ID. You have to redirect these questions to your customers and collect their answers and submit them to Solaris.

Path
business_idstringrequired

The unique business ID, generated after completing the business onboarding process.

business_identification_idstringrequired

The unique ID of the business identification resource.

No request payload

Responses

Successful result of the operation

Bodyapplication/json
question_idstring

The unique ID of the compliance question created by Solaris.

Example: "ebb463137becc09788dfe21fc066e670qstn"
question_textstring

The text of the compliance question.

Example: "Please provide the license for security / guarding services (Bewachungsgewerbe): § 34a GewO"
legal_identification_idstring

The unique ID of the business legal identification.

Example: "14eb210435e09ab7f6a06c8b9b86ce27lid"
business_identification_idstring

The unique ID of the business identification resource.

Example: "4c74c804eaea5d2a2d64ef400a27a4d3bid"
business_idstring

The unique business ID, generated after completing the business onboarding process.

Example: "880bbac68a34add190786b9c74f4c82fcbiz"
answer_idstring

The unique ID of the customer's answer to the compliance question.

Example: "db5482ee94c5a091e93f36496562d5ffansr"
answer_textstring

The text of the answer to the compliance question.

asked_atstring(date-time)

The date and time when the compliance question was created by Solaris.

Example: "2021-07-16T13:38:06.000Z"
answered_atstring(date-time)

The date and time when the answer to the compliance question was created.

Example: "2021-07-16T13:53:18.000Z"
Response
application/json
{
  "question_id": "ebb463137becc09788dfe21fc066e670qstn",
  "question_text": "Please provide the license for security / guarding services (Bewachungsgewerbe): § 34a GewO",
  "legal_identification_id": "14eb210435e09ab7f6a06c8b9b86ce27lid",
  "business_identification_id": "4c74c804eaea5d2a2d64ef400a27a4d3bid",
  "business_id": "880bbac68a34add190786b9c74f4c82fcbiz",
  "answer_id": "db5482ee94c5a091e93f36496562d5ffansr",
  "answer_text": "string",
  "asked_at": "2021-07-16T13:38:06.000Z",
  "answered_at": "2021-07-16T13:53:18.000Z"
}

Create an answer to a compliance question

Request

Creates an answer to a compliance question raised by Solaris in relation to a business legal identification. You have to add the question's unique id in the request URL. Please note that you can only create one answer to a single question per request.

Path
business_idstringrequired

The unique business ID, generated after completing the business onboarding process.

business_identification_idstringrequired

The unique ID of the business identification resource.

question_idstringrequired

The unique ID of the compliance question.

Bodyapplication/json

the content of the request

textstring

The text of the answer to the compliance question.

application/json
{
  "text": "string"
}

Responses

Successful result of the operation

Bodyapplication/json
question_idstring

The unique ID of the compliance question created by Solaris.

Example: "ebb463137becc09788dfe21fc066e670qstn"
question_textstring

The text of the compliance question.

Example: "Please provide the license for security / guarding services (Bewachungsgewerbe): § 34a GewO"
legal_identification_idstring

The unique ID of the business legal identification.

Example: "14eb210435e09ab7f6a06c8b9b86ce27lid"
business_identification_idstring

The unique ID of the business identification resource.

Example: "4c74c804eaea5d2a2d64ef400a27a4d3bid"
business_idstring

The unique business ID, generated after completing the business onboarding process.

Example: "880bbac68a34add190786b9c74f4c82fcbiz"
answer_idstring

The unique ID of the customer's answer to the compliance question.

Example: "db5482ee94c5a091e93f36496562d5ffansr"
answer_textstring

The text of the answer to the compliance question.

asked_atstring(date-time)

The date and time when the compliance question was created by Solaris.

Example: "2021-07-16T13:38:06.000Z"
answered_atstring(date-time)

The date and time when the answer to the compliance question was created.

Example: "2021-07-16T13:53:18.000Z"
Response
application/json
{
  "question_id": "ebb463137becc09788dfe21fc066e670qstn",
  "question_text": "Please provide the license for security / guarding services (Bewachungsgewerbe): § 34a GewO",
  "legal_identification_id": "14eb210435e09ab7f6a06c8b9b86ce27lid",
  "business_identification_id": "4c74c804eaea5d2a2d64ef400a27a4d3bid",
  "business_id": "880bbac68a34add190786b9c74f4c82fcbiz",
  "answer_id": "db5482ee94c5a091e93f36496562d5ffansr",
  "answer_text": "string",
  "asked_at": "2021-07-16T13:38:06.000Z",
  "answered_at": "2021-07-16T13:53:18.000Z"
}

Mark legal_identification as ready for review

Request

Updates the legal identification status from information_required to pending and removes the missing_information flag. Call this endpoint after collecting and submitting the required documents and/or answers to the compliance questions from your customers to Solaris. Afterward, Solaris will review the submitted information and resume the legal identification process.

Path
business_idstringrequired

The unique business ID, generated after completing the business onboarding process.

business_identification_idstringrequired

The unique ID of the business identification resource.

No request payload

Responses

Successful result of the operation

Bodyapplication/json
idstring

The unique ID of the business legal identification.

Example: "14eb210435e09ab7f6a06c8b9b86ce27lid"
identification_idstring

The unique of ID the business identification resource.

Example: "4c74c804eaea5d2a2d64ef400a27a4d3bid"
business_idstring

The unique business ID, generated after completing the business onboarding process.

Example: "880bbac68a34add190786b9c74f4c82fcbiz"
statusstring

The status of the business legal identification.

Enum"created""information_required""blocked_internally""successful""failed""expired"
Example: "information_required"
reasonstring

The reasons for a failed legal identification.

Example: "null"
missing_informationstring

Missing information or documents that Solaris needs from the business to complete the legal identification process.

Enum"COMPLIANCE_QUESTIONS""FOUNDATION_DOCUMENT""OTHER""REGISTER_APPLICATION""SCHUFA_EXTRACT""SCHUFA_GWG_REPORT""SEALED_FOUNDATION_DOCUMENT""SHAREHOLDERS_AGREEMENT""SHAREHOLDERS_LIST""SHAREHOLDERS_LIST_MOTHER_COMPANY"
Example: "COMPLIANCE_QUESTIONS"
missing_information_detailsstring

Field that includes extra details or clarification on the missing information and/or documents Solaris requires.

Response
application/json
{
  "id": "14eb210435e09ab7f6a06c8b9b86ce27lid",
  "identification_id": "4c74c804eaea5d2a2d64ef400a27a4d3bid",
  "business_id": "880bbac68a34add190786b9c74f4c82fcbiz",
  "status": "information_required",
  "reason": "null",
  "missing_information": "COMPLIANCE_QUESTIONS",
  "missing_information_details": "string"
}

(Sandbox only) Update the legal identification status of a business identification

Request

Updates the legal identification status of a business identification. This endpoint is only for testing and not available on production systems. You can use it to update the status of the business identification for testing purposes.

Path
business_idstringrequired

The unique business ID, generated after completing the business onboarding process.

business_identification_idstringrequired

The unique ID of the business identification resource.

Bodyapplication/json

the content of the request

statusstring

The status of the business legal identification process.

Enum"created""pending""successful""failed""blocked_internally""information_required""expired"
Example: "information_required"
reasonstring

The reasons for a failed legal identification.

missing_informationArray of strings

Missing information or documents that Solaris needs from the business to complete the legal identification process.

Items Enum"COMPLIANCE_QUESTIONS""FOUNDATION_DOCUMENT""OTHER""REGISTER_APPLICATION""SCHUFA_EXTRACT""SEALED_FOUNDATION_DOCUMENT""SHAREHOLDERS_AGREEMENT""SHAREHOLDERS_LIST""SHAREHOLDERS_LIST_MOTHER_COMPANY""SIGNED_FOUNDATION_DOCUMENT"
Example: ["COMPLIANCE_QUESTIONS"]
missing_information_detailsstring

Field that includes extra details or clarification on the missing information and/or documents Solaris requires.

application/json
{
  "status": "information_required",
  "missing_information": [
    "COMPLIANCE_QUESTIONS"
  ]
}

Responses

Successful result of the operation

Bodyapplication/json
idstring

The unique ID of the business legal identification.

Example: "14eb210435e09ab7f6a06c8b9b86ce27lid"
identification_idstring

The unique of ID the business identification resource.

Example: "4c74c804eaea5d2a2d64ef400a27a4d3bid"
business_idstring

The unique business ID, generated after completing the business onboarding process.

Example: "880bbac68a34add190786b9c74f4c82fcbiz"
statusstring

The status of the business legal identification.

Enum"created""information_required""blocked_internally""successful""failed""expired"
Example: "information_required"
reasonstring

The reasons for a failed legal identification.

Example: "null"
missing_informationstring

Missing information or documents that Solaris needs from the business to complete the legal identification process.

Enum"COMPLIANCE_QUESTIONS""FOUNDATION_DOCUMENT""OTHER""REGISTER_APPLICATION""SCHUFA_EXTRACT""SCHUFA_GWG_REPORT""SEALED_FOUNDATION_DOCUMENT""SHAREHOLDERS_AGREEMENT""SHAREHOLDERS_LIST""SHAREHOLDERS_LIST_MOTHER_COMPANY"
Example: "COMPLIANCE_QUESTIONS"
missing_information_detailsstring

Field that includes extra details or clarification on the missing information and/or documents Solaris requires.

Response
application/json
{
  "id": "14eb210435e09ab7f6a06c8b9b86ce27lid",
  "identification_id": "4c74c804eaea5d2a2d64ef400a27a4d3bid",
  "business_id": "880bbac68a34add190786b9c74f4c82fcbiz",
  "status": "information_required",
  "reason": "null",
  "missing_information": "COMPLIANCE_QUESTIONS",
  "missing_information_details": "string"
}

Business screener hits

Operations