All responses to and from the API will be in JSON. All requests should include a Content-Type: application/json header

If you are a Signifyd customer and would like to access Enterprise API documentation, please log in here and navigate to the Resource Center within Developer Tools.

Versioning

We only update the version of our API when a non-backward-compatible change is made.

Signifyd considers the following changes to be backward-compatible:

• Adding new optional request parameter(s) to an existing API endpoint.
• Adding a new value to an enum field.
• Adding new fields to existing API responses.
• Changing the order of fields in an existing API response.
• Adding a brand new API resource.
• Adding a new webhook event. Your integration should handle unfamiliar webhook events gracefully.
• Changing the length of UUIDs (though we don't change lengths that often!).
• Changing the format of error messages, and other human-readable strings.

Response Codes

We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g. a required parameter was missing, invalid syntax, etc.), and codes in the 5xx range indicate an error with Signifyd's servers.

Dates

Our API uses the ISO8601 date format for complete date plus hours, minutes, seconds, and timezone offset.

         yyyy-MM-dd'T'HH:mm:ssZ
For UTC: 2015-11-03T13:21:58+00:00
For PST: 2015-11-03T13:21:58-08:00