- Documentation
- API
- Authorizations
- Signatures
Customer Signatures
This is an attribute
on Authorizations
(i.e. Authorization['customer_signature']
)
that contains information about the customer signature provided to prove consent was
given for an Authorization.
Attribute |
Format |
Description |
Example |
type |
Signature Type |
The type of signature. See list below for list of types. |
"text" |
ts |
ISO8601 |
The timestamp of signature. |
"2016-01-01T12:30:24.653422+00:00" |
Examples
// Example text-based signature
{
"type": "text",
"ts": "2016-01-01T12:30:24.653422+00:00",
"full_name": "Philip J. Fry"
}
// Example scanned and uploaded letters of authorization
{
"files": [
{
"expires": "2021-05-12T05:00:00.000000+00:00",
"filename": "loa_1.pdf",
"url": "https://utilityapi.com/api/v2/files/consents/985771/loa_1.pdf"
},
{
"expires": "2025-07-04T05:00:00.000000+00:00",
"filename": "loa_2.pdf",
"url": "https://utilityapi.com/api/v2/files/consents/985771/loa_2.pdf"
},
],
"ts": "2019-04-24T19:04:18.121597+00:00",
"type": "files"
}
// Example greenbutton authorization
{
"type": "greenbutton",
"ts": "2016-01-01T12:30:24.653422+00:00",
"full_name": "Philip J. Fry" // if available
}
// Example manual consent
{
"type": "manual",
"ts": "2016-01-01T12:30:24.653422+00:00",
"info": "City of New New York energy audit ordinance #1234-234-345"
}
Signature Types
Type |
Description |
Additional Attributes |
text |
The customer typed in their full name into the digital
signature field on the authorization form.
|
-
full_name
- String
- The customer's signature text.
|
files |
The customer uploaded files that contained their written consent.
|
-
url
- URL
- Link to the file in /files.
-
expires
- ISO8601
- The expiration date of this signature file
-
filename
- String
- The name of the file
|
greenbutton |
The customer authorized through greenbutton, so the consent
was handled on the utility website.
|
-
full_name
- String
or null
- If provided, the customer's name they provided.
|
drawn |
The customer drew a signature.
|
-
full_name
- String
- The customer's signature text.
-
image
- URL
- Link to the drawn signature in /files.
|
checkbox |
The customer checked a checkbox confirming their consent.
|
-
contents
- String
- Contents of the checkbox statement.
|
manual |
The customer has given consent through some other out-of-band means.
|
-
info
- String
- More information about the manual consent.
|