Create EDD Responses
POST
https://api.sfox.com/v1/enterprise/eddq/responses
Submit a user's responses to an EDD request.
Request
All required prompts (is_required
= true
) must be answered. Excluding a response to a required prompt in your request will result in an error response and responses included in your request will not be recorded/must be re-submitted in a new request.
For EDD prompts with response_type
= File-Upload
prompts, you will submit the file name only in this request.
response
must be set to the file name excluding the extension (e.g..jpg
,.pdf
) For example, if you are submitting a document with file namepor_file.png
, you would set theresponse
=por_file
.After creating EDD responses here, you must submit the file itself either via a Submit Documents request or SFTP.
Body Parameters
user_id
required
string
The unique user ID of the user that you will be submitting responses for.
prompts
required
string
The list of prompts applicable to the requested EDDQ.
response
required
string
The response from your end user.
optional_free_form
string
The optional response from your end user if optional_free_form
= true
Example Requests
{
"user_id": "${USER_ID}",
"prompts": {
"1": { "response": "hello"},
"2": { "response": "hello"},
"3": { "response": "hello"},
"4": { "response": "hello"},
"5": { "response": "hello"},
"4": { "response": "hello", "optional_free_form":"hello world"},
"52": {"response": "id_file"},
"53": {"response": "por_file"}
}
}
curl -X POST \
-H 'Content-Type: application/json' \
-H "Authorization: Bearer ${ENTERPRISE_API_KEY}" \
--data '{
"user_id": "${USER_ID}",
"prompts": {
"1": {"response": "${Response to prompt ID 1}"},
"2": {"response": "${Response to prompt ID 2}"},
"3": {"response": "${Response to prompt ID 3}"},
"52": {"response": "${filename1}"},
"53": {"response": "${filename2}"}
}
}' \
'https://api.sfox.com/v1/enterprise/eddq/responses'
Response
Last updated