API Documentation

Everything you need to interact with AccessGrid.

Create HID Org

Enterprise only

Copy for LLMCopied

Create a new HID org for your enterprise or partner account. Generates credentials and queues automation to finish HID setup.

name

string

All

Organization name

email

string

All

Admin email address used for HID registration

full_address

string

All

Full address

phone

string

All

Primary phone

first_name

string

All

Admin first name

last_name

string

All

Admin last name

Request

# Build the JSON payload
PAYLOAD='{"name":"My Org","email":"ada@example.com","full_address":"1 Main St, NY NY","phone":"+1-555-0000","first_name":"Ada","last_name":"Lovelace"}'

# Sign the payload
PAYLOAD_B64=$(printf '%s' "$PAYLOAD" | openssl base64 -A)
SIG=$(printf '%s' "$PAYLOAD_B64" | openssl dgst -sha256 -hmac "$SECRET_KEY" -hex | awk '{print $NF}')

curl -X POST \
-H "X-ACCT-ID: $ACCOUNT_ID" \
-H "X-PAYLOAD-SIG: $SIG" \
-H "Content-Type: application/json" \
-d "$PAYLOAD" \
"https://api.accessgrid.com/v1/console/hid/orgs"

List HID Orgs

Enterprise only

Copy for LLMCopied

List HID orgs created under the current enterprise or partner account.

Request

# Build the JSON payload
PAYLOAD="{}"

curl -G \
-H "X-ACCT-ID: $ACCOUNT_ID" \
-H "X-PAYLOAD-SIG: $SIG" \
--data-urlencode "sig_payload=$PAYLOAD" \
"https://api.accessgrid.com/v1/console/hid/orgs"

Response

Empty

Finish HID Org Registration

Enterprise only

Copy for LLMCopied

Complete the HID org registration process after creating an org. This is a follow-up step to 'Create HID Org' and should be called once you receive the HID registration email with credentials. The email and password are provided by HID during their registration process.

email

string

All

Email address from the HID registration email

password

string

All

Temporary password from the HID registration email

Request

# Build the JSON payload
PAYLOAD='{"email":"admin@example.com","password":"hid-password-123"}'

curl -X POST \
-H "X-ACCT-ID: $ACCOUNT_ID" \
-H "X-PAYLOAD-SIG: $SIG" \
-H "Content-Type: application/json" \
-d "$PAYLOAD" \
"https://api.accessgrid.com/v1/console/hid/orgs/activate"

Response

Empty