Envelope[WhoamiResponse]

data object

anyOf

• WhoamiResponse
• null

Diagnostic payload describing how the API sees the calling client.

Returned by GET /api/v1/whoami. Helps integrators verify which IP the gateway resolves for them (often differs from their workstation IP when the server runs on dual-stack hosting and prefers IPv6) and whether that IP would pass the API key's allowlist.

allowliststring[]required

allowlistMatchesAllowlistmatchesrequired

apiKeyIdApikeyidrequired

clientIpClientiprequired

ipVersionIpversionrequired

errorCode object

anyOf

• string
• null

string

errors object

anyOf

• object[]
• null

Array [

codeFieldErrorCoderequired

Possible values: [MISSING, OUT_OF_RANGE, INVALID_FORMAT, INVALID_VALUE, NOT_ALLOWED, TOO_LONG, TOO_SHORT]

fieldFieldrequired

messageMessagerequired

]

statusTransactionStatusrequired

Possible values: [SUCCESS, IN_PROGRESS, PARTIALLY_COMPLETED, CANCELLED]

statusCodeStatusCoderequired

Possible values: [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14]

statusMessageStatusmessagerequired

traceIdTraceidrequired

Envelope[WhoamiResponse]

{
  "data": {
    "allowlist": [
      "string"
    ],
    "allowlistMatches": true,
    "apiKeyId": "string",
    "clientIp": "string",
    "ipVersion": 0
  },
  "errorCode": "string",
  "errors": [
    {
      "code": "MISSING",
      "field": "string",
      "message": "string"
    }
  ],
  "status": "SUCCESS",
  "statusCode": 0,
  "statusMessage": "string",
  "traceId": "string"
}