Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.iterapay.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

Use this endpoint to inspect the metadata of a merchant’s current API key. This is useful for auditing key usage, verifying that a key is active, or confirming when it was last used in a production environment.
This endpoint returns metadata only — the full API key value is never exposed after initial generation. To identify a key, use the prefix field returned in the response.
This endpoint requires Bearer token authentication. API key authentication is not accepted.

Path parameters

merchantID
string
required
The UUID of the merchant whose API key information you want to retrieve.

Response

Returns a 200 OK with API key metadata on success.
createdAt
string
ISO 8601 timestamp of when the API key was generated.
lastUsedAt
string
ISO 8601 timestamp of when the API key was last used to authenticate a request. Returns null if the key has never been used.
prefix
string
The first few characters of the API key. Use this to identify which key is active without exposing the full secret value.
curl --request GET \
  --url https://api.iterapay.com/key/info/b0fcc813-a7ce-4bbc-932f-dbef6f59ca7f \
  --header 'Authorization: Bearer <token>'
{
  "createdAt": "2024-01-01T00:00:00Z",
  "lastUsedAt": "2024-01-15T10:30:00Z",
  "prefix": "iterapay_live_a1b"
}