OAS specification

Open API Specification

Youtrust public API V3 Open API Specification can be downloaded here.

📘

You can use tools like Open API generator or Swagger Codegen to generate an API client in the programming language of your choice.


Custom Data Types

Some String formats are customized and follow a custom rule.

Safe String

A Safe String is used at multiple places in the OAS Definition. Most simple example is the Signature Request name property.

A Safe String is a chain of characters which respects a combination of one or multiple rules described below:

  • The Safe String must not have leading or trailing whitespaces
  • The Safe String must not contain html tags
  • The Safe String must not contain url
  • The Safe String must not contain email

Some usage examples in our OAS descriptions:

  • This property is a Safe String : whitespaces, html tags, url, email are forbidden
  • This property is a Safe String allowing email and URL : whitespaces and html tags are forbidden
  • This property is a Safe String allowing email, URL and leading or trailing whitespaces: html tags are forbidden