Introduction

The Stenn API is organized around REST. Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs. You can also use the Stenn API in test mode, which doesn't affect your live data. The API key you use to authenticate the request determines whether the request is live mode or test mode.

Base URL

The base URL to send all API requests to either the live or sandbox environment as follow:

JSON Conventions

• Top-level resources have an "object" property. This property can be used to determine the type of the resource (e.g. "company", "invoice", etc.)
• Top-level resources are addressable by a "id" property that are prefixed the object type associated to the resource.
• Property names are in snake_case (not camelCase or kebab-case).
• Temporal values (dates and datetimes) are encoded in ISO 8601 strings. Datetimes will include the time value (2020-08-12T02:12:33.231Z) while dates will include only the date (2020-08-12)
• The Stenn API does not support empty strings. To unset a string value for a given property, use an explicit null instead of "".

Pagination

Endpoints that return lists of objects currently does not support cursor-based pagination requests.