sFOX API
Sign InOpen Account
Connect API
Connect API
  • Introduction
    • Welcome
    • Getting Started
    • Resources
      • Terminology
      • Systems & Operations
      • Integration Options
    • Guides
      • End User Onboarding & KYC
        • Individuals
        • Businesses
        • Enhanced Due Diligence
  • REST API
    • REST Endpoints
    • Authentication
    • End Users
      • Create End User Account
      • Request Verification Code
      • Confirm Verification Code
      • Create User Auth Token(s)
      • Get End User(s)
      • Get EDD Requests
      • Get EDD Prompts
      • Create EDD Responses
        • Uploading Files as Responses
      • Submit Documents
      • Deactivate User
    • Payments
      • Create Bank Account (Plaid)
      • Create Bank Account
      • Get Bank Account
      • Get Plaid Processors
      • Amend Plaid Processors
      • Verify Bank Account
      • Delete Bank Account
      • Get Wire Instructions
      • Get ACH Agreement Status
      • Request ACH Onboarding
      • Get ACH Deposit Limit
    • Withdrawals
      • Confirm Withdrawal
      • Resend Confirmation Code
      • Cancel Withdrawal
    • Transfers
      • Create Transfer
      • Confirm Transfer
      • Resend Confirmation Code
      • Cancel Transfer
      • Get Transfer Permissions
      • Get Transfer History
    • Monetization
      • Create Setting
      • Update Setting
      • Delete Setting
      • Get Settings
      • Get Permissions
      • Get Monetization History
  • WebSocket API
    • Connecting
    • Authentication
    • Subscribing & Unsubscribing
    • Message Format
    • End Users
      • Onboarding
      • Balances
      • Orders
      • Trades
    • Market Data
      • Order Book
      • Trades
      • Ticker
  • Single Sign-On
    • Overview
      • IdP Initiated SSO
    • IdP Data
    • SAML Response Data
  • Errors
    • Error Codes
Powered by GitBook
On this page
  • Request
  • Query Parameters
  • Example Requests
  • Response
  • Response Body
  • Responses
  1. REST API
  2. End Users

Get EDD Requests

GET

https://api.sfox.com/v1/enterprise/eddq/requests

Returns a list of requests for all your users that are required to complete EDD.


Note: Only requests with status = REQUESTED or PARTIAL_SUBMISSION are required to complete EDD

Request

Query Parameters

Parameter
Description

user_id

Filters the EDD requests for a specific user based on their user_id.

Example Requests

curl -X GET \
  -H  "Authorization: Bearer ${ENTERPRISE_API_KEY}" \
   'https://api.staging.sfox.com/v1/enterprise/eddq/requests'
const axios = require('axios');

let config = {
  method: 'get',
  maxBodyLength: Infinity,
  url: 'https://api.staging.sfox.com/v1/enterprise/eddq/requests',
  headers: { 
    'Authorization': `Bearer ${process.env.ENTERPRISE_API_KEY}`, 
  }
};

axios.request(config)
  .then((response) => {
    console.log(response.status);
    console.log(response.data);
  })
  .catch((error) => {
    console.log(error.response.status);
    console.log(error.response.data);
  });
import requests
import os


response = requests.get('https://api.staging.sfox.com/v1/enterprise/eddq/requests',
  headers={ 
    'Authorization': f"Bearer {os.environ['ENTERPRISE_API_KEY']}" 
  })

print(response.status_code)
print(response.json())

Response

Response Body

Key
Description

id

The unique, sFOX-generated ID of the EDD request.

user_id

The unique ID of the user shared between sFOX and you.

ddq_id

The ID of the type of EDDQ (Enhanced Due Diligence Questionnaire)

required_form

The name of the EDDQ based on the ddq_id. Possible values:

  • EDDQ - Individual

  • EDDQ - Business

status

The completion status of the EDDQ.

date_added

The date that the EDDQ request was added.

date_updated

The date that the EDDQ request was most recently updated.

Responses

200: OK
All users
{
"data": [
        {
            "id": 1,
            "user_id": "187ce1a6-dd9d-4a6a-9a79-71425584e3ba",
            "ddq_id": 1,
            "required_form": "EDDQ - Individual",
            "status": "IN_REVIEW",
            "date_added": "2024-03-20T00:16:52.000Z",
            "date_updated": "2024-03-20T00:16:52.000Z"
        },
        {
            "id": 6,
            "user_id": "testing",
            "ddq_id": 1,
            "required_form": "EDDQ - Individual",
            "status": "REVIEWED",
            "date_added": "2024-03-29T16:55:55.000Z",
            "date_updated": "2024-03-29T16:55:55.000Z"
        },
        {
            "id": 8,
            "user_id": "clelele",
            "ddq_id": 1,
            "required_form": "EDDQ - Individual",
            "status": "REQUESTED",
            "date_added": "2024-04-03T17:57:25.000Z",
            "date_updated": "2024-04-03T17:57:25.000Z"
        }
    ]
}
PreviousGet End User(s)NextGet EDD Prompts

Last updated 1 day ago