Function OnchainIdentityApiFactory

  • OnchainIdentityApiFactory(configuration?, basePath?, axios?): {
        resolveIdentityByAddress(networkId, addressId, roles?, limit?, page?, options?): AxiosPromise<OnchainNameList>;
    }

  • OnchainIdentityApi - factory interface

    Parameters

    • Optional configuration: Configuration
    • Optional basePath: string
    • Optional axios: AxiosInstance

    Returns {
        resolveIdentityByAddress(networkId, addressId, roles?, limit?, page?, options?): AxiosPromise<OnchainNameList>;
    }

    • resolveIdentityByAddress:function
      • resolveIdentityByAddress(networkId, addressId, roles?, limit?, page?, options?): AxiosPromise<OnchainNameList>

      • Obtains onchain identity for an address on a specific network

        Parameters

        • networkId: string

          The ID of the blockchain network

        • addressId: string

          The ID of the address to fetch the identity for

        • Optional roles: ResolveIdentityByAddressRolesEnum[]

          A filter by role of the names related to this address (managed or owned)

        • Optional limit: number

          A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

        • Optional page: string

          A cursor for pagination across multiple pages of results. Don&#39;t include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.

        • Optional options: RawAxiosRequestConfig

          Override http request option.

        Returns AxiosPromise<OnchainNameList>

        Summary

        Obtains onchain identity for an address on a specific network

        Throws

    Export

Settings

Member Visibility

Theme