Request Verification Code

POST https://api.sfox.com/v1/enterprise/users/send-verification/:user_id

Request an email or sms verification code for your user.

Business accounts only need to verify email.

Individual accounts are required to verify email and sms. Email must be verified before requesting an sms code.

Request

Path Parameters

Name	Type	Description
user_id required	string	Unique ID defined by you for this user that will serve as the shared identifier for this account between you and sFOX

Body Parameters

Name	Type	Description
type required	string	Verification method. Possible values: email sms

Responses

200: OK

The following is an example response body to request an email verification code

{
    "data": {
        "user_id": "client_account_1",
        "type": "email",
        "email": "[e-mail]"
    }
}

{
    "data": {
        "user_id": "client_account_1",
        "type": "sms",
        "email": "[phone]"
    }
}

Example Requests

Shell

curl -X POST \
-H "Authorization: Bearer ${ENTERPRISE_API_TOKEN}" \
--data '{ "type": "email" }'  \
'https://api.sfox.com/v1/enterprise/users/send-verification/user_id'

NodeJS

const axios = require('axios');

const user_id = "user_id"
const data = JSON.stringify({ type: 'email'})
const config = {
  method: 'post',
  url: `https://api.sfox.com/v1/enterprise/users/send-verification/${user_id}`,
  headers: {
    'Content-Type': 'application/json',
    Authorization: `Bearer ${process.env.ENTERPRISE_API_KEY}`
  },
  data: data
}
  
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

data = requests.post(
  "https://api.sfox.com/v1/enterprise/users/send-verification/connect_account_1",
  headers={
    "Authorization": f"Bearer {os.environ['ENTERPRISE_API_KEY']}"
  },
  json={
    "type": "email"
  }
)
print(data.status_code)
print(data.json())