Sign in
latestOpenAPI 3.0.12026-08-101936151.3 KB

61701b027c74

Terms and Conditions events

Index Terms and Conditions events

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

get/v1/terms_and_conditions_events

Query parameters

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]'DIGITAL_BANKING' | 'OVERDRAFT' | 'VIACASH' | 'SECURITIES_BROKERAGE' | 'IDENTIFICATION_FOURTHLINE'

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

Example:DIGITAL_BANKING

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

filter[event_type]'APPROVED' | 'REJECTED'

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

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.

Response

Successful result of the operation

idstring

ID of the Terms & Conditions event.

event_timestampstring date-time

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

created_atstring date-time

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

event_type'APPROVED' | 'REJECTED'

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

signed_bystring

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

signed_on_behalf_ofstring

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

product_name'DIGITAL_BANKING' | 'OVERDRAFT' | 'VIACASH' | 'SECURITIES_BROKERAGE' | 'IDENTIFICATION_FOURTHLINE'

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

document_idstring

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

document_namestring

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

Example response

[
  {
    "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"
  }
]