Skip to main content
Savings Analysis Consent

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <API_KEY>.

Headers

x-client-id
string
required

Client ID for authentication

Body

application/json
client_name
string
required

The name of the client organization.

Example:

"Acme Corporation"

timestamp
string
required

The timestamp of the consent.

Example:

"2021-01-01T00:00:00Z"

ip_address
string
required

The IP address of the person providing consent.

Example:

"127.0.0.1"

first_name
string

The first name of the person providing consent.

Example:

"John"

last_name
string

The last name of the person providing consent.

Example:

"Doe"

email
string

The email of the person providing consent.

Example:

"john.doe@example.com"

autoOptIn
boolean
default:false

Indicates whether Rampart is authorized to automatically opt the account into a contract if potential savings are identified.

Response

200 - application/json

Successfully updated SAC settings

success
boolean

Indicates whether the SAC settings were updated successfully.

Example:

true