Skip to content

Get Turnstile

GET/web/v1/workspaces/{workspaceId}/institutions/{institutionBizId}/turnstileWEB

Retrieves the Cloudflare Turnstile configuration for the specified institution.

Authentication

Requires a valid JWT token. Gateway validation: enableJwtToken=true, enableTurnstile=false.

Request Parameters

Path Parameters

NameTypeRequiredInDescription
workspaceIdstringYespathWorkspace business ID
institutionBizIdstringYespathInstitution business ID

Success Response

Success200
{
  "code": "2000",
  "message": "SUCCESS",
  "data": {
    "id": 1,
    "institutionBizId": "inst_abc123",
    "turnstileSiteKey": "0x4AAAAAAAB...",
    "turnstileSecretKey": "****abcd",
    "remark": null,
    "createdAt": "2026-03-21T00:00:00Z",
    "updatedAt": "2026-03-21T00:00:00Z"
  }
}

Error Responses

CodeDescription
4010Unauthorized (invalid or missing JWT token)
4040Institution or turnstile configuration not found

Notes

  • The turnstileSecretKey is masked in the response for security purposes. Only the last 4 characters are visible.

Internal Documentation