Skip to content
/Business documents

Businesses (1.0)

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

https://docs.solarisgroup.com/_mock/api-reference/onboarding/businesses/

Businesses

Operations

Business Registrations

Operations

Business tax identifications

Operations

Business documents

Operations

Index documents for a business

Request

Returns an array containing all documents for the business specified in the request URL.

Path
business_idstringrequired
Query
include_deletedboolean

Boolean flag to determine whether or not the API should return documents that were deleted.

customer_accessibleboolean

Boolean flag to determine whether the API should return documents that the customer has access to.

sortstring

Sort the results by document creation date (i.e., created_at).

Example: sort=created_at
page[number]string

The number of results pages to return.

page[size]string

The number of entries to return in each page.

filter[document_type]string

Filters the result by document type.

No request payload

Responses

Successful result of the operation

Bodyapplication/json
idstring

Unique identifier of the document.

Example: "69ec2a9d8dbaf5ea1b13124098a34ea3cdoc"
namestring

The name of the file associated with the document.

Example: "Operation_authorization.png"
content_typestring

The content type of the file associated with the document.

Example: "image/png"
document_typestring
Enum"ACCOUNT_SNAPSHOT.FINTECSYSTEMS""ACCOUNT_STATEMENT""AML_POLICY""ANNUAL_FINANCIAL_STATEMENT""B2B_MANDATE""BALANCE_REPORT""BANK_REFERENCE""BUSINESS_ASSESSMENT""BUSINESS_FINANCIALS_XBRL""CREDIT_AGENCY_REPORT"
Example: "PICTURE"
sizeinteger

The file size, in bytes.

Example: 10187
customer_accessibleboolean

Indicates whether the customer has access to the document.

Example: false
created_atstring

UTC timestamp from when the document was created in Solaris' system.

Example: "2022-05-20T12:46:09Z"
deleted_atstring

UTC timestamp from when the document was deleted (if applicable).

Example: "null"
Response
application/json
{
  "id": "69ec2a9d8dbaf5ea1b13124098a34ea3cdoc",
  "name": "Operation_authorization.png",
  "content_type": "image/png",
  "document_type": "PICTURE",
  "size": 10187,
  "customer_accessible": false,
  "created_at": "2022-05-20T12:46:09Z",
  "deleted_at": "null"
}

Create a document for a business

Request

Uploads a document and links it to the business specified in the request URL.
Unlike most other endpoints, this request uses the multipart/form-data content type. You must submit the parameters as form-data items instead of a raw JSON body.
By default, uploaded documents are not accessible to customers (i.e., the customer_accessible value is set to false).

Path
business_idstringrequired
Bodymultipart/form-datarequired
filestring(binary)required

File to upload

document_typestring(Solaris-Enums-DocumentType)required

The type of document.

Enum"ACCOUNT_SNAPSHOT.FINTECSYSTEMS""ACCOUNT_STATEMENT""AML_POLICY""ANNUAL_FINANCIAL_STATEMENT""B2B_MANDATE""BALANCE_REPORT""BANK_REFERENCE""BUSINESS_ASSESSMENT""BUSINESS_FINANCIALS_XBRL""CREDIT_AGENCY_REPORT"
multipart/form-data
{
  "file": "string",
  "document_type": "ACCOUNT_SNAPSHOT.FINTECSYSTEMS"
}

Responses

Successful result of the operation

Bodyapplication/json
idstring

Unique identifier of the document.

Example: "69ec2a9d8dbaf5ea1b13124098a34ea3cdoc"
namestring

The name of the file associated with the document.

Example: "Operation_authorization.png"
content_typestring

The content type of the file associated with the document.

Example: "image/png"
document_typestring
Enum"ACCOUNT_SNAPSHOT.FINTECSYSTEMS""ACCOUNT_STATEMENT""AML_POLICY""ANNUAL_FINANCIAL_STATEMENT""B2B_MANDATE""BALANCE_REPORT""BANK_REFERENCE""BUSINESS_ASSESSMENT""BUSINESS_FINANCIALS_XBRL""CREDIT_AGENCY_REPORT"
Example: "PICTURE"
sizeinteger

The file size, in bytes.

Example: 10187
customer_accessibleboolean

Indicates whether the customer has access to the document.

Example: false
created_atstring

UTC timestamp from when the document was created in Solaris' system.

Example: "2022-05-20T12:46:09Z"
deleted_atstring

UTC timestamp from when the document was deleted (if applicable).

Example: "null"
Response
application/json
{
  "id": "69ec2a9d8dbaf5ea1b13124098a34ea3cdoc",
  "name": "Operation_authorization.png",
  "content_type": "image/png",
  "document_type": "PICTURE",
  "size": 10187,
  "customer_accessible": false,
  "created_at": "2022-05-20T12:46:09Z",
  "deleted_at": "null"
}

Download a business document

Request

Downloads the file associated with the business document specified in the request URL.

Path
business_idstringrequired
idstringrequired
No request payload

Responses

Successful result of the operation.

Headers
datestring
Example: "Sun, 13 Aug 2017 20:35:45 GMT"
x-content-type-optionsstring
Example: "nosniff"
content-dispositionstring
Example: "attachment; filename=sample_pdf.pdf"
content-lengthinteger
Example: 3028
x-request-idstring
Example: "fbc2deff-8066-11e7-9271-02420a000109"
content-typestring
Example: "application/pdf"
Bodyapplication/pdf
string(binary)
Response
No content

Retrieve a business document

Request

Returns information about the business document specified in the request URL.

Path
business_idstringrequired
idstringrequired
No request payload

Responses

Successful result of the operation

Bodyapplication/json
idstring

Unique identifier of the document.

Example: "69ec2a9d8dbaf5ea1b13124098a34ea3cdoc"
namestring

The name of the file associated with the document.

Example: "Operation_authorization.png"
content_typestring

The content type of the file associated with the document.

Example: "image/png"
document_typestring
Enum"ACCOUNT_SNAPSHOT.FINTECSYSTEMS""ACCOUNT_STATEMENT""AML_POLICY""ANNUAL_FINANCIAL_STATEMENT""B2B_MANDATE""BALANCE_REPORT""BANK_REFERENCE""BUSINESS_ASSESSMENT""BUSINESS_FINANCIALS_XBRL""CREDIT_AGENCY_REPORT"
Example: "PICTURE"
sizeinteger

The file size, in bytes.

Example: 10187
customer_accessibleboolean

Indicates whether the customer has access to the document.

Example: false
created_atstring

UTC timestamp from when the document was created in Solaris' system.

Example: "2022-05-20T12:46:09Z"
deleted_atstring

UTC timestamp from when the document was deleted (if applicable).

Example: "null"
Response
application/json
{
  "id": "69ec2a9d8dbaf5ea1b13124098a34ea3cdoc",
  "name": "Operation_authorization.png",
  "content_type": "image/png",
  "document_type": "PICTURE",
  "size": 10187,
  "customer_accessible": false,
  "created_at": "2022-05-20T12:46:09Z",
  "deleted_at": "null"
}

Delete a business document

Request

Deletes a document for a business

Path
business_idstringrequired
idstringrequired
No request payload

Responses

Successful result of the operation

Bodyapplication/json
idstring

Unique identifier of the document.

Example: "69ec2a9d8dbaf5ea1b13124098a34ea3cdoc"
namestring

The name of the file associated with the document.

Example: "Operation_authorization.png"
content_typestring

The content type of the file associated with the document.

Example: "image/png"
document_typestring
Enum"ACCOUNT_SNAPSHOT.FINTECSYSTEMS""ACCOUNT_STATEMENT""AML_POLICY""ANNUAL_FINANCIAL_STATEMENT""B2B_MANDATE""BALANCE_REPORT""BANK_REFERENCE""BUSINESS_ASSESSMENT""BUSINESS_FINANCIALS_XBRL""CREDIT_AGENCY_REPORT"
Example: "PICTURE"
sizeinteger

The file size, in bytes.

Example: 10187
customer_accessibleboolean

Indicates whether the customer has access to the document.

Example: false
created_atstring

UTC timestamp from when the document was created in Solaris' system.

Example: "2022-05-20T12:46:09Z"
deleted_atstring

UTC timestamp from when the document was deleted (if applicable).

Example: "null"
Response
application/json
{
  "id": "69ec2a9d8dbaf5ea1b13124098a34ea3cdoc",
  "name": "Operation_authorization.png",
  "content_type": "image/png",
  "document_type": "PICTURE",
  "size": 10187,
  "customer_accessible": false,
  "created_at": "2022-05-20T12:46:09Z",
  "deleted_at": "null"
}

Update business document attributes

Request

Updates one or more properties of the business document specified in the request URL.

Path
business_idstringrequired
idstringrequired
Bodyapplication/json

the content of the request

document_typestring(Solaris-Enums-DocumentType)

The type of document.

Enum"ACCOUNT_SNAPSHOT.FINTECSYSTEMS""ACCOUNT_STATEMENT""AML_POLICY""ANNUAL_FINANCIAL_STATEMENT""B2B_MANDATE""BALANCE_REPORT""BANK_REFERENCE""BUSINESS_ASSESSMENT""BUSINESS_FINANCIALS_XBRL""CREDIT_AGENCY_REPORT"
customer_accessibleboolean

Customer accessible : Boolean

Example: true
application/json
{
  "document_type": "ACCOUNT_SNAPSHOT.FINTECSYSTEMS",
  "customer_accessible": true
}

Responses

Successful result of the operation

Bodyapplication/json
idstring

Unique identifier of the document.

Example: "69ec2a9d8dbaf5ea1b13124098a34ea3cdoc"
namestring

The name of the file associated with the document.

Example: "Operation_authorization.png"
content_typestring

The content type of the file associated with the document.

Example: "image/png"
document_typestring
Enum"ACCOUNT_SNAPSHOT.FINTECSYSTEMS""ACCOUNT_STATEMENT""AML_POLICY""ANNUAL_FINANCIAL_STATEMENT""B2B_MANDATE""BALANCE_REPORT""BANK_REFERENCE""BUSINESS_ASSESSMENT""BUSINESS_FINANCIALS_XBRL""CREDIT_AGENCY_REPORT"
Example: "PICTURE"
sizeinteger

The file size, in bytes.

Example: 10187
customer_accessibleboolean

Indicates whether the customer has access to the document.

Example: false
created_atstring

UTC timestamp from when the document was created in Solaris' system.

Example: "2022-05-20T12:46:09Z"
deleted_atstring

UTC timestamp from when the document was deleted (if applicable).

Example: "null"
Response
application/json
{
  "id": "69ec2a9d8dbaf5ea1b13124098a34ea3cdoc",
  "name": "Operation_authorization.png",
  "content_type": "image/png",
  "document_type": "PICTURE",
  "size": 10187,
  "customer_accessible": false,
  "created_at": "2022-05-20T12:46:09Z",
  "deleted_at": "null"
}

Beneficial Owners

Operations

Authorized persons

Operations

Business signees

Operations