User/List

List all users for a brand using the search criteria below. Max results 300.

Provide a 'user_id' to also return the users login history.

Parameters
Parameter Type Required Description
user_id string optional Specify a 'user_'id' to retrieve a specific users details.
customer_account_id string optional Specify to find users connected to a specific 'customer_account_id'.
email_address string optional The email address connected to the user.
username string optional Search for part of or a full username.
custom_field_1 string optional The value of 'custom_field_1' or a portion of it if supplied.
custom_field_2 string optional The value of 'custom_field_2' or a portion of it if supplied.
GET https://api.recurringstack.com/{format}/User/List 
//key,user_key,brand_id,response_format (xml or json),return (clean = return object, leave blank to return raw)
$rstack = new recurringstack('','','','xml','clean'); 

$params = array('user_id' => "",'customer_account_id' => "",'email_address' => "",'username' => "",'custom_field_1' => "",'custom_field_2' => "");
try { $response = $rstack->request('User/List','GET',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($response);
Response 
<?xml version="1.0"?>
<recurringstack transaction_id="">
	<user user_id="e40ebe20-f34d-473b-8a53-1a8db16f60c3" customer_account_id="e3552a51-dd02-4337-baf4-5581b086c76c" brand_id="egrtbtrb56-dd02-4337-baf4-558egre54vsreg" creation_date="2022-06-20 22:25:34" last_login="0000-00-00 00:00:00" last_login_ip="" status="1">
		<username>john_josh1</username>
		<contact_info>
			<first_name>John</first_name>
			<last_name>Emhoff</last_name>
			<email_address>josh@bagesfordogs.com</email_address>
			<timezone>America/Chicago</timezone>
		</contact_info>
                <locality>
                 <locale>en</locale>
                 <timezone_id>America/Chicago</timezone_id>
                </locality>
		<verification>
                        <last_email_verification_date>0000-00-00 00:00:00</last_email_verification_date>
                        <last_phone_verification_date>0000-00-00 00:00:00</last_phone_verification_date>
			<phone_number phone_number_country_code="1">2145551212</phone_number>
		</verification>
		<user_key>rs_user_oGzwBvrbrtEGmurtbkozcygA</user_key>
		<access_level/>
		<custom_field_1/>
		<custom_field_2/>
		<status>1</status>
                <!-- Login history only shown when a 'user_id' is provided -->
		<history>
			<event>
				<datetime>2022-03-04 14:27:14</datetime>
				<ip_address>158.644.889.554</ip_address>
				<url>http://mywebsite.com/login/</url>
			</event>
			<event>
				<datetime>2022-03-07 11:05:01</datetime>
				<ip_address>158.644.889.554</ip_address>
				<url>http://mywebsite.com/login/</url>
			</event>
		</history>
	</user>
</recurringstack>

{
    "@attributes": {
        "transaction_id": ""
    },
    "user": {
        "@attributes": {
            "user_id": "e40ebe20-f34d-473b-8a53-1a8db16f60c3",
            "customer_account_id": "e3552a51-dd02-4337-baf4-5581b086c76c",
            "brand_id": "egrtbtrb56-dd02-4337-baf4-558egre54vsreg",
            "creation_date": "2022-06-20 22:25:34",
            "last_login": "0000-00-00 00:00:00",
            "last_login_ip": "",
            "status": "1"
        },
        "username": "john_josh1",
        "contact_info": {
            "first_name": "John",
            "last_name": "Emhoff",
            "email_address": "josh@bagesfordogs.com",
            "timezone": "America\/Chicago"
        },
        "locality": {
            "locale": "en",
            "timezone_id": "America\/Chicago"
        },
        "verification": {
            "last_email_verification_date": "0000-00-00 00:00:00",
            "last_phone_verification_date": "0000-00-00 00:00:00",
            "phone_number": "2145551212"
        },
        "user_key": "rs_user_oGzwBvrbrtEGmurtbkozcygA",
        "access_level": {},
        "custom_field_1": {},
        "custom_field_2": {},
        "status": "1",
        "comment": {},
        "history": {
            "event": [
                {
                    "datetime": "2022-03-04 14:27:14",
                    "ip_address": "158.644.889.554",
                    "url": "http:\/\/mywebsite.com\/login\/"
                },
                {
                    "datetime": "2022-03-07 11:05:01",
                    "ip_address": "158.644.889.554",
                    "url": "http:\/\/mywebsite.com\/login\/"
                }
            ]
        }
    }
}

API Simulator

Initiate a live call to the User/List service using the API simulator.

User/Create

Create a new user connected to a customer account.

A user is created automatically when the account is created using the 'Account/Create' service, use this endpoint to create additional users.

Parameters
Parameter Type Required Description
customer_account_id string required The 'customer_account_id' you want to create the username under.
first_name string required The users first name.
last_name string required The users last name.
email_address string required The users email address; must be unique on the customer account.
phone_number_country_code string optional The country code for the users phone number.
phone_number string optional The users phone number.
password string optional The users new password; leave blank to generate a random password.
access_level string required 'ADMIN' and 'USER' are valid options. Only ADMINs can make a new ADMIN and only an ADMIN can create; edit; or assign IAM profiles.
custom_field_1 string optional A csutom value you want to store for your records.
custom_field_2 string optional A custom value you want to store for your records.
locale string required The language for the user; for acceptable values utilize the 'Reference/List' endpoint.
timezone_id string required The timezone for the customer account. Utilize the 'Reference/List' service to find acceptable values.
avatar_uri string optional Provide the web address to a gif; jpg; jpeg; or png to use as the users profile avatar.
send_new_user_email string required Specify a Y or N to send the new user email template. This email contains the initial password if password is left blank.
POST https://api.recurringstack.com/{format}/User/Create 
//key,user_key,brand_id,response_format (xml or json),return (clean = return object, leave blank to return raw)
$rstack = new recurringstack('','','','xml','clean'); 

$params = array('customer_account_id' => "",'first_name' => "",'last_name' => "",'email_address' => "",'phone_number_country_code' => "",'phone_number' => "",'password' => "",'access_level' => "",'custom_field_1' => "",'custom_field_2' => "",'locale' => "",'timezone_id' => "",'avatar_uri' => "",'send_new_user_email' => "");
try { $response = $rstack->request('User/Create','POST',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($response);
Response 
<?xml version="1.0" encoding="UTF-8"?>
<recurringstack>
   <user user_id="93cc79d4-3777-4951-90fc-682b99586b93" customer_account_id="769062f9-566b-49d9-8274-0678ca7e21e8" brand_id="2f9f862f-3e25-44f0-a701-8e16b59ee969" creation_date="2022-02-22 23:16:50" status="1">
      <username>vladminr_putin1</username>
      <contact_info>
         <first_name>Vladminr</first_name>
         <last_name>Putin</last_name>
         <email_address>putin@kremlin.org</email_address>
         <timezone>America/Chicago</timezone>
      </contact_info>
      <password>
         <initial_password>v8V{{9U&amp;pG^\ySCz</initial_password>
      </password>
      <locality>
         <locale>en</locale>
         <timezone_id>America/Chicago</timezone_id>
      </locality>
    <verification>
        <last_email_verification_date>0000-00-00 00:00:00</last_email_verification_date>
        <last_phone_verification_date>0000-00-00 00:00:00</last_phone_verification_date>
	<phone_number phone_number_country_code="1">2145551212</phone_number>
    </verification>
      <access_level>ADMIN</access_level>
      <custom_field_1>Referred by Don Jr</custom_field_1>
      <custom_field_2>Anything we want here.</custom_field_2>
      <status>1</status>
   </user>
</recurringstack>

{
    "user": {
        "@attributes": {
            "user_id": "93cc79d4-3777-4951-90fc-682b99586b93",
            "customer_account_id": "769062f9-566b-49d9-8274-0678ca7e21e8",
            "brand_id": "2f9f862f-3e25-44f0-a701-8e16b59ee969",
            "creation_date": "2022-02-22 23:16:50",
            "status": "1"
        },
        "username": "vladminr_putin1",
        "contact_info": {
            "first_name": "Vladminr",
            "last_name": "Putin",
            "email_address": "putin@kremlin.org",
            "timezone": "America\/Chicago"
        },
        "password": {
            "initial_password": "v8V{{9U&pG^\\ySCz"
        },
        "locality": {
            "locale": "en",
            "timezone_id": "America\/Chicago"
        },
        "verification": {
            "last_email_verification_date": "0000-00-00 00:00:00",
            "last_phone_verification_date": "0000-00-00 00:00:00",
            "phone_number": "2145551212"
        },
        "access_level": "ADMIN",
        "custom_field_1": "Referred by Don Jr",
        "custom_field_2": "Anything we want here.",
        "status": "1"
    }
}

API Simulator

Initiate a live call to the User/Create service using the API simulator.

User/Update

Update an existing user profile. Only provide the parameters you wish to update.

If password is updated it will NOT be returned in the response for security reasons.

Parameters
Parameter Type Required Description
user_id string required The 'user_id' you want to update.
first_name string optional The users first name.
last_name string optional The users last name.
email_address string optional The users email address; must be unique on the customer account.
phone_number_country_code string optional The country code for the users phone number.
phone_number string optional The users phone number.
password string optional Provide a new value to update the users password.
access_level string required 'ADMIN' and 'USER' are valid options. Only ADMINs can make a new ADMIN and only an ADMIN can create; edit; or assign IAM profiles.
custom_field_1 string optional A csutom value you want to store for your records.
custom_field_2 string optional A custom value you want to store for your records.
avatar_uri string optional Provide the web address to a gif; jpg; jpeg; or png to use as the users profile avatar.
locale string optional The language for the user; for acceptable values utilize the 'Reference/List' endpoint.
timezone_id string optional The timezone for the customer account. Utilize the 'Reference/List' service to find acceptable values.
verified string optional For use with your two step verification system; specify a Y or N to set the account as verified.
PATCH https://api.recurringstack.com/{format}/User/Update 
//key,user_key,brand_id,response_format (xml or json),return (clean = return object, leave blank to return raw)
$rstack = new recurringstack('','','','xml','clean'); 

$params = array('user_id' => "",'first_name' => "",'last_name' => "",'email_address' => "",'phone_number_country_code' => "",'phone_number' => "",'password' => "",'access_level' => "",'custom_field_1' => "",'custom_field_2' => "",'avatar_uri' => "",'locale' => "",'timezone_id' => "",'verified' => "");
try { $response = $rstack->request('User/Update','PATCH',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($response);
Response 
<?xml version="1.0"?>
<recurringstack>
  <user user_id="93cc79d4-3777-4951-90fc-682b99586b93" customer_account_id="769062f9-566b-49d9-8274-0678ca7e21e8" brand_id="2f9f862f-3e25-44f0-a701-8e16b59ee969" creation_date="2022-02-22 23:16:50" status="1">
    <username>vladminr_putin1</username>
    <contact_info>
      <first_name>Vladminr</first_name>
      <last_name>Crimson</last_name>
      <email_address>putin@kremlin.org</email_address>
      <timezone>America/Chicago</timezone>
    </contact_info>
    <locality>
      <locale>en</locale>
      <timezone_id>America/Chicago</timezone_id>
    </locality>
    <verification>
       <last_email_verification_date>0000-00-00 00:00:00</last_email_verification_date>
       <last_phone_verification_date>0000-00-00 00:00:00</last_phone_verification_date>
       <phone_number phone_number_country_code="1">2145551212</phone_number>
    </verification>
    <access_level>STAFF</access_level>
    <custom_field_1>Found us online</custom_field_1>
    <custom_field_2>Anything we want here.</custom_field_2>
    <status>1</status>
  </user>
</recurringstack>

{
    "user": {
        "@attributes": {
            "user_id": "93cc79d4-3777-4951-90fc-682b99586b93",
            "customer_account_id": "769062f9-566b-49d9-8274-0678ca7e21e8",
            "brand_id": "2f9f862f-3e25-44f0-a701-8e16b59ee969",
            "creation_date": "2022-02-22 23:16:50",
            "status": "1"
        },
        "username": "vladminr_putin1",
        "contact_info": {
            "first_name": "Vladminr",
            "last_name": "Crimson",
            "email_address": "putin@kremlin.org",
            "timezone": "America\/Chicago"
        },
        "locality": {
            "locale": "en",
            "timezone_id": "America\/Chicago"
        },
        "verification": {
            "last_email_verification_date": "0000-00-00 00:00:00",
            "last_phone_verification_date": "0000-00-00 00:00:00",
            "phone_number": "2145551212"
        },
        "access_level": "STAFF",
        "custom_field_1": "Found us online",
        "custom_field_2": "Anything we want here.",
        "status": "1"
    }
}

API Simulator

Initiate a live call to the User/Update service using the API simulator.

User/Suspend

Suspend a user and place the 'user_id' in suspended status.

Status Ledger:
1 - Active
2 - Suspended
3 - Deleted

Parameters
Parameter Type Required Description
user_id string required The 'user_id' you want to suspend.
PATCH https://api.recurringstack.com/{format}/User/Suspend 
//key,user_key,brand_id,response_format (xml or json),return (clean = return object, leave blank to return raw)
$rstack = new recurringstack('','','','xml','clean'); 

$params = array('user_id' => "");
try { $response = $rstack->request('User/Suspend','PATCH',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($response);
Response 
<?xml version="1.0" encoding="UTF-8"?>
<recurringstack>
   <user user_id="93cc79d4-3777-4951-90fc-682b99586b93" creation_date="2022-02-22 23:16:50" status="2"/>
</recurringstack>

{
    "user": {
        "@attributes": {
            "user_id": "93cc79d4-3777-4951-90fc-682b99586b93",
            "creation_date": "2022-02-22 23:16:50",
            "status": "2"
        }
    }
}

API Simulator

Initiate a live call to the User/Suspend service using the API simulator.

User/Delete

Delete a specific user or 'user_id'.

Status Ledger:
1 - Active
2 - Suspended
3 - Deleted

Parameters
Parameter Type Required Description
user_id string required The 'user_id' you want to delete.
PATCH https://api.recurringstack.com/{format}/User/Delete 
//key,user_key,brand_id,response_format (xml or json),return (clean = return object, leave blank to return raw)
$rstack = new recurringstack('','','','xml','clean'); 

$params = array('user_id' => "");
try { $response = $rstack->request('User/Delete','PATCH',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($response);
Response 
<?xml version="1.0" encoding="UTF-8"?>
<recurringstack>
   <user user_id="93cc79d4-3777-4951-90fc-682b99586b93" creation_date="2022-02-22 23:16:50" deletion_date="2022-02-23 11:22:21" status="3"/>
</recurringstack>

{
    "user": {
        "@attributes": {
            "user_id": "93cc79d4-3777-4951-90fc-682b99586b93",
            "creation_date": "2022-02-22 23:16:50",
            "deletion_date": "2022-02-23 11:22:21",
            "status": "3"
        }
    }
}

API Simulator

Initiate a live call to the User/Delete service using the API simulator.

User/Restore

Restore a user from suspended or deleted.

Status Ledger:
1 - Active
2 - Suspended
3 - Deleted
Deleted users can be restored up to 90 days after being deleted, after which the deletion becomes permanent.

Parameters
Parameter Type Required Description
user_id string required The 'user_id' you want to restore.
PATCH https://api.recurringstack.com/{format}/User/Restore 
//key,user_key,brand_id,response_format (xml or json),return (clean = return object, leave blank to return raw)
$rstack = new recurringstack('','','','xml','clean'); 

$params = array('user_id' => "");
try { $response = $rstack->request('User/Restore','PATCH',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($response);
Response 
<?xml version="1.0" encoding="UTF-8"?>
<recurringstack>
   <user user_id="93cc79d4-3777-4951-90fc-682b99586b93" creation_date="2022-02-22 23:16:50" status="1"/>
</recurringstack>

{
    "user": {
        "@attributes": {
            "user_id": "93cc79d4-3777-4951-90fc-682b99586b93",
            "creation_date": "2022-02-22 23:16:50",
            "status": "1"
        }
    }
}

API Simulator

Initiate a live call to the User/Restore service using the API simulator.

User/Authenticate

Authenticate a user as part of a sign in process.

The user will be returned with an additional 'authenticated' namespace with the 'Y' value if authentication is successful.
Either 'email_address' or 'username' is required.

Parameters
Parameter Type Required Description
email_address string optional The 'email_address' of the user. Must be provided if 'username' is not provided.
username string optional The 'username' of the user. Must be provided if 'email_address' is not provided.
password string optional The customers plain text password. Required if 'override_password_requirement' is not set to 'Y'.
override_password_requirement string optional Provide a 'Y' to authenticate the user without the password. This is useful for third party sign in services where the users email address has already been authenticated. 'email_address' must be supplied (will not work with 'username' only).
ip_address string optional Provide the users IP address to record it in the login history.
url string optional Provide the Url where the user is signing in from to store it in the login history.
temporary_token string optional Obtained from the 'User/OAuthAuthenticate' service. If provided email_address; username; or password should not be provided.
POST https://api.recurringstack.com/{format}/User/Authenticate 
//key,user_key,brand_id,response_format (xml or json),return (clean = return object, leave blank to return raw)
$rstack = new recurringstack('','','','xml','clean'); 

$params = array('email_address' => "",'username' => "",'password' => "",'override_password_requirement' => "",'ip_address' => "",'url' => "",'temporary_token' => "");
try { $response = $rstack->request('User/Authenticate','POST',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($response);
Response 
<?xml version="1.0" encoding="UTF-8"?>
<recurringstack>
   <user user_id="c368cc96-9fd2-411f-9837-071f7c1fb569" last_login="2022-03-04 14:27:14" last_login_ip="199.217.116.221" customer_account_id="769062f9-566b-49d9-8274-0678ca7e21e8" status="1">
      <authenticated>Y</authenticated>
      <username>chrs_eeer1</username>
      <contact_info>
         <first_name>Chris</first_name>
         <last_name>Smith</last_name>
         <email_address>smith@hawkinstg.com</email_address>
         <timezone>America/Chicago</timezone>
      </contact_info>
      <locality>
         <locale>en</locale>
         <timezone_id>America/Chicago</timezone_id>
      </locality>
    <verification>
      <last_email_verification_date>2022-06-24 00:47:42</last_email_verification_date>
      <last_phone_verification_date>0000-00-00 00:00:00</last_phone_verification_date>
      <phone_number phone_number_country_code="1">2145551212</phone_number>
    </verification>
      <access_level>ADMIN</access_level>
      <custom_field_1/>
      <custom_field_2/>
      <status>1</status>
   </user>
</recurringstack>

{
    "user": {
        "@attributes": {
            "user_id": "c368cc96-9fd2-411f-9837-071f7c1fb569",
            "last_login": "2022-03-04 14:27:14",
            "last_login_ip": "199.217.116.221",
            "customer_account_id": "769062f9-566b-49d9-8274-0678ca7e21e8",
            "status": "1"
        },
        "authenticated": "Y",
        "username": "chrs_eeer1",
        "contact_info": {
            "first_name": "Chris",
            "last_name": "Smith",
            "email_address": "smith@hawkinstg.com",
            "timezone": "America\/Chicago"
        },
        "locality": {
            "locale": "en",
            "timezone_id": "America\/Chicago"
        },
        "verification": {
            "last_email_verification_date": "2022-06-24 00:47:42",
            "last_phone_verification_date": "0000-00-00 00:00:00",
            "phone_number": "2145551212"
        },
        "access_level": "ADMIN",
        "custom_field_1": {},
        "custom_field_2": {},
        "status": "1"
    }
}

API Simulator

Initiate a live call to the User/Authenticate service using the API simulator.

User/2FARequest

Send a two factor authentication (2FA) verification code via SMS, phone call, or email. 'SMS' and 'call' 2FA request may carry an additional fee.

If sending a 2FA verification code via email the 'User/2FARequest' notification must be previously configured.
After a 2FA request is submitted you'll utilize the '2FAVerify' service to verify the code sent to the customer either via email, SMS, or phone call. Once the code has been verified the <last_phone_verification_date> or <last_email_verification_date> will be updated on the user profile. You can compare these dates to the current date on your platform to determine the next time to initiate a 2FA request for a user.

Parameters
Parameter Type Required Description
verification_user_id string required The 'user_id' you want to start the verification process for.
verification_method string required Acceptable values are 'email'; 'sms'; or 'call'.
POST https://api.recurringstack.com/{format}/User/2FARequest 
//key,user_key,brand_id,response_format (xml or json),return (clean = return object, leave blank to return raw)
$rstack = new recurringstack('','','','xml','clean'); 

$params = array('verification_user_id' => "",'verification_method' => "");
try { $response = $rstack->request('User/2FARequest','POST',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($response);
Response 
<?xml version="1.0"?>
<recurringstack transaction_id="479181">
  <user user_id="e40ebe20-f34d-473b-8a53-1a8db16f60c3">
  <verification>
    <phone_number phone_number_country_code="1">5125551212</phone_number>
  </verification>
  </user>
</recurringstack>

{
    "@attributes": {
        "transaction_id": "479181"
    },
    "user": {
        "@attributes": {
            "user_id": "e40ebe20-f34d-473b-8a53-1a8db16f60c3"
        },
        "verification": {
            "phone_number": "5125551212"
        }
    }
}

API Simulator

Initiate a live call to the User/2FARequest service using the API simulator.

User/2FAVerify

Verify a users identity; email address; or phone number using the verification code sent via the 'User/2FARequest' notification. If verification is successful the users details will be returned with the 'authenticated' namespace set to 'Y'.

Error messages generated by this service are catered towards the end user.

Parameters
Parameter Type Required Description
verification_user_id string required The 'user_id' you wish to verify. This should be the same 'user_id' supplied when calling the 'User/2FA' service.
verification_code string required The 35 character (for email verification) or 6 digit code for SMS verification.
verification_method string required Acceptable values are 'email'; 'sms'; or 'call'.
force_verification string optional Provide a value of 'Y' to force verification without a correct 'verification_code'.
POST https://api.recurringstack.com/{format}/User/2FAVerify 
//key,user_key,brand_id,response_format (xml or json),return (clean = return object, leave blank to return raw)
$rstack = new recurringstack('','','','xml','clean'); 

$params = array('verification_user_id' => "",'verification_code' => "",'verification_method' => "",'force_verification' => "");
try { $response = $rstack->request('User/2FAVerify','POST',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($response);
Response 
<?xml version="1.0"?>
<recurringstack transaction_id="479194">
	<user user_id="e40ebe20-f34d-473b-8a53-1a8db16f60c3" last_login="0000-00-00 00:00:00" last_login_ip="" customer_account_id="ewe43vrvb-74tr-4337-baf4-5581b086c21s" status="1">
		<authenticated>Y</authenticated>
		<username>john_josh1</username>
		<contact_info>
			<first_name>John</first_name>
			<last_name>Emhoff</last_name>
			<email_address>josh@bagesfordogs.com</email_address>
			<timezone>America/Chicago</timezone>
		</contact_info>
		<verification>
                        <last_email_verification_date>2022-06-24 00:47:42</last_email_verification_date>
                        <last_phone_verification_date>0000-00-00 00:00:00</last_phone_verification_date>
                        <phone_number phone_number_country_code="1">2145551212</phone_number>
		</verification>
		<access_level/>
		<custom_field_1/>
		<custom_field_2/>
		<status>1</status>
	</user>
</recurringstack>

{
    "@attributes": {
        "transaction_id": "479194"
    },
    "user": {
        "@attributes": {
            "user_id": "e40ebe20-f34d-473b-8a53-1a8db16f60c3",
            "last_login": "0000-00-00 00:00:00",
            "last_login_ip": "",
            "customer_account_id": "ewe43vrvb-74tr-4337-baf4-5581b086c21s",
            "status": "1"
        },
        "authenticated": "Y",
        "username": "john_josh1",
        "contact_info": {
            "first_name": "John",
            "last_name": "Emhoff",
            "email_address": "josh@bagesfordogs.com",
            "timezone": "America\/Chicago"
        },
        "verification": {
            "last_email_verification_date": "2022-06-24 00:47:42",
            "last_phone_verification_date": "0000-00-00 00:00:00",
            "phone_number": "2145551212"
        },
        "access_level": {},
        "custom_field_1": {},
        "custom_field_2": {},
        "status": "1"
    }
}

API Simulator

Initiate a live call to the User/2FAVerify service using the API simulator.

User/PasswdReset

This service will send a temporary password good for one hour to the users e-mail address.

The 'User/PasswdReset' notification must be setup to utilize this service.
One of 'email_address' or 'username' is required, not both.

Parameters
Parameter Type Required Description
email_address string optional The 'email_address' of the user you wish to reset the password for.
username string optional The 'username' of the user you wish to reset the password for.
POST https://api.recurringstack.com/{format}/User/PasswdReset 
//key,user_key,brand_id,response_format (xml or json),return (clean = return object, leave blank to return raw)
$rstack = new recurringstack('','','','xml','clean'); 

$params = array('email_address' => "",'username' => "");
try { $response = $rstack->request('User/PasswdReset','POST',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($response);
Response

API Simulator

Initiate a live call to the User/PasswdReset service using the API simulator.

User/CreateToken

This service allows you to create a temporary token that can be used with the 'User/Authenticate' service allowing you to bypass the username and password requirement.



A temporary link for the user to sign in to the Customer Facing Portal (CFP) without using their credentials will also be generated. Utilize this link if for example your customer is already signed in to an existing app and you'd like to direct them to the CFP for account management from within that app using either a button or link.

Parameters
Parameter Type Required Description
customer_account_id string required The 'customer_account_id' of the user.
user_id string required The 'user_id' of the user you wish to create a login link for.
expiration string optional Provide a expiration for the link in minutes. If none is provided the default of 1 minute will be utilized; the maximum expiration minutes is 10.
cfp_redirect string optional Provide a location in the Customer Facing Portal (CFP) to redirect the user when using the cfp_link. To redirect a user to the subscribe flow for example provide the value 'subscribe'.
POST https://api.recurringstack.com/{format}/User/CreateToken 
//key,user_key,brand_id,response_format (xml or json),return (clean = return object, leave blank to return raw)
$rstack = new recurringstack('','','','xml','clean'); 

$params = array('customer_account_id' => "",'user_id' => "",'expiration' => "",'cfp_redirect' => "");
try { $response = $rstack->request('User/CreateToken','POST',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($response);
Response 
<?xml version="1.0"?>
<recurringstack transaction_id="485527"> 	<user user_id="ef943d1c-b476-4720-8983-65977bc37d13"> 		<temporary_token token_expiration="1720888594" friendly_token_expiration="2024-07-13 11:07:36">37d13NrYPxEMLFaB0hUvzVg9oqk5DwpdjIiu3tmb1720888534</temporary_token> 		<cfp_login_link>https://yourbrand.recurringstack.com/cfp/link/37d13NrYPxEMLFaB0hUvzVg9oqk5DwpdjIiu3tmb1720888534/subscribe</cfp_login_link> 	</user> </recurringstack>

{
    "@attributes": {
        "transaction_id": "485527"
    },
    "user": {
        "@attributes": {
            "user_id": "ef943d1c-b476-4720-8983-65977bc37d13"
        },
        "temporary_token": "37d13NrYPxEMLFaB0hUvzVg9oqk5DwpdjIiu3tmb1720888534",
        "cfp_login_link": "https:\/\/yourbrand.recurringstack.com\/cfp\/link\/37d13NrYPxEMLFaB0hUvzVg9oqk5DwpdjIiu3tmb1720888534\/subscribe"
    }
}

API Simulator

Initiate a live call to the User/CreateToken service using the API simulator.

User/OAuthAuthenticate

Creates a link allowing an end-user to sign in or create a new account with a third party identity service. Currently, Facebook and Google are supported identity providers.

Upon successful authentication the end-user will be redirected to your 'redirect_uri' with a 'temporary_token' appended to the url. You can call the 'User/Authenticate' service with the 'temporary_token' to retreive the users account details.

Users are considered having an existing account when their authenticated email address matches the email address associated with the user.
Errors are appended to your 'failure_url' in the following format "failure_url?error=The error here"

Parameters
Parameter Type Required Description
identity_service string required Specifiy one of the supported identity services (valid options are google or facebook)
redirect_uri string required A fully qualified domain name where the user should be redirected after successful authentication with the identity service. The 'temporary_token' will be appended to the end of the url.
failure_uri string required A fully qualified domain name where the user should be redirected if authentication fails or the end-user cancels the process.
create_if_not_exists string required Wether a new account should be created for the authenticated user if one does not curently exist; essentialy allowing 'sign up' with a third party identity provider. Valid options are either 'Y' or 'N'.
POST https://api.recurringstack.com/{format}/User/OAuthAuthenticate 
//key,user_key,brand_id,response_format (xml or json),return (clean = return object, leave blank to return raw)
$rstack = new recurringstack('','','','xml','clean'); 

$params = array('identity_service' => "",'redirect_uri' => "",'failure_uri' => "",'create_if_not_exists' => "");
try { $response = $rstack->request('User/OAuthAuthenticate','POST',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($response);
Response 
<?xml version="1.0"?>
<recurringstack transaction_id="484252">
	<user>
		<OAuthAuthenticate oauth_request_id="8554c4fc-3c4b-43ba-81f2-e83961161f4f" expiration="1706898095">
			<identity_service>google</identity_service>
			<auth_url>https://api.recurringstack.com/oauth-authentication/?request_id=8554c4fc-3c4b-43ba-81f2-e83961161f4f</auth_url>
			<redirect_uri>http://shipez.com</redirect_uri>
			<failure_uri>https://faued.cin</failure_uri>
			<create_if_not_exists>Y</create_if_not_exists>
		</OAuthAuthenticate>
	</user>
</recurringstack>

{
    "@attributes": {
        "transaction_id": "484252"
    },
    "user": {
        "OAuthAuthenticate": {
            "@attributes": {
                "oauth_request_id": "8554c4fc-3c4b-43ba-81f2-e83961161f4f",
                "expiration": "1706898095"
            },
            "identity_service": "google",
            "auth_url": "https:\/\/api.recurringstack.com\/oauth-authentication\/?request_id=8554c4fc-3c4b-43ba-81f2-e83961161f4f",
            "redirect_uri": "http:\/\/shipez.com",
            "failure_uri": "https:\/\/faued.cin",
            "create_if_not_exists": "Y"
        }
    }
}

API Simulator

Initiate a live call to the User/OAuthAuthenticate service using the API simulator.
Your content here

Lorem ipsum dolor sit amet consectetur adipisicing elit. Qui, natus temporibus voluptate corporis possimus ab aut cumque.

Homepage

Quick Tips

You may remove all ID or Class names which contain _dm-, they are only used for demonstration.

Boxed Layout

Fluid Layout Remove the .boxed-layout and .centered-layout classes from the body.
Centered Layout Add a class .centered-layout to the body.
Boxed Layout Add a class .boxed-layout to the body.
Boxed Layout with background image

Add background image to the body.

<body class="boxed-layout" style='background-image: url("path_to_img/image.jpg");'>
    ..
    ..
</body>

Or it could be in your own class.

.bg-img {
background-image: url("path_to_img/image.jpg");
}
<body class="boxed-layout bg-img">
    ..
    ..
</body>

Color Schemes

Replace the current Bootstrap CSS and Nifty CSS path with the new path of the CSS color schemes you wish to use.

This is where you can change the color scheme of your app / website.

<head>
    ...
    <title>My Project</title>
    ...

    <!-- STYLESHEETS -->
    <!-- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~--- -->

    <!-- Bootstrap CSS [ REQUIRED ] -->
    <link rel="stylesheet" href="documentation/assets/css/color-schemes/SELECTED-SCEHEMS/bootstrap.min.css">

    <!-- Nifty CSS [ REQUIRED ] -->
    <link rel="stylesheet" href="documentation/assets/css/color-schemes/SELECTED-SCEHEMS/nifty.min.css">

</head>

Header

Sticky header Add a class .hd--sticky to the #root.
Expanded header Add a class .hd--expanded to the #root.
Expanded header with overlapping content. Add a class .overlapping to the #content > .content__header.
Disable rounded header. Add a class .rounded-0 to the #content > .content__header.

Animations

Add the following class to the body to change the animation transition.

Transition function name Class name
In Quart .in-quart
Out Quart .out-quart
In Back .in-back
Out Back .out-back
In Out Back .in-out-back
easeInOutBack .easeInOutBack
steps .steps
jumping .jumping
rubber .rubber
Tips on this page :
RecurringStack Documentation
RecurringStack Docs
RecurringStack Simulator API Credentials
A valid API key associated with your RecurringStack™ account.
The user key associated with your RecurringStack™ login.
The 'brand_id' associated with one of your brands.
NOTE: Your credentials will not be validated.

Sign In

Background Images

Add an image to replace the solid background color
Blurred
Background Image Background Image Background Image Background Image Background Image Background Image Background Image Background Image Background Image Background Image Background Image Background Image Background Image Background Image Background Image Background Image
Polygon & Geometric
Background Image Background Image Background Image Background Image Background Image Background Image Background Image Background Image Background Image Background Image Background Image Background Image Background Image Background Image Background Image Background Image
Abstract
Background Image Background Image Background Image Background Image Background Image Background Image Background Image Background Image Background Image Background Image Background Image Background Image Background Image Background Image Background Image Background Image
Layouts
Layouts
Transitions
Header
Additional Offcanvas New in BS v.5.0

Select the offcanvas placement.

Sidebars
Navigation
Right sidebar
Color Schemes
Light Completely bright color themes.
Dark Completely dark color themes.
Expanded Header
Fair Header
Full Header
Primary Nav
Brand
Tall Header New in v3.0
Scrollbars

Hides native scrollbars and creates custom styleable overlay scrollbars.

Offcanvas Header
Content Here

Lorem ipsum dolor sit amet, consectetur adipisicing elit. Sapiente eos nihil earum aliquam quod in dolor, aspernatur obcaecati et at. Dicta, ipsum aut, fugit nam dolore porro non est totam sapiente animi recusandae obcaecati dolorum, rem ullam cumque. Illum quidem reiciendis autem neque excepturi odit est accusantium, facilis provident molestias, dicta obcaecati itaque ducimus fuga iure in distinctio voluptate nesciunt dignissimos rem error a. Expedita officiis nam dolore dolores ea. Soluta repellendus delectus culpa quo. Ea tenetur impedit error quod exercitationem ut ad provident quisquam omnis! Nostrum quasi ex delectus vero, facilis aut recusandae deleniti beatae. Qui velit commodi inventore.