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'

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"
        }
    ]
}

Last updated