Publishes API client settings to a JSON file available for client-side use with the Registration UI; this allows settings to be loaded prior to any server-side calls. Published client settings are typically used to support a configurable minimum age requirement for registration or for tracking user acceptance of different terms of service and privacy policies on a per-site basis.

The settings to be published for an API client are configured in an additional setting called jump_publish_settings. In order for the Registration UI to load the JavaScript file where these settings are published, the hasSettings JavaScript setting must be set to true.

This endpoint includes the following methods:

  • POST



This endpoint supports Basic authentication. 

How to Create an Authentication String

Base URL

The base URL for this endpoint is your Identity Cloud Capture domain; for example:


Your Capture domains (also known as Registration domains) can be found in the Console on the Manage Application page:


Example Request

This command publishes API client settings to a JSON file (available for client-side use with the Registration UI) for the API client fghi7890fghi7890.

curl -X POST \
  -H "Authorization: Basic c2dueXZ1czZwYzRqbTdraHIybmVxNWdzODlnYnIyZXE6d3Q0YzN1bjl3a2tjZnZ5a25xeDQ0eW5jNDc2YWZzNjg="\
  --data-urlencode for_client_id=fghi7890fghi7890\
  --data-urlencode include_settings=true\
      Running this command in Postman

Authorized Clients

  • owner


  •  janrain-signed
  •  basic-auth

Query Parameters

Parameter Type Required Description
for_client_id string Yes Client ID of the client whose settings are to be published.
include_settings string If set to true, published settings are returned as part of the response.


200 OK

Response Example (application/json)

  "results": {
    "janrain_settings_version": "123abc45-de67-fgh8-9ijk-0lmn123op45q",
    "minimum_age": "13"
  "stat": "ok"