Skip to main content

Effective 10 September 2024, API Documentation can be found on our Equinix Product Documentation site.
The content on this page will not be updated after 1 Oct 2024 and will be inaccessible after 31st Dec 2024.


Signature Policies

Get Signature Policies

 GET /internetAccess/v1/signaturePolicies
MethodGET
Endpoint/internetAccess/v1/signaturePolicies
HeadersAuthorization
Path ParametersNot applicable
Query Parametersoffset, limit, location.countryCode
Body ParametersNot applicable

This API request returns country-specific signature policies.


Sample curl request

curl -X GET 'https://api.equinix.com/internetAccess/v1/signaturePolicies?location.countryCode=US'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'

Query parameters

Parameter
Description
offset integer
OPTIONAL
Index of the first item returned in the response.
Default value: 0
limit integer
OPTIONAL
Maximum number of items returned per page.
Default value: 50
location.countryCode string
OPTIONAL
Country code.
Example: US

Sample response

{
"pagination": {
"offset": 0,
"limit": 20,
"total": 1
},
"data": [
{
"signature": {
"types": [
"DIGITAL",
"WET"
]
},
"clickThroughAllowed": true,
"location": {
"countryCode": "US"
}
}
]
}

Response payload body description

Parameter
Description
pagination object
Data set pagination information.
offset integer
Index of the first item returned in the response.
limit integer
Maximum number of items returned per page.
total integer
Total number of items.
data array[object]
Data set containing applicable signature policies.
signature object
Signature information.
types array[string]
Signature type. Whether it is a physical or digital signature
Possible values:
  • WET - Traditional signature on a physical paper.
  • DIGITAL - Digital signature.
clickThroughAllowed boolean
Indicates if an order can be processed without a signature.
Example: true
location object
Location information where this signature policy is valid.
countryCode string
ISO country code.
Example: US