API

Read saved verification session

Generated from the checked-in source. Do not edit this reference by hand.

GET /v1/media/verifications/{id}

Current workspace API key, model grant, composed workspace/key model and Provider policy, eligible published route and selectable credential required. Original immutable account/model binding is revalidated; original key identity binds encryption only, not workspace access control. Only configured fastrouter-actions-v1 channels are supported. Local saved status only, with known expiry reflected; no token, H5 URL or upstream request.

Operation: getMediaVerificationSession.

Authentication

Use the credential and permission scope described above. Each object below is an alternative; schemes within one object are required together.

[
  {
    "bearerAuth": []
  },
  {
    "niuApiKeyAuth": []
  }
]

HTTP request

Set NIU_ORIGIN to your installation origin (without /v1). Replace path, query and header placeholders with the required values. Query examples use curl 7.87 or newer to encode values with --url-query. Use the credential scope described above; a bearer token must have the authority required by this operation.

Authentication alternative: bearerAuth.

curl --fail-with-body -X GET "$NIU_ORIGIN/v1/media/verifications/{id}" \
  -H "Authorization: Bearer $NIU_BEARER_TOKEN" \
  --url-query 'model=<MODEL>'

Authentication alternative: niuApiKeyAuth.

curl --fail-with-body -X GET "$NIU_ORIGIN/v1/media/verifications/{id}" \
  -H "X-Niu-API-Key: $NIU_API_KEY" \
  --url-query 'model=<MODEL>'

Parameters

id

Location: path. Required.

{
  "type": "string",
  "format": "uuid"
}

model

Location: query. Required.

{
  "type": "string"
}

Request body

No request body is declared.

Responses

HTTP 200

Owned verification metadata

Content type: application/json.

{
  "type": "object",
  "required": [
    "data"
  ],
  "properties": {
    "data": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "id",
        "model",
        "subject_name",
        "status",
        "group_id",
        "expires_at",
        "created_at_ms",
        "updated_at_ms"
      ],
      "properties": {
        "id": {
          "type": "string",
          "format": "uuid"
        },
        "model": {
          "type": "string"
        },
        "subject_name": {
          "type": [
            "string",
            "null"
          ]
        },
        "status": {
          "type": "string",
          "enum": [
            "prepared",
            "unknown",
            "not_sent",
            "waiting_user",
            "processing",
            "verified",
            "failed",
            "expired"
          ]
        },
        "group_id": {
          "type": [
            "string",
            "null"
          ],
          "format": "uuid"
        },
        "expires_at": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "created_at_ms": {
          "type": "integer",
          "format": "int64"
        },
        "updated_at_ms": {
          "type": "integer",
          "format": "int64"
        }
      }
    }
  }
}

HTTP 400

Invalid fields or query

HTTP 401

Missing, revoked or expired API key

HTTP 403

Workspace/key policy refusal

HTTP 404

Owned session or model not found

HTTP 409

Changed input, stale route, expiry, unavailable token or capacity conflict

HTTP 413

Body exceeds bounded size

HTTP 501

Selected channel does not configure verification management

HTTP 503

Credential, encrypted content or bounded storage unavailable

Behavior and supported scope

Supported scope: implemented