API ReferenceElectronic Delivery Consents

List all Electronic Delivery Consents

Returns a list of Electronic Delivery Consents.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

pageintegerOptional
The specific page of results you're requesting. Responses are limited to a maximum of 100 records.
statusenumOptional
Allowed values:
emailstringOptional

Filters the list of Electronic Delivery Consents based on the email field.

tinFingerprintstringOptional
Your unique token that points to a TIN.
userIdstringOptional

The unique identifier for a single end-user of your application.

Response

OK
idstring
The unique identifier for this electronic delivery consent.
createdAtdatetime

The creation date and time of the electronic delivery consent in ISO 8601 format.

statusenum
The status of the electronic delivery consent.
Allowed values:
emailstring
The email address associated with the electronic delivery consent. Abound assume's you have taken the proper steps to verify the ownership of this email address.
tinFingerprintstring
The TIN fingerprint for this electronic delivery consent.

Errors