Skip to main content
GET
Returns the verification profiles your instance runs. A profile ties a verification level to the investor type it results in, the documents it requires, the countries it refuses, and who it admits: individuals or companies, and whether only professional clients. That lets a hosted ID Link be issued against a named level rather than an ad-hoc set of requirements.

Response Fields

array
data is the array itself, not an object wrapping one. Profiles are created and edited in the Issuer Portal; this surface reads them. The first call creates the three presets when the instance has none. Presets come first, then custom profiles, oldest first.

Who a profile admits

entityType decides which applicant the identity check runs for. An ID link under a COMPANY profile creates a company applicant, and a review of the other kind of applicant is refused. A wallet is admitted to the profile’s eligibility register only when the customer record holding it has the same customerType. professionalOnly matters to lending. A market that prices its collateral from a live market price (MARKET) lends to professional borrowers only, so its borrower gate must be a register admitted to only by profiles with professionalOnly: true in the REGISTER mode, at least one of them. Profiles of other instances bound to the same register count too, and a profile in the EXTERNAL mode does not. See Set Identity Gates. reverifyDays limits how long an admission lasts. Once that many days have passed since a wallet was admitted or its customer was last verified, the admission lapses and its removal from the register is queued. An ID link under the profile also queues its on-chain registration with a hard expiry of reverifyDays, and a soft expiry of 180 days or reverifyDays, whichever is shorter.

Eligibility registers

A profile with an eligibility register is what lending markets and vaults can gate on. The register is an on-chain identity register that holds exactly the wallets admitted under the profile, so a gate that reads it admits the customers of that profile and nobody else. Name the profile by its key wherever a market or vault takes a register: identityRegistryProfile and providerRegistryProfile on Deploy Market and Accept Lender Role, and borrowerProfile and providerProfile on Set Identity Gates. Get Deployment Options lists the profiles that have one. A register is deployed for a profile, or an existing one bound to it, in the Issuer Portal. One register stands for one profile of your instance, and a profile limited to professional clients takes only a register in the REGISTER mode. Who is on it is managed through Eligibility registers.

Usage

usage shows how far a change to the profile would reach. The Issuer Portal decides by the same counts. A profile with customer records, open links, pending registrations or admitted wallets cannot be deleted, and a change to its classification (its on-chain investor type, professionalOnly or entityType) has to be confirmed before it applies to all of them. Its key cannot change once a customer record, link, pending registration or admission names it.

Requirements hash

requirementsHash is keccak256 of a canonical JSON of what the profile requires: its key, entityType, professionalOnly, onChainInvestorType, sumsubLevelName, the document sets with their accepted types and whether each is required, blockedCountries and reverifyDays. The name, the description, enabled and the field labels are not part of it. Every admission records the hash it was requested under. An admission whose hash differs from the profile’s current one was made under requirements that have changed since, and List Admissions reports it with current: false.

Blocked countries

A customer from a country on blockedCountries is refused with 403 COUNTRY_BLOCKED wherever the profile applies. That covers ID links and customer records that name it, the pending verification queue, and admissions to the profile’s eligibility register. Verify Identity and Batch Verify check the profile whose key matches the request’s investorType, preset or custom. Changing a profile’s list in the Issuer Portal also queues the removal of every wallet on its eligibility register whose customer’s country the new list blocks.

Error Codes