Skip to content
/
Terms and Conditions even...

Compliance features (1.0)

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

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

AML follow-up

Operations

Testing endpoints for Postbox API

Operations

Postbox Items

Operations

Postbox Confirmations

Operations

Questions and Answers

Operations

Terms and Conditions events

Operations

Index Terms and Conditions events

Request

Returns an array containing all instances of customer agreements to the Solaris Terms and Conditions.

Query
filter[id]string

Filter the results by id.

filter[document_id]string

Filter the results by the specific document that was agreed to (document_id).

filter[signed_by]string

Filter the results by the customer who agreed to the Terms & Conditions (using their person_id).

filter[signed_on_behalf_of]string

Filter the results by the business on whose behalf the authorized person or legal representative agreed to the Terms & Conditions (using its business_id).

filter[product_name]string(ProductName)

Filter the results by the product whose Terms & Conditions were agreed to.

Enum"DIGITAL_BANKING""OVERDRAFT""VIACASH""SECURITIES_BROKERAGE""IDENTIFICATION_FOURTHLINE"
Example: filter[product_name]=DIGITAL_BANKING
filter[event_type]string

Filter the results by the type of Terms & Conditions event.

Enum"APPROVED""REJECTED"
filter[event_timestamp][min]string

Filter the results by the date and time when the Terms & Conditions event occurred. The [min] parameter specifies the minimum date in the past when the event should have occurred (i.e., the oldest possible date to return).

filter[event_timestamp][max]string

Filter the results by the date and time when the Terms & Conditions event occurred. The [max] parameter specifies the maximum date in the past when the event should have occurred (i.e., the latest possible date to return).

page[number]string

Specifies the number of pages of results to return.

page[size]string

Specifies the size of each page of results.

No request payload

Responses

Successful result of the operation

Bodyapplication/jsonArray [
idstring

ID of the Terms & Conditions event.

Example: "2b5423a061514901a5a8791f2cb18266"
event_timestampstring(date-time)

Timestamp when the customer approved/rejected the Terms & Conditions document.

Example: "2020-02-12T17:28:53Z"
created_atstring(date-time)

Timestamp when the Terms & Conditions event was created using the API.

Example: "2020-02-12T17:28:53Z"
event_typestring

The type of action that the customer took on the Terms & Conditions document.

Enum"APPROVED""REJECTED"
Example: "APPROVED"
signed_bystring

ID of the person who approved/rejected the Terms & Conditions document.

Example: "52054909a5d149b2a7430eee4ba6cc22"
signed_on_behalf_ofstring

ID of the business on whose behalf the authorized person or legal representative approved/rejected the Terms & Conditions document.

Example: "52054909a5d149b2a7430eee4ba6cc22"
product_namestring(ProductName)

The name of the relevant product to which the Terms & Conditions document applies.

Enum"DIGITAL_BANKING""OVERDRAFT""VIACASH""SECURITIES_BROKERAGE""IDENTIFICATION_FOURTHLINE"
Example: "DIGITAL_BANKING"
document_idstring

ID of the Terms & Conditions document that the customer approved/rejected.

Example: "3f31dd950cb6e2b28ac4b31d1b4bb321tcdc"
document_namestring

Name of the Terms & Conditions document that the customer approved/rejected.

Example: "Customer T&C on Data Processing"
]
Response
application/json
[
  {
    "id": "2b5423a061514901a5a8791f2cb18266",
    "document_id": "3f31dd950cb6e2b28ac4b31d1b4bb321tcdc",
    "document_name": "Customer T&C on Data Processing",
    "event_timestamp": "2020-02-12T17:28:53Z",
    "created_at": "2020-02-12T17:28:53Z",
    "event_type": "APPROVED",
    "signed_by": "52054909a5d149b2a7430eee4ba6cc22",
    "signed_on_behalf_of": "52054909a5d149b2a7430eee4ba6cc22",
    "product_name": "DIGITAL_BANKING"
  }
]

Create Terms and Conditions event

Request

Records an instance of a customer (i.e., a person or a person on behalf of a business) accepting or rejecting a Solaris Terms and Conditions document.

Body
required
document_idstringrequired

A 36-character hex encoded UID that corresponds with the relevant document. Solaris will provide these IDs.

event_timestampstring(date-time)required

UTC timestamp of when the customer approved/rejected the document. Format: YYYY-MM-DDTHH:MM:SSS

event_typestringrequired

The type of action that the customer took on the Terms & Conditions document.

Enum"APPROVED""REJECTED"
product_namestring(ProductName)required

The name of the relevant product to which the Terms & Conditions document applies.

Enum"DIGITAL_BANKING""OVERDRAFT""VIACASH""SECURITIES_BROKERAGE""IDENTIFICATION_FOURTHLINE"
Example: "DIGITAL_BANKING"
signed_bystringrequired

ID of the person who signed the Terms & Conditions document.

signed_on_behalf_ofstring

(For business customers) ID of the business on whose behalf the authorized person or legal representative is approving/rejecting the Terms & Conditions.

{
  "document_id": "3f31dd950cb6e2b28ac4b31d1b4bb321tcdc",
  "event_timestamp": "2020-02-12T17:28:53Z",
  "event_type": "APPROVED",
  "signed_by": "52054909a5d149b2a7430eee4ba6cc22",
  "signed_on_behalf_of": "ebf7d72aec7ab75006aa164b3e0af893cbiz",
  "product_name": "DIGITAL_BANKING"
}

Responses

Successful operation

Bodyapplication/json
idstring

ID of the Terms & Conditions event.

Example: "2b5423a061514901a5a8791f2cb18266"
event_timestampstring(date-time)

Timestamp when the customer approved/rejected the Terms & Conditions document.

Example: "2020-02-12T17:28:53Z"
created_atstring(date-time)

Timestamp when the Terms & Conditions event was created using the API.

Example: "2020-02-12T17:28:53Z"
event_typestring

The type of action that the customer took on the Terms & Conditions document.

Enum"APPROVED""REJECTED"
Example: "APPROVED"
signed_bystring

ID of the person who approved/rejected the Terms & Conditions document.

Example: "52054909a5d149b2a7430eee4ba6cc22"
signed_on_behalf_ofstring

ID of the business on whose behalf the authorized person or legal representative approved/rejected the Terms & Conditions document.

Example: "52054909a5d149b2a7430eee4ba6cc22"
product_namestring(ProductName)

The name of the relevant product to which the Terms & Conditions document applies.

Enum"DIGITAL_BANKING""OVERDRAFT""VIACASH""SECURITIES_BROKERAGE""IDENTIFICATION_FOURTHLINE"
Example: "DIGITAL_BANKING"
document_idstring

ID of the Terms & Conditions document that the customer approved/rejected.

Example: "3f31dd950cb6e2b28ac4b31d1b4bb321tcdc"
document_namestring

Name of the Terms & Conditions document that the customer approved/rejected.

Example: "Customer T&C on Data Processing"
Response
application/json
{
  "id": "2b5423a061514901a5a8791f2cb18266",
  "document_id": "3f31dd950cb6e2b28ac4b31d1b4bb321tcdc",
  "document_name": "Customer T&C on Data Processing",
  "event_timestamp": "2020-02-12T17:28:53Z",
  "created_at": "2020-02-12T17:28:53Z",
  "event_type": "APPROVED",
  "signed_by": "52054909a5d149b2a7430eee4ba6cc22",
  "signed_on_behalf_of": "52054909a5d149b2a7430eee4ba6cc22",
  "product_name": "DIGITAL_BANKING"
}