Retrieve Tokens Catalog

Centralized solution designed to aggregate and provide seamless access to both on-chain and off-chain data related to ERC-3643 tokens deployed by Tokeny Factory. This API serves as a key resource for distributors, enabling them to retrieve comprehensive information about tokens, including metadata, compliance details, and network-specific attributes.

By consolidating this data into a single endpoint, the API simplifies the distribution process, ensuring that distributors have the insights needed to effectively list and manage tokens across multiple platforms.

ℹ️

Note:

As owner you can control whether distributors have access to your token data. Ensure that your token is marked as publishable before retrieving the catalog API.

📘

Prerequisites:

To complete this use case, you will need to authenticate your request(s). You can generate your token by following these steps:

• Make sure to leverage an existing account from the correct role, e.g. Agent, Owner, Investor, etc.
• If this use case requires you to leverage an Agent account, make sure your 2FA is disabled via the Servicing portal.
• Navigate to the "Getting API access" page to generate the required JWT, thanks to your credentials.
• Add the JWT to the header of your request.

List of Catalog Endpoints

Permissions

Data returned depends on the user's role and token permissions:

Query Parameters

 Response

The response is paginated and includes deployed token data, with access determined by the user's role.

Asset Portals: Provides URLs for applications used to manage the token portfolio.

Documents: are available only to the token owner or agent.

Primary Market: Returns an empty response if no subscription or redemption is configured.

Subscription: Returns the active subscription or, if none, the closest upcoming one (past subscriptions are excluded). The subscription type can be CLOSE_ENDED or OPEN_ENDED.

Redemption: Returns the active redemption or, if none, the closest upcoming one (past redemptions are excluded). The redemption type can only be OPEN_ENDED.

Secondary Market: Returns an empty response if no billboard or exchange is configured.

{
   "holdersArray":[
      {
         "typeOfInvestor":"<investor_type>",
         "individualOrInstitution":"<individual_or_institution>",
         "firstName":"<first_name>",
         "lastName":"<last_name>",
         "gender":"<gender>",
         "birthday":"<dob>",
         "birthplace":"<pob>",
         "nationality":"<nationality>",
         "idNumber":"<id_card_number>",
         "passportNumber":"<passport_number>",
         "ssnNumber":"<ssn_number>",
         "phone":"<phone_number>",
         "occupation":"<occupation>",
         "email":"<email_address>",
         "institutionTradeName":"<commercial_name>",
         "institutionLegalName":"<legal_name>",
         "institutionRegistryNumber":"<registry_number>",
         "institutionLegalForm":"<legal_form>",
         "institutionIncorporationDate":"<incorporation_date>",
         "institutionActivity":"<institution_activity>",
         "institutionRegistryCountry":"<country_registration>",
         "politicallyExposed":"<pep_status>",
         "buildingNumber":"<building_number>",
         "street":"<street_name>",
         "zipCode":"<zip_code>",
         "state":"<state>",
         "city":"<city>",
         "country":"<country>",
         "kycAml":"<kyc_aml_status>",
         "onchainidTCs":"<onchainid_tcs>",
         "wallet":"<wallet_address>",
         "holderId":"<holder_id>",
         "result":"Success: Identity imported/updated."
      }
   ]
}

Behavioral Rules

Filters Applied Always

• Only deployed tokens are returned.
• Only ERC-3643 tokens are included.

Subscriptions and Redemptions

• Return only one:
  • Active if exists.
  • Next closest in the future if active does not exist.
  • None otherwise.

Field Visibility Based on Role

• Public data is always included.
• Agent or distributor data is conditionally included.