Creates an app integration recaptcha

Creates a new app integration ReCaptcha.

post

Header parameters

Brand-URLstringRequired

The brand URL of the request. This is used to identify the brand.

Example: YOUR_BRAND_URL

Auth-KeystringRequired

This is used to authenticate the request. If the request is not authenticated, the server will return a 401 Unauthorized response.

Example: YOUR_AUTH_KEY

Body

application/jsontext/jsonapplication/*+json

Provides a data transfer object for the ReCaptcha integration which is used for command requests.

appIntegrationIdstring · min: 1Required

This is used to associate this configuration with a specific integration instance.

versionstring · min: 1Required

Gets or sets the version of the ReCaptcha being used (e.g., v2, v3). Different versions may have different behavior and setup requirements.

siteKeystring · min: 1Required

This is the public key used on the client-side to render the ReCaptcha widget.

verifyURLstring | nullableOptional

The verify URL of the app integration.

secretKeystring | nullableOptional

This is the private key used server-side to validate ReCaptcha responses. It's optional to allow scenarios where only public configuration is required.

accountConfigNotesstring | nullableOptional

Gets or sets any additional notes or identifiers related to the account or setup that manages this ReCaptcha configuration.

isDefaultbooleanOptional

Flag to indicate if the analytics integration is the default. By default, it is false.

statusstring · enumOptionalPossible values:

Responses

201

The request was successful.

application/json

401

The user is not authorized to access the requested resource. The request is missing the required Auth-Key header.

application/json

403

The user's access was denied.

application/json

429

The user has exceeded the rate limit.

application/json

post

HTTPcURLJavaScriptPython

POST /api/v1/app-integrations/recaptcha HTTP/1.1
Host: protocol.jframework.io
Brand-URL: text
Auth-Key: text
Content-Type: application/json
Accept: */*
Content-Length: 168

{
  "appIntegrationId": "text",
  "version": "text",
  "siteKey": "text",
  "verifyURL": "text",
  "secretKey": "text",
  "accountConfigNotes": "text",
  "isDefault": true,
  "status": "0 - Inactive"
}

application/jsontext/jsonapplication/*+json

{
  "success": true,
  "statusCode": 201,
  "message": "The request was successful.",
  "data": {
    "appIntegration": {
      "type": "PaymentGateway",
      "name": "Stripe",
      "domain": "https://stripe.com",
      "description": "Stripe payment gateway",
      "logoURL": null,
      "status": "Active",
      "id": "sApKpllz4sAplsmzha"
    },
    "version": "v1",
    "siteKey": "6Le-YC4rAAAAADx-*************",
    "verifyURL": "VERIFY_URL",
    "secretKey": "SITE_KEY_SECRET",
    "accountConfigNotes": "[e-mail]",
    "isDefault": false,
    "status": "Inactive",
    "id": "sApKpllz4sAplsmzha",
    "createdDate": "2025-06-12T14:59:16.999135+07:00"
  },
  "errors": []
}