Standard Parameters

Parameters that apply to this IAG OAuth API

Request Parameters

 
Accept String
Optional 
(Header)		 External Specifies the response body format. Acceptable values are:
application/json (default)
application/xml
Example: Accept: application/json
grant_type String
Required 
(Body)		 External & Internal Acceptable values: client_credentials
api_key String
Required 
(Body)		 External & Internal

API Key that is issued to the application
api_secret String
Required 
(Body)		 External & Internal API Secret that is issued to the application

 

Response Parameters

 
X-RateLimit-Limit
String 
Required 
(Header)		 The total number of requests allowed within the 1-hour window.
X-RateLimit-Remaining
String
Required 
(Header)		 The remaining number of requests available to your application within the 1-hour window.
X-RateLimit-Reset
String
Required 
(Header)		 The remaining window in UTC epoch seconds before the time period resets.
status
Object
Required 
Body		 Status code object. The “errors” object will only be included when the response code is not: 200 OK.There can be 1..N of these error messages. 
“errors” object includes “message”, “helpUrl” and ‘type”. If “suppressResponseCode” is set to “true” then all response statuses will be set to 200 instead of the native http response code in error situations. The code in the status section of the response will always have the actual response code. 

Example: “status”:{“code”:200}

status:{ 
  code:201,
  errors:[
            { 
	     message:"Home Insurance Estimate not completed",
  	     type:”80001” 
            },
            { 
   	     message:”Home Insurance Estimate not completed.”,
  	     type:”80003”
       	    }
    	  ]
  }
data
Object
Required 
Body		 Specifies the page of the record collection to return, typically used in conjunction with {limit}, default 1.

 

Response Codes

 
201 Created Returned when a request was valid
400 Bad Request Malformed or invalid request was received
401 Unauthorized Invalid token or user does not have access to an api or an api’s method
406 Not Acceptable Invalid format is specified in the Accept Header.
500 Internal Server Error The server was unable to process the request because of a problem with the platform

 

Generic Error Responses

 
AUTH_95001 An error occurred on the server when processing the request.
AUTH_97001
  • Invalid request
  • Invalid Access Token
  • Invalid API Key
  • Account plan limit exceeded