v1

latestOpenAPI 3.1.02026-07-2685154311.7 KB

Network

Get Entity

Retrieves VASP/Entity information from the Network API by DID. Returns detailed information about the entity including regulatory status, verification status, and protocol support.

get/network/{entityDID}

Path parameters

entityDIDstring did required

Decentralized Identifier (DID)

Example:did:web:vasps.id:jxnl0411:at

The DID of the entity

Query parameters

fieldsstring

Comma-separated list of fields to include in the response.

reviewedByVaspDIDstring

Example:did:web:example.com

showJurisdictionStatusstring

includeSubsidiariesstring

string

string[]

string

string[]

Response

Entity retrieved successfully

didstring

namestring nullable

legalNamestring nullable

otherNamesstring[] nullable

subsidiaryOfstring nullable

adminEmailsstring nullable

logostring nullable

websitestring nullable

descriptionstring nullable

legalStructurestring nullable

incorporationCountrystring nullable

identificationTypestring nullable

identificationCountrystring nullable

businessNumberstring nullable

leiNumberstring nullable

otherLegalNamestring nullable

legalFormstring nullable

addressLine1string nullable

addressLine2string nullable

citystring nullable

countrystring nullable

streetstring nullable

numberstring nullable

unitstring nullable

postCodestring nullable

statestring nullable

hqStreetstring nullable

hqNumberstring nullable

hqUnitstring nullable

hqPostcodestring nullable

hqRegionstring nullable

hqCitystring nullable

hqCountrystring nullable

isRegulatedstring nullable

regulatoryStatusstring nullable

{"stackTrail":"paths:/network/{entityDID}:get:responses:200:content:application/json:schema:properties:regulatoryAuthorities:anyOf","oasType":"schema","type":"unknown","nullable":true}

supervisoryAuthoritystring nullable

registrationLicenseIdstring nullable

statusStartDatestring nullable

statusExpirationDatestring nullable

lastCheckedstring nullable

additionalInformationstring nullable

verificationStatusstring nullable

entityCategorystring nullable

entityStatusstring nullable

hasAdminboolean nullable

isNotifiableboolean nullable

isActiveSenderboolean nullable

isActiveReceiverboolean nullable

reviewValuestring nullable

reviewNotestring nullable

reviewDatestring nullable

reviewedBystring nullable

jurisdictionsstring nullable

jurisdictionStatusobject nullable

jurisdictionNotabenePagestring nullable

travelRule_OPENVASPstring nullable

travelRule_SYGNAstring nullable

travelRule_TRISAstring nullable

travelRule_TRLIGHTstring nullable

travelRule_EMAILstring nullable

travelRule_TRPstring nullable

travelRule_SHYFTstring nullable

travelRule_USTRAVELRULEWGstring nullable

travelRule_TRUSTstring nullable

travelRule_notabenestring nullable

certificatesstring nullable

emailDomainsstring nullable

documentsstring nullable

{"stackTrail":"paths:/network/{entityDID}:get:responses:200:content:application/json:schema:properties:division:anyOf","oasType":"schema","type":"unknown","nullable":true}

issuersobject nullable

onboardingStatusstring nullable

compliancePhasenumber nullable

compliancePhaseDataobject nullable

billing_customer_didstring nullable

subscription_idstring nullable

untracked_usage_in_periodnumber nullable

created_atstring nullable

updated_atstring nullable

vaspnetIdstring nullable

vaspnetImmutableFieldsstring[] nullable

protocolobject nullable

vasp_categoriesstring nullable

isNotabeneCustomerboolean nullable

testPhoneNumberstring nullable

autoEnableWhenUserJoinsboolean nullable

logo_filenamestring nullable

logo_updated_atstring nullable

chainalysis_namestring nullable

badgesstring[] nullable

isSandboxboolean nullable

identificationNumberstring nullable