Form Simplicity API Documentation
Exception Information
Exceptions sometimes do occur, refer to this doc for more info on the specific errors.
Unsupported Grant Type
Response: 400 Bad Request
{
"title": "Unsupported Grant Type",
"type": http://api.formsimplicity.com/docs/errors",
"status": 400,
"detail": "The authorization grant type is not supported by the authorization server ..."
}
Invalid Request
Response: 400 Bad Request
{
"title": "Invalid Request",
"type": "http://api.formsimplicity.com/docs/errors",
"status": 400,
"detail": "The request is missing a required parameter ..."
}
Invalid Credentials
Response: 401 Unauthorized
{
"title": "Invalid Credentials",
"type": http://api.formsimplicity.com/docs/errors",
"status": 401,
"detail": "The user credentials were incorrect. ..."
}
Access Denied
Response: 410 Unauthorized
{
"title": "Access Denied",
"type": http://api.formsimplicity.com/docs/errors",
"status": 410,
"detail": "The resource owner or authorization server denied the request ..."
}
Missing Required Parameters
Response: 400 Bad Request
{
"title": "Missing Required Parameters",
"type": http://api.formsimplicity.com/docs/errors",
"status": 400,
"detail": "Missing Required parameters: {Missing Parameters}"
}
If only one of multiple parameters is missing from request -
check spelling or include param even if you are setting it to blank.
If all parameters are missing from request - Make sure you are setting Content Type to
application/json if providing Json in the body of the request.
Not Found
Response: 400 Bad Request
{
"title": "{endpoint} Not Found",
"type": http://api.formsimplicity.com/docs/errors",
"status": 400,
"detail": "{endpoint} matching id parameter not found"
}
List Transactions Request Failure
Response: 404 List Transactions Request Failure
{
"title": "List Transactions Request Failure",
"type": http://api.formsimplicity.com/docs/errors",
"status": 400,
"detail": "Invalid Filter: Missing NRDS ID in Filter Parameter"
}