Create User Auth Token

POST	https://api.sfox.com/v1/enterprise/user-tokens/:user_id

Generate a user auth token for a specific end user.

---

User auth tokens are short-lived authentication tokens, expiring 24 hours after creation (expiration of a given token specified in the expires field of the response). User auth tokens are used for actions specific to a user's account (e.g. Initiate an ACH Deposit, Create an Order).

sFOX recommends that you do not store user auth tokens. Instead, create a new user auth token as needed whenever executing requests on behalf of a specific user.

There is no limit to the number of user auth tokens that may be created.

You can create user auth tokens for multiple users using Create Multiple User Auth Tokens requests.

Request

Path Parameters

Parameter	Description
user_id required, string	ID of the specific user you want to create a user auth token for.

Example Requests

Shell

export userId="156c5beb-7c9f-4f68-83c0-9479703ac490"

curl -X POST \
-H "Authorization: Bearer ${ENTERPRISE_API_KEY}" \
"https://api.sfox.com/v1/enterprise/user-tokens/${userId}"

NodeJS

const axios = require('axios');

const userId = "156c5beb-7c9f-4f68-83c0-9479703ac490"

const config = {
  method: 'post',
  url: `https://api.sfox.com/v1/enterprise/user-tokens/${userId}`,
  headers: {
    "Content-Type": "application/json",
    'Authorization': `Bearer ${process.env.ENTERPRISE_API_KEY}`
  }
}

axios(config)
  .then(response => {
    console.log(response.status)
    console.log(response.data)
  }).catch(err => {
    console.error(err.response.status)
    console.error(err.response.data)
  });

Python

import requests
import os

userId = "156c5beb-7c9f-4f68-83c0-9479703ac490"

data = requests.post(
  f"https://api.sfox.com/v1/enterprise/user-tokens/{userId}",
  headers={
    "Authorization": f"Bearer {os.environ['ENTERPRISE_API_KEY']}"
  }
)
print(data.status_code)
print(data.json())

Response

Response Fields

Field	Description
data object	User auth token information.
token string	The user authentication token that you will use to access this specific user's sFOX account
partner_user_id string	The user_id the token grants access to.
expires string	The expiration date of the user auth token. ISO-8601 date and time in UTC time zone.

Responses

201 Created

User auth token for a single user_id

{
    "data": {
        "token": "bcf5ab0aa8dfebc86460338514dd022d63080277373002e6986d7925375a0087",
        "partner_user_id": "client_db29326e-5df6-4d8b-aaaa-b75dc194a0a2",
        "expires": "2024-05-14T19:22:09.901Z"
    }
}