Get EDD Prompts

GET

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

Returns the list of questions (prompts) that your users must respond to according to the EDD request.

circle-info

For additional details regarding EDD and completing EDD requests, see our Enhanced Due Diligence (EDD) guide.


Request

Query Parameters

Parameter
Type
Description

account_type

string

Filters the questions between individual and business accounts. Possible values: individual or corporation

Example Requests

curl -X GET \
  -H  "Authorization: Bearer ${ENTERPRISE_API_KEY}" \
  'https://api.sfox.com/v1/enterprise/eddq/prompts'

Response

Response Body

Key
Type
Description

id

int

The unique ID of the mapping between a prompt_id and a ddq_id

required_form

string

The name of the EDDQ based on the ddq_id

prompt_id

int

The unique ID of the prompt

ddq_id

int

The unique ID of the EDDQ

account_type

string

The type of account (individual/corporation) that the prompt applies to

is_required

boolean

This defines whether the question is a mandatory field in the EDDQ. All mandatory questions must be answered before a DDQ can be submitted.

prompt

string

The question that users have to respond to

response_type

string

The type of response that the prompt requires. It can be Free-Form, Single-Select, or File-Upload. Free-Form: Users can respond with a string as a response Single-Select: Users must respond with one of the response_options provided File-Upload: Users will have to upload a document

response_options

string

The list of possible responses for Single-Select type prompts

optional_free_form

boolean

This is an optional field that allows users to input a custom string response to certain questions when optional_free_form = true

E.g. If a user selects Others as their response in a Single-Select type prompt, they can include their comments in the optional form

Responses

chevron-right200: OKhashtag

Last updated