Skip to main content
POST
/
entities
/
{entity}
/
api-keys
Create an entity API key
curl --request POST \
  --url https://api.staging-2tid4c.ezyshield.com.au/management/v1/entities/{entity}/api-keys \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "abilities": [
    "verification:read"
  ]
}
'
{
  "data": {
    "id": "<string>",
    "name": "<string>",
    "abilities": [
      "<string>"
    ],
    "creator": {
      "id": "<string>",
      "name": "<string>",
      "email": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    },
    "created_at": "2023-11-07T05:31:56Z",
    "last_used_at": "2023-11-07T05:31:56Z",
    "expires_at": "2023-11-07T05:31:56Z",
    "token": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
entity
string<uuid>
required

The entity ID

Body

application/json
​
name
string
required

The name of the API key.

Maximum string length: 255
​
abilities
enum<string>[]
required

The abilities/permissions for the API key.

Available options:
verification:read,
verification:write,
check:read,
check:write

Response

ApiKeyResource

​
data
ApiKeyResource · object
required