Skip to main content

Overview

An entity represents the compliance identity that participates in token sales. Entities can be individuals or organizations that complete verification and maintain eligibility status for different sales. All purchase permits and allocations are tied to entities, which are linked to wallet addresses.

Entity vs User vs Wallet

User

Individual person with a Sonar account
  • Signs up with email/password
  • Can manage multiple entities
  • Authenticates via OAuth

Entity

Compliance identity that participates in sales
  • Individual or organization
  • Completes KYC/KYB verification
  • Has eligibility status per sale

Wallet

Blockchain address linked to an entity
  • Used for actual token purchases
  • Multiple wallets per entity allowed
  • Must be linked on Sonar platform
In most cases, you will be interacting with a user who has a wallet. Sonar provides a way to lookup an entity by its wallet address. The API will return data about that entity, and also a unique entity ID which will be included in the purchase permit on the sale contract. Note that this entity ID is different for each sale, and is not the same as the entity ID on the Sonar platform.

Entity Lifecycle

Entities progress through verification to determine their ability to participate in token sales. All modifications to the enitty are done through the Sonar platform, and the user should be redirected there if they need to make changes.

Entity Setup States

Entities move through several setup states as they progress through verification on the Sonar platform. Each state represents a specific stage in the KYC/KYB journey. These are the possible setup states an entity may have:
StateValueDescription
Not Startednot-startedThe user has not started the setup process for the entity yet.
In Progressin-progressThe setup is in progress; the user should complete verification steps in the identity portal.
Ready For Reviewready-for-reviewThe user has submitted all required information; the entity is awaiting compliance review.
In Reviewin-reviewThe compliance team is currently reviewing submitted information.
CompletecompleteAll required compliance steps are finished and setup is complete.
FailurefailureThe setup failed due to issues the user can fix (for example, missing or invalid information).
Failure (Final)failure-finalThe setup failed due to issues the user cannot fix (for example, a compliance roadblock).
Technical Issuetechnical-issueThe setup process encountered a technical issue; users should contact support.
Note: Some setup states may require users to take specific actions, such as providing additional information or contacting support.

Sale-Specific Eligibility

Once verification is complete, entities are evaluated against each sale’s specific requirements, and is if one of the following states:
StateValueDescription
EligibleeligibleThe entity meets all sale requirements, has verified jurisdiction compliance, possesses an adequate accreditation level, and is allowed to generate purchase permits.
Not Eligiblenot-eligibleThe entity does not meet sale requirements, such as having the wrong jurisdiction or accreditation, compliance issues have been identified, and purchase permits are blocked.
Unknownunknown-setup-incompleteSetup is incomplete or required information is missing, so eligibility cannot be determined. The entity must complete verification first.
I