# About the Trusted Twin API
# API Reference
The Trusted Twin API follows REST (opens new window) principles. It is designed to have predictable, resource-oriented URLs.
# Trusted Twin REST URI
All Trusted Twin REST API calls should be made to the https://rest.trustedtwin.com (opens new window) base domain. Please note that the Trusted Twin API is not accessible via plain HTTP requests.
Trusted Twin resources are accessed via standard HTTPS requests in UTF-8 format sent to the endpoints. The API uses appropriate HTTP verbs to define the method for each operation.
|POST||Create a resource|
|GET||Retrieve a resource|
|PATCH||Update a resource|
|DELETE||Delete a resource|
# Request body
If request parameters are provided via request body, the request body follows the JSON format.
Trusted Twin REST API responses are JSON-encoded (opens new window) objects.
# Trusted Twin IDs
The IDs on the Trusted Twin platform are standardised and follow the below formats.
|UUID||string||Unique ID of Trusted Twin objects (Account UUID, Twin UUID etc.). Follows the UUID Version 4 (opens new window) format.|
|Identity||string||User-defined ID for an Identity. It must match the regular expression (opens new window) |
# Description field
The description field is part of the User, Twin, and Doc objects. It allows for adding metadata to objects which can be used to create Rules or for indexing purposes.
|description||dictionary||User defined key-value pairs:|
- key: It must match the regular expression (opens new window)
- value: Valid JSON data type.
The timestamps on the Trusted Twin platform are standard Unix timestamps (opens new window). They display the number of seconds (to three decimal places) that have elapsed since the Unix epoch (opens new window).