API Reference

Key Concepts

Here, we go over the core data models and entities you will interact with when using Yakoa's content autnentication API. Understanding these concepts is key to a seamless integration.

Table of Contents


Brand

Purpose: Represents an external IP owner (company, organization, or individual) from outside your platform. Brands are the basis against which Tokens are checked for infringement.

Why it matters: No network will contain all IP that could be infringed upon, so Yakoa also monitors for infringements against well known, public IP. Matches against this IP are flagged against Brand deemed to own the IP. These results are reported as external_infringements in the Token API, opposed to in_network_infringements, which are only checked against the content already registered in the network.


Creator

Purpose: Represents an entity (often identified by a blockchain address or platform user ID) responsible for producing Tokens.

Why it matters: Tracks provenance of Tokens. Enables Brand-level authorizations for Creators, simplifying IP management for trusted partners, and prevents flagging multiple tokens created by the same Creator against each other.


Token

Purpose: A tokenized media asset, which includes one or more media files (images, videos, audio) and provenance metadata (NFTs or content credentials). Each Token is checked for potential IP infringement.

Why it matters: This is the primary entity for IP analysis. The media URLs must be publicly accessible for checks to occur.


Authorization

Purpose: A formal record indicating that a Brand has permitted a specific Creator or a specific Token to use its IP. This is crucial for distinguishing legitimate use from infringement.

Why it matters: Allows Brands to whitelist trusted Creators or specific content, reducing false positives and enabling collaborations.


License

Purpose: Represents a formal agreement or permission that grants a Token the right to use intellectual property from another Token (a "parent" Token).

Why it matters: Licenses allow for the creation of legitimate derivative works and complex IP relationships within networks. Declaring licenses helps the system understand these relationships and can influence infringement analysis (e.g., a Token might match a Brand's IP, but if it's licensed from an authorized parent Token that also derives from the Brand, it is not considered an infringement).


Trust

Purpose: Allows a token's media to be marked as trusted. The currently available reasons for trust are:

  • Platform Trust: The platform the media came is is trusted, meaning the media is not likely to infringe on any IP.
  • No Licenses: The media has no licenses that can be obtained from it, reducing the damage of a potential infringement.

Why is matters: Trusted assets allow you to supplement Yakoa's checks with your own internal trust signals. This can bypass comprehensive infringement checking, but to still allow downstream infringements to be flagged against the trusted media.