Every successful (200) HTTP request to our API will respond with an Application Response object. This object is used to provide a consistent format for responses to ensure that information returned in the requests is provided in an easy to consume form.

Application Response Object

Property	Type	Description
applicationEvents	An array of ApplicationEvent objects	See table below for more information.
payload	A generic object or array of objects	The information being returned by the request.
hasErrors	boolean	A flag used to inform whether or not our API found any issues with the request.

ApplicationEvent Object

Property	Type	Description
type	string	The type of the event. It will either be Info or Error.
code	string	The status code for the success or error. Each request will have its own set of possible error codes. Generic status codes and error codes can be found here.
message	string	A more detailed explanation of the success or error.
parameter	string	A parameter related to the event.