GETlive

Verify a credential and inspect its tenant role and capabilities

Verify a credential and inspect its tenant role and capabilities.

/api/v2/integrationgetIntegrationIdentityV2

Authentication and authority

Send one of the allowed bearer credential roles. Alternatives are OR; credentials named within one alternative are AND.

platformOrchestratorBearer

Credential bound to the platform_orchestrator role.

claimantAgentBearer

Credential bound to the claimant_agent role. Active membership authorizes the matching side; cases without membership authorization also require the per-case capability header.

respondentAgentBearer

Credential bound to the respondent_agent role. Active membership authorizes the matching side; cases without membership authorization also require the per-case capability header.

evidenceExporterBearer

Credential bound to one evidence_exporter resource.

settlementAdapterBearer

Credential carrying only settlement:execute and bound to one exact adapter resource.

readOnlyObserverBearer

Credential bound to the read_only_observer role and limited to operational projections.

Parameters

This operation has no path, query, or header parameters.

Responses

200

Authenticated integration identity and public credential metadata.

application/json

{
  "$ref": "#/components/schemas/PartnerIntegrationIdentityEnvelope",
  "type": "object",
  "additionalProperties": false,
  "required": [
    "data",
    "requestId"
  ],
  "properties": {
    "data": {
      "$ref": "#/components/schemas/PartnerIntegrationIdentity",
      "type": "object",
      "additionalProperties": false,
      "required": [
        "schemaVersion",
        "tenant",
        "integration",
        "credential"
      ],
      "properties": {
        "schemaVersion": {
          "type": "string",
          "const": "partner-integration-v2"
        },
        "tenant": {
          "type": "object",
          "additionalProperties": false,
          "required": [
            "id",
            "slug",
            "name",
            "environment",
            "status"
          ],
          "properties": {
            "id": {
              "type": "string"
            },
            "slug": {
              "type": "string"
            },
            "name": {
              "type": "string"
            },
            "environment": {
              "type": "string",
              "enum": [
                "test",
                "live"
              ]
            },
            "status": {
              "type": "string",
              "enum": [
                "active",
                "suspended"
              ]
            }
          }
        },
        "integration": {
          "type": "object",
          "additionalProperties": false,
          "required": [
            "role",
            "capabilities",
            "resourceBinding"
          ],
          "properties": {
            "role": {
              "type": "string",
              "enum": [
                "platform_orchestrator",
                "claimant_agent",
                "respondent_agent",
                "evidence_exporter",
                "settlement_adapter",
                "read_only_observer"
              ]
            },
            "capabilities": {
              "type": "array",
              "uniqueItems": true,
              "items": {
                "type": "string",
                "enum": [
                  "cases:prepare",
                  "cases:read",
                  "cases:respondent_handoff:read",
                  "callbacks:manage",
                  "settlement:bindings:manage",
                  "messages:write",
                  "evidence:challenges:read",
                  "evidence:challenges:write",
                  "party:claimant:act",
                  "party:respondent:act",
                  "party:claimant:terminate",
                  "party:respondent:terminate",
                  "evidence_exports:notify",
                  "evidence_exports:receipts:read",
                  "settlement:execute"
                ]
              }
            },
            "resourceBinding": {
              "oneOf": [
                {},
                {}
              ]
            }
          }
        },
        "credential": {
          "type": "object",
          "additionalProperties": false,
          "required": [
            "publicId",
            "prefix",
            "createdAt",
            "expiresAt"
          ],
          "properties": {
            "publicId": {
              "type": "string"
            },
            "prefix": {
              "type": "string"
            },
            "createdAt": {
              "type": "string",
              "format": "date-time"
            },
            "expiresAt": {
              "type": [
                "string",
                "null"
              ],
              "format": "date-time"
            }
          }
        }
      }
    },
    "requestId": {
      "type": "string"
    }
  }
}
default

RFC 9457 style problem response.

application/problem+json

{
  "$ref": "#/components/schemas/Problem",
  "type": "object",
  "required": [
    "type",
    "title",
    "status",
    "code",
    "detail",
    "requestId"
  ],
  "properties": {
    "type": {
      "type": "string",
      "format": "uri"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer"
    },
    "code": {
      "type": "string"
    },
    "detail": {
      "type": "string"
    },
    "requestId": {
      "type": "string"
    }
  }
}

Example response

Successful response

{
  "data": {
    "schemaVersion": "partner-integration-v2",
    "tenant": {
      "id": "id_test",
      "slug": "slug_test",
      "name": "name_test",
      "environment": "test",
      "status": "active"
    },
    "integration": {
      "role": "platform_orchestrator",
      "capabilities": [
        "cases:prepare"
      ],
      "resourceBinding": {
        "resourceId": "resourceId_test"
      }
    },
    "credential": {
      "publicId": "publicId_test",
      "prefix": "prefix_test",
      "createdAt": "2026-08-09T12:00:00.000Z",
      "expiresAt": null
    }
  },
  "requestId": "requestId_test"
}

Usage notes

  • Responses reflect the current authoritative resource state.