Sign in
latestOpenAPI 3.0.12026-08-101936151.3 KB

61701b027c74

Terms and Conditions events

Create Terms and Conditions event

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.

post/v1/terms_and_conditions_events

Request body

document_idstring required

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_type'APPROVED' | 'REJECTED' required

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

signed_bystring required

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.

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

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

Example request

{
  "product_name": "DIGITAL_BANKING"
}

Response

Successful 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"
}