Sign in
latestOpenAPI 3.0.12026-08-105551287.6 KB

c481fa2414f9

Business Identifications

Index business identifications of a partner

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

get/v1/businesses/identifications

Query parameters

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.

Response

Successful result of the operation

idstring

The unique ID of the business identification resource.

method'idnow' | 'import'

The identification method. Default value is idnow.

referencestring

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

status'created' | 'pending' | 'successful' | 'failed' | 'expired'

The status of the business identification process.

completed_atstring

The date and time when the business identification was completed.

legal_representativesstring[]

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

legal_identification_status'created' | 'information_required' | 'blocked_internally' | 'successful' | 'failed' | 'expired'

The status of the business legal identification.

legal_identification_reasonstring

The reasons for a failed legal identification.

legal_identification_missing_informationstring[]

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

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.

edd_data_status'pending' | 'created' nullable

The status of the business EDD (Enhanced Due Diligence) data submission. This field is only present when the partner-setting for EDD data is enabled. If the business identification was created before the partner-setting was enabled, this field will not be present in the response.

Example response

{
  "id": "4c74c804eaea5d2a2d64ef400a27a4d3bid",
  "method": "idnow",
  "reference": "TST-VWKRA",
  "status": "pending",
  "completed_at": "null",
  "legal_identification_status": "information_required",
  "legal_identification_reason": "null",
  "legal_identification_missing_information": [
    "COMPLIANCE_QUESTIONS"
  ],
  "business_id": "880bbac68a34add190786b9c74f4c82fcbiz",
  "edd_data_status": "pending"
}