Digital LOA Requests

Request a Digital LOA document from a Z-side party and use it to establish a direct Cross Connect connection.

 

For more information, see Digital Letter of Authorization - Overview.

Create Digital LOA Request

	POST /diloa/v1/digitalLoas/loaRequest
Method	POST
Endpoint	/diloa/v1/digitalLoas/loaRequest
Headers	Authorization, Content-Type
Path Parameters	Not applicable
Query Parameters	Not applicable
Body Parameters	ibx, requestedNumber, requestor, provider, notes

This API request creates a Digital LOA request.

 

To obtain the Access Token, refer to Requesting Access and Refresh tokens under the Getting Access Token section.

Sample curl request

curl -X
POST "https://api.equinix.com/diloa/v1/digitalLoas/loaRequest"
-H "content-type: application/json"
-H "Authorization: Bearer qwErtY8zyW1abcdefGHI"
-d '{
    "ibx": "CH1",
    "requestedNumber": 2,
    "requestor": {
        "contacts": [
            {
                "type": "NOTIFICATION",
                "registeredUser": "Registered",
                "firstName": "John",
                "lastName": "Smith",
                "timezone": "Australia/Perth",
                "availability": "ANYTIME",
                "details": [
                    {
                        "note": "new email address",
                        "value": "kyle@mail.com",
                        "type": "EMAIL"
                    }
                ]
            }
        ]
    },
    "provider": {
        "type": "CUSTOMER_ORGANIZATION",
        "orgIds": [
          "123456"
        ],
        "name": "Michael Scott Paper Company",
        "contacts": [
            {
                "type": "NOTIFICATION",
                "details": [
                    {
                        "value": "kyle@mail.com",
                        "type": "EMAIL"
                    }
                ]
            }
        ]
    },
    "notes": "No additional notes"
}'

Body parameters

Parameter	Description
ibx string REQUIRED	IBX data center identifier. Example: AT1
requestedNumber integer REQUIRED	Number of requested connections. Minimum: 1 Maximum: 10
requestor object REQUIRED	Digital LOA document requestor information.
contacts array[object] REQUIRED	Service provider contact information.
type string	Notification messages category relevant to a given contact person. Possible values: NOTIFICATION - Notifications related to Digital LOA document's lifecycle. TECHNICAL - Contact information for technical inquiries.
registeredUser string OPTIONAL	contactId, userId or userKey of a registered user.
firstName string CONDITIONAL	Contact person's first name. Required if registeredUser hasn't been provided. Example: Jane
lastName string CONDITIONAL	Contact person's last name. Required if registeredUser hasn't been provided. Example: Smith
timezone string OPTIONAL	Contact person's timezone. Example: Australia/Perth
availability string OPTIONAL	Contact person's availability. Applicable values: WORK_HOURS - Contact person be reached during working hours. ANYTIME - Contact person can be reached anytime throughout the day.
details array[object] REQUIRED	Means of contact.
note string OPTIONAL	Additional note applicable to the given contact option. Example: Not suitable for emergencies.
value string REQUIRED	Value specific to the given contact type. Example: jane@smith.com
type string REQUIRED	Means of contact. Applicable values: EMAIL - Email address. PHONE - Landline phone number. MOBILE - Mobile phone number. SECONDARY_EMAIL - Alternative email address.
provider object	Provider details.
type string REQUIRED	Party type that specifies if the provider is a known organization or a new one without previous engagements. Applicable values: CUSTOMER_ORGANIZATION - A customer organization with known organization identifiers. NEW_RELATIONSHIP - A new customer relationship, where the organization identifier is unknown.
email string CONDITIONAL	Customer organization representative's email address. Required if the provider.type parameter is set to NEW_RELATIONSHIP. Example: mike@mspc.us
orgIds array[string] CONDITIONAL	Customer organization identifiers. Required if the provider.type parameter is set to CUSTOMER_ORGANIZATION. Example: 123345
name string REQUIRED	Customer organization name. Example: Solid Snake Inc.
contacts array[object] REQUIRED	Service provider contact information.
type string	Notification messages category relevant to a given contact person. Possible values: NOTIFICATION - Notifications related to Digital LOA document's lifecycle. TECHNICAL - Contact information for technical inquiries.
details array[object] REQUIRED	Means of contact.
note string OPTIONAL	Additional note applicable to the given contact option. Example: Not suitable for emergencies.
value string REQUIRED	Value specific to the given contact type. Example: jane@smith.com
type string REQUIRED	Means of contact. Applicable values: EMAIL - Email address. PHONE - Landline phone number. MOBILE - Mobile phone number. SECONDARY_EMAIL - Alternative email address.
notes string OPTIONAL	Additional information to be considered. Example: No additional notes.