API reference
Identity
Resolve the account, user, and key behind a credential.
1 endpoint. Every path below is relative to the base URL.
On this page
Base URL
https://api-uat.softsages.com/coreGET/api/v1/inkfree/me
Get the authenticated identity
Requires the X-API-Key header
Returns the account, app, creator user, key metadata, and capability list that the supplied X-API-Key resolves to. Use this to verify a credential and to read the key's effective rate limit and expiry.
Responses
200
Identity behind the API key.
Returns MeResponse
| Field | Type | Required | Description |
|---|---|---|---|
account | string | Optional | Tenant account the key belongs to. |
app | string | Optional | Application the key is scoped to. |
user | object | Optional | Creator user the key is bound to. Envelopes created via the API are attributed to this user. |
└email | string (email) | Optional | — |
└first_name | string | Optional | — |
└last_name | string | Optional | — |
key | object | Optional | — |
└id | string | Optional | Key id — a UUID. Safe to log; the secret value is not. |
└name | string | Optional | Label given at creation. |
└rate_limit_per_min | integer | Optional | Effective per-minute request limit for this key. Omitted when the account default of 60 applies. |
└expires_on | string | Optional | Expiry timestamp in MM/dd/yyyy HH:mm:ss, or absent if the key does not expire. |
capabilities | string[] | Optional | Capabilities granted to this key. |
200 response
{
"account": "acme",
"app": "inkfree",
"user": {
"email": "ops@acme.com",
"first_name": "Dana",
"last_name": "Reed"
},
"key": {
"id": "3f9a1c02-6b7e-4d18-9a5c-2e8b4f6d0a13",
"name": "Zapier production",
"rate_limit_per_min": 60,
"expires_on": "01/01/2027 00:00:00"
},
"capabilities": [
"envelopes:read",
"envelopes:write",
"webhooks:manage"
]
}401
The API key is missing, malformed, unknown, expired, revoked, or inactive.
Returns Error
401 response
{
"code": 401,
"message": "Invalid API key"
}429
Per-key rate limit exceeded. Back off and retry.
Returns Error
429 response
{
"code": 429,
"message": "Rate limit exceeded. Try again later."
}Example request
curl
curl "https://api-uat.softsages.com/core/api/v1/inkfree/me" \
-H "X-API-Key: sk_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"