Identity MCP Server

A Model Context Protocol (MCP) server resource permitting MCP clients to apply for, and manage digital legal identities.

MCP Server Interface

This MCP Server is accessible on this endpoint: https://lab.tagroot.io/MCP/Identity

Scopes supported:

The following subsections list MCP Server interfaces that are available on this resource. The MCP protocol is built on top of the JSON-RPC protocol. You find JSON-RPC interface below.

MCP Server Tools

Following subsections list MCP Server Tools that can be used to interact with the MCP Server.

Add Photo Attachment (BASE64 upload)

Adds a photo attachment to an identity application, by providing a BASE64-encoded binary of the photo together with its corresponding Content-Type.

Properties
Can Modify: Yes
Can Destroy: No
Is Idempotent: No
Open World Access: No

AddPhotoAttachmentBase64Upload(LegalId, Base64Photo, ContentTypePhoto, PhotoType)

Authentication
Required: Yes
Privileges Required: OAUTH.Scope.MCP.Identity.Tools.Attachment.Add
Authentication Mechanisms: Bearer JWT (128+ bit Encryption), Basic (128+ bit Encryption), Digest-MD5 (128+ bit Encryption), Digest-SHA-256 (128+ bit Encryption), Digest-SHA-3-256 (128+ bit Encryption), Session
Arguments
Name Type Use Default Value Description
LegalId String Required - Legal Identity Identifier or Identity resource URI to which the attachment shall be added.
Base64Photo String Required - BASE64-encoded photo to be uploaded.
ContentTypePhoto String Required - Content-Type of the photo to be uploaded.
PhotoType PhotoType Optional "ProfilePhoto"

Type of photo to be uploaded. Possible values:

  • "ProfilePhoto" - Profile photo.
  • "Passport" - Photo of passport.
  • "IdCardFront" - Front of ID card.
  • "IdCardBack" - Back of ID card.
  • "DriverLicenseFront" - Front of Driver’s License.
  • "DriverLicenseBack" - Back of Driver’s License.
Return Value
Type Description
IdentityResponse Identity update result.

Add Photo Attachment (User Input)

Adds a photo attachment to an identity application, by eliciting the user for the photo.

Properties
Can Modify: Yes
Can Destroy: No
Is Idempotent: No
Open World Access: No

AddPhotoAttachmentElicitation(LegalId, PhotoType)

Authentication
Required: Yes
Privileges Required: OAUTH.Scope.MCP.Identity.Tools.Attachment.Add
Authentication Mechanisms: Bearer JWT (128+ bit Encryption), Basic (128+ bit Encryption), Digest-MD5 (128+ bit Encryption), Digest-SHA-256 (128+ bit Encryption), Digest-SHA-3-256 (128+ bit Encryption), Session
Arguments
Name Type Use Default Value Description
LegalId String Required - Legal Identity Identifier or Identity resource URI to which the attachment shall be added.
PhotoType PhotoType Optional "ProfilePhoto"

Type of photo to be uploaded. Possible values:

  • "ProfilePhoto" - Profile photo.
  • "Passport" - Photo of passport.
  • "IdCardFront" - Front of ID card.
  • "IdCardBack" - Back of ID card.
  • "DriverLicenseFront" - Front of Driver’s License.
  • "DriverLicenseBack" - Back of Driver’s License.
Return Value
Type Description
IdentityResponse Identity update result.

Add Photo Attachment (URL Download)

Adds a photo attachment to an identity application, by providing a URL to the photo to be downloaded and then added as an attachment.

Properties
Can Modify: Yes
Can Destroy: No
Is Idempotent: No
Open World Access: No

AddPhotoAttachmentUrlDownload(LegalId, PhotoUrl, PhotoType)

Authentication
Required: Yes
Privileges Required: OAUTH.Scope.MCP.Identity.Tools.Attachment.Add
Authentication Mechanisms: Bearer JWT (128+ bit Encryption), Basic (128+ bit Encryption), Digest-MD5 (128+ bit Encryption), Digest-SHA-256 (128+ bit Encryption), Digest-SHA-3-256 (128+ bit Encryption), Session
Arguments
Name Type Use Default Value Description
LegalId String Required - Legal Identity Identifier or Identity resource URI to which the attachment shall be added.
PhotoUrl URI Required - URL of the photo to be downloaded.
PhotoType PhotoType Optional "ProfilePhoto"

Type of photo to be uploaded. Possible values:

  • "ProfilePhoto" - Profile photo.
  • "Passport" - Photo of passport.
  • "IdCardFront" - Front of ID card.
  • "IdCardBack" - Back of ID card.
  • "DriverLicenseFront" - Front of Driver’s License.
  • "DriverLicenseBack" - Back of Driver’s License.
Return Value
Type Description
IdentityResponse Identity update result.

Apply For New Personal Identity

Applies for a new personal identity. Personal information will be elicited from the user.

Properties
Can Modify: Yes
Can Destroy: Yes
Is Idempotent: No
Open World Access: No

ApplyForNewPersonalIdentity()

Authentication
Required: Yes
Privileges Required: OAUTH.Scope.MCP.Identity.Tools.Apply
Authentication Mechanisms: Bearer JWT (128+ bit Encryption), Basic (128+ bit Encryption), Digest-MD5 (128+ bit Encryption), Digest-SHA-256 (128+ bit Encryption), Digest-SHA-3-256 (128+ bit Encryption), Session
Return Value
Type Description
IdentityResponse Identity application result.

Compromise Identity

Reports one of the identities or identity applications registered by the user as compromised.

Properties
Can Modify: Yes
Can Destroy: Yes
Is Idempotent: No
Open World Access: No

CompromiseIdentity(LegalId)

Authentication
Required: Yes
Privileges Required: OAUTH.Scope.MCP.Identity.Tools.Compromise
Authentication Mechanisms: Bearer JWT (128+ bit Encryption), Basic (128+ bit Encryption), Digest-MD5 (128+ bit Encryption), Digest-SHA-256 (128+ bit Encryption), Digest-SHA-3-256 (128+ bit Encryption), Session
Arguments
Name Type Use Default Value Description
LegalId String Required - Legal Identity Identifier or Identity resource URI to report as compromised.
Return Value
Type Description
IdentityResponse Identity compromised report result.

Create Open Smart Contract

Creates a new open smart contract, based on a contract template. (Open means parts are not predefined.)

Properties
Can Modify: Yes
Can Destroy: No
Is Idempotent: No
Open World Access: Yes

CreateOpenContract(TemplateId, Parameters, Visibility, DurationDays, ArchiveRequiredDays, ArchiveOptionalDays, SignAfter, SignBefore)

Authentication
Required: Yes
Privileges Required: OAUTH.Scope.MCP.Identity.Tools.Contract.Create
Authentication Mechanisms: Bearer JWT (128+ bit Encryption), Basic (128+ bit Encryption), Digest-MD5 (128+ bit Encryption), Digest-SHA-256 (128+ bit Encryption), Digest-SHA-3-256 (128+ bit Encryption), Session
Arguments
Name Type Use Default Value Description
TemplateId String Required - Identifier of the Smart Contract template to use as basis for the new smart contract.
Parameters Dictionary Required - Dictionary object of parameter values to use for the contract. The parameters must be defined in the contract template, and the values must be valid in accordance with validation rules defined in the contract template.
Visibility ContractVisibility Required -

Visibility of created contract. Possible values:

  • "CreatorAndParts" - Creator and Parts
  • "DomainAndParts" - Domain
  • "Public" - Public
  • "PublicSearchable" - Public and Searchable
DurationDays 32-bit signed integer Required - Duration of contracts, once signed, as a number of days. [1,∞)
ArchiveRequiredDays 32-bit signed integer Optional 365 Required archiving time, once contract expires, as a number of days. [0,∞)
ArchiveOptionalDays 32-bit signed integer Optional 0 Optional archiving time, once contract expires, as a number of days. [0,∞)
SignAfter Nullable Date & Time Optional null Signatures will only be accepted after this point in time, if defined. (∞,∞)
SignBefore Nullable Date & Time Optional null Signatures will only be accepted before this point in time, if defined. (∞,∞)
Return Value
Type Description
ContractResponse Result of operation.

Get Identity Application Properties

Gets identity application properties recommended by the server should be available in identity applications.

Properties
Can Modify: No
Can Destroy: No
Is Idempotent: Yes
Open World Access: No

GetIdentityApplicationProperties()

Authentication
Required: Yes
Privileges Required: OAUTH.Scope.MCP.Identity.Tools.Apply
Authentication Mechanisms: Bearer JWT (128+ bit Encryption), Basic (128+ bit Encryption), Digest-MD5 (128+ bit Encryption), Digest-SHA-256 (128+ bit Encryption), Digest-SHA-3-256 (128+ bit Encryption), Session
Return Value
Type Description
IdentityApplicationAttributesResponse Identity application attributes.

Get Peer Review Providers

Gets a list of peer review providers that can be used to review identity applications.

Properties
Can Modify: No
Can Destroy: No
Is Idempotent: Yes
Open World Access: No

GetPeerReviewProviders()

Authentication
Required: Yes
Privileges Required: OAUTH.Scope.MCP.Identity.Tools.Petition.PeerReview
Authentication Mechanisms: Bearer JWT (128+ bit Encryption), Basic (128+ bit Encryption), Digest-MD5 (128+ bit Encryption), Digest-SHA-256 (128+ bit Encryption), Digest-SHA-3-256 (128+ bit Encryption), Session
Return Value
Type Description
PeerReviewProvidersResponse Available peer review providers.

Obsolete Identity

Obsoletes one of the identities or identity applications registered by the user.

Properties
Can Modify: Yes
Can Destroy: Yes
Is Idempotent: No
Open World Access: No

ObsoleteIdentity(LegalId)

Authentication
Required: Yes
Privileges Required: OAUTH.Scope.MCP.Identity.Tools.Obsolete
Authentication Mechanisms: Bearer JWT (128+ bit Encryption), Basic (128+ bit Encryption), Digest-MD5 (128+ bit Encryption), Digest-SHA-256 (128+ bit Encryption), Digest-SHA-3-256 (128+ bit Encryption), Session
Arguments
Name Type Use Default Value Description
LegalId String Required - Legal Identity Identifier or Identity resource URI to obsolete.
Return Value
Type Description
IdentityResponse Identity obsoletion result.

Petition Legal Identity

Sends a petition to a user for one of its legal identities.

Properties
Can Modify: Yes
Can Destroy: No
Is Idempotent: No
Open World Access: Yes

PetitionLegalIdentity(LegalId, Purpose)

Authentication
Required: Yes
Privileges Required: OAUTH.Scope.MCP.Identity.Tools.Petition.Identity
Authentication Mechanisms: Bearer JWT (128+ bit Encryption), Basic (128+ bit Encryption), Digest-MD5 (128+ bit Encryption), Digest-SHA-256 (128+ bit Encryption), Digest-SHA-3-256 (128+ bit Encryption), Session
Arguments
Name Type Use Default Value Description
LegalId String Required - Identifier of Legal Identity to petition.
Purpose String Required - A message to the recipient of the petition, explaining the purpose of the petition.
Return Value
Type Description
PetitionResponse Result of operation.

Petition Peer Review

Sends a petition to a peer for a review of an identity application.

Properties
Can Modify: Yes
Can Destroy: No
Is Idempotent: No
Open World Access: Yes

PetitionPeerReview(LegalId, Purpose)

Authentication
Required: Yes
Privileges Required: OAUTH.Scope.MCP.Identity.Tools.Petition.PeerReview
Authentication Mechanisms: Bearer JWT (128+ bit Encryption), Basic (128+ bit Encryption), Digest-MD5 (128+ bit Encryption), Digest-SHA-256 (128+ bit Encryption), Digest-SHA-3-256 (128+ bit Encryption), Session
Arguments
Name Type Use Default Value Description
LegalId String Required - Identifier of Legal Identity to send the petition to.
Purpose String Required - Message to recipient of petition, explaining the purpose of the review.
Return Value
Type Description
PetitionResponse Result of operation.

Petition Digital Signature

Sends a petition to a user for a digital signature.

Properties
Can Modify: Yes
Can Destroy: No
Is Idempotent: No
Open World Access: Yes

PetitionSignature(LegalId, Content, Purpose)

Authentication
Required: Yes
Privileges Required: OAUTH.Scope.MCP.Identity.Tools.Petition.Signature
Authentication Mechanisms: Bearer JWT (128+ bit Encryption), Basic (128+ bit Encryption), Digest-MD5 (128+ bit Encryption), Digest-SHA-256 (128+ bit Encryption), Digest-SHA-3-256 (128+ bit Encryption), Session
Arguments
Name Type Use Default Value Description
LegalId String Required - Identifier of Legal Identity to petition.
Content String Required - BASE64-encoded content to sign.
Purpose String Required - A message to the recipient of the petition, explaining the purpose of the petition.
Return Value
Type Description
PetitionResponse Result of operation.

Petition Smart Contract

Sends a petition to the parts of a smart contract, for access to the smart contract.

Properties
Can Modify: Yes
Can Destroy: No
Is Idempotent: No
Open World Access: Yes

PetitionSmartContract(ContractId, Purpose)

Authentication
Required: Yes
Privileges Required: OAUTH.Scope.MCP.Identity.Tools.Petition.Contract
Authentication Mechanisms: Bearer JWT (128+ bit Encryption), Basic (128+ bit Encryption), Digest-MD5 (128+ bit Encryption), Digest-SHA-256 (128+ bit Encryption), Digest-SHA-3-256 (128+ bit Encryption), Session
Arguments
Name Type Use Default Value Description
ContractId String Required - Identifier of the Smart Contract to petition.
Purpose String Required - A message to the recipients of the petition, explaining the purpose of the petition.
Return Value
Type Description
PetitionResponse Result of operation.

Propose Smart Contract

Sends a proposal to sign a smart contract as a specific role.

Properties
Can Modify: No
Can Destroy: No
Is Idempotent: No
Open World Access: Yes

ProposeContract(ContractId, Role, To, Message)

Authentication
Required: Yes
Privileges Required: OAUTH.Scope.MCP.Identity.Tools.Contract.Propose
Authentication Mechanisms: Bearer JWT (128+ bit Encryption), Basic (128+ bit Encryption), Digest-MD5 (128+ bit Encryption), Digest-SHA-256 (128+ bit Encryption), Digest-SHA-3-256 (128+ bit Encryption), Session
Arguments
Name Type Use Default Value Description
ContractId String Required - Identifier of the Smart Contract to propose.
Role String Required - Role to propose.
To String Required - Bare JID of recipient of proposal.
Message String Required - Message to show the recipient of the proposal.
Return Value
Type Description
GenericResponse Result of operation.

Ready For Approval Identity

Reports one of the identities or identity applications registered by the user as ready for approval.

Properties
Can Modify: Yes
Can Destroy: Yes
Is Idempotent: No
Open World Access: No

ReadyForApproval(LegalId)

Authentication
Required: Yes
Privileges Required: OAUTH.Scope.MCP.Identity.Tools.ReadyForApproval
Authentication Mechanisms: Bearer JWT (128+ bit Encryption), Basic (128+ bit Encryption), Digest-MD5 (128+ bit Encryption), Digest-SHA-256 (128+ bit Encryption), Digest-SHA-3-256 (128+ bit Encryption), Session
Arguments
Name Type Use Default Value Description
LegalId String Required - Legal Identity Identifier or Identity resource URI to report as ready for approval.
Return Value
Type Description
GenericResponse Identity report result.

Remove Attachment

Removes an attachment from an identity application.

Properties
Can Modify: Yes
Can Destroy: No
Is Idempotent: No
Open World Access: No

RemoveAttachment(AttachmentId)

Authentication
Required: Yes
Privileges Required: OAUTH.Scope.MCP.Identity.Tools.Attachment.Remove
Authentication Mechanisms: Bearer JWT (128+ bit Encryption), Basic (128+ bit Encryption), Digest-MD5 (128+ bit Encryption), Digest-SHA-256 (128+ bit Encryption), Digest-SHA-3-256 (128+ bit Encryption), Session
Arguments
Name Type Use Default Value Description
AttachmentId String Required - Attachment ID to be removed.
Return Value
Type Description
IdentityResponse Identity update result.

Select Peer Review Provider

Selects an internal Peer Review provider.

Properties
Can Modify: No
Can Destroy: No
Is Idempotent: Yes
Open World Access: No

SelectPeerReviewProvider(Id, Type)

Authentication
Required: Yes
Privileges Required: OAUTH.Scope.MCP.Identity.Tools.Petition.PeerReview
Authentication Mechanisms: Bearer JWT (128+ bit Encryption), Basic (128+ bit Encryption), Digest-MD5 (128+ bit Encryption), Digest-SHA-256 (128+ bit Encryption), Digest-SHA-3-256 (128+ bit Encryption), Session
Arguments
Name Type Use Default Value Description
Id String Required - Peer Review Provider ID.
Type String Required - Peer Review Provider Type.
Return Value
Type Description
GenericResponse Result of operation.

Sign Smart Contract

Signs a smart contract as a specific role.

Properties
Can Modify: Yes
Can Destroy: No
Is Idempotent: No
Open World Access: Yes

SignContract(ContractId, Role, Transferable)

Authentication
Required: Yes
Privileges Required: OAUTH.Scope.MCP.Identity.Tools.Contract.Sign
Authentication Mechanisms: Bearer JWT (128+ bit Encryption), Basic (128+ bit Encryption), Digest-MD5 (128+ bit Encryption), Digest-SHA-256 (128+ bit Encryption), Digest-SHA-3-256 (128+ bit Encryption), Session
Arguments
Name Type Use Default Value Description
ContractId String Required - Identifier of the Smart Contract to sign.
Role String Required - Role to sign the contract as.
Transferable Boolean Optional false If the signature is transferable to another party during the life cycle of the contract.
Return Value
Type Description
ContractResponse Result of operation.

MCP Server Prompts

Following subsections list MCP Server Prompts that can be used to interact with the MCP Server.

Create Personal Legal Identity

Creates a new Legal Personal Identity for the user.

CreatePersonalLegalIdentity()

Authentication
Required: Yes
Privileges Required: OAUTH.Scope.MCP.Identity.Prompts.Create.Create.PersonalId
Authentication Mechanisms: Bearer JWT (128+ bit Encryption), Basic (128+ bit Encryption), Digest-MD5 (128+ bit Encryption), Digest-SHA-256 (128+ bit Encryption), Digest-SHA-3-256 (128+ bit Encryption), Session
Return Value
Type Description
Array of PromptMessage

Request Peer Review

Requests a Peer Review of a current Identity Application.

RequestPeerReview()

Authentication
Required: Yes
Privileges Required: OAUTH.Scope.MCP.Identity.Prompts.Create.Create.PersonalId, OAUTH.Scope.MCP.Identity.Tools.Petition.PeerReview
Authentication Mechanisms: Bearer JWT (128+ bit Encryption), Basic (128+ bit Encryption), Digest-MD5 (128+ bit Encryption), Digest-SHA-256 (128+ bit Encryption), Digest-SHA-3-256 (128+ bit Encryption), Session
Return Value
Type Description
Array of PromptMessage

MCP Server Resources

This MCP Server supports MCP Server Resources.

Resources on the MCP server represents digital identities in their various states, or petitioned smart contracts, or contract templates you have used.

Each identity has a State, a date when it was Created, a date when it was last Updated, a date from when the identity is valid to be used and a To date until when it is valid and after which it expires.

Each smart contract, or smart contract temaplte is recognized by the use of the iotsc URI scheme. Each smart contract has a State, a date when it was Created, a date when it was last updated, a duration, roles, parts who have signed the contract, parameters and human-readable and machine-readable contents.

JSON-RPC Interface

This JSON-RPC Web Service is accessible on this endpoint: https://lab.tagroot.io/MCP/Identity

The following subsections list JSON-RPC methods that are available on this resource.

initialize(ProtocolVersion, Capabilities, ClientInfo)

MCP initialize method. Called by client to initialize connection and exchange information about capabilities.

Authentication
Required: No
Arguments
Name Type Use Default Value Description
ProtocolVersion String Required - Protocol Version
Capabilities Dictionary Required - Client capabilities
ClientInfo Dictionary Required - Client information
Return Value
Type Description
Dictionary Server capabilities and information.

notifications/initialized()

Notification that the client has completed its initialization.

Authentication
Required: No

prompts/get(Name, Arguments, _Meta)

Gets an MCP server prompt.

Authentication
Required: No
Arguments
Name Type Use Default Value Description
Name String Required - Name of the prompt to call.
Arguments Dictionary Required - Arguments for the prompt.
_Meta Object Optional null Associated meta-data, if available.
Return Value
Type Description
Dictionary Dictionary containing the prompt.

prompts/list(Cursor)

Lists available MCP server prompts.

Authentication
Required: No
Arguments
Name Type Use Default Value Description
Cursor String Optional null Cursor for pagination.
Return Value
Type Description
Dictionary Dictionary containing the list of prompts.

resources/list(Cursor)

Lists available MCP server resources.

Authentication
Required: Yes
Privileges Required: OAUTH.Scope.MCP.Identity.Resources.List
Authentication Mechanisms: Bearer JWT (128+ bit Encryption), Basic (128+ bit Encryption), Digest-MD5 (128+ bit Encryption), Digest-SHA-256 (128+ bit Encryption), Digest-SHA-3-256 (128+ bit Encryption), Session
Arguments
Name Type Use Default Value Description
Cursor String Optional null
Return Value
Type Description
Dictionary

resources/read(Uri, _Meta)

Reads an MCP server resource.

Authentication
Required: Yes
Privileges Required: OAUTH.Scope.MCP.Identity.Resources.Read
Authentication Mechanisms: Bearer JWT (128+ bit Encryption), Basic (128+ bit Encryption), Digest-MD5 (128+ bit Encryption), Digest-SHA-256 (128+ bit Encryption), Digest-SHA-3-256 (128+ bit Encryption), Session
Arguments
Name Type Use Default Value Description
Uri URI Required -
_Meta Object Optional null
Return Value
Type Description
Dictionary

resources/subscribe(Uri)

Subscribes to an MCP server resource.

Authentication
Required: Yes
Privileges Required: OAUTH.Scope.MCP.Identity.Resources.List
Authentication Mechanisms: Bearer JWT (128+ bit Encryption), Basic (128+ bit Encryption), Digest-MD5 (128+ bit Encryption), Digest-SHA-256 (128+ bit Encryption), Digest-SHA-3-256 (128+ bit Encryption), Session
Arguments
Name Type Use Default Value Description
Uri URI Required -

resources/unsubscribe(Uri)

Unsubscribes from an MCP server resource.

Authentication
Required: Yes
Privileges Required: OAUTH.Scope.MCP.Identity.Resources.List
Authentication Mechanisms: Bearer JWT (128+ bit Encryption), Basic (128+ bit Encryption), Digest-MD5 (128+ bit Encryption), Digest-SHA-256 (128+ bit Encryption), Digest-SHA-3-256 (128+ bit Encryption), Session
Arguments
Name Type Use Default Value Description
Uri URI Required -

tools/call(Name, Arguments, Task, _Meta)

Calls an MCP server tool.

Authentication
Required: No
Arguments
Name Type Use Default Value Description
Name String Required - Name of the tool to call.
Arguments Dictionary Required - Arguments for the tool.
Task Object Optional null

If specified, the caller is requesting task-augmented execution for this request. The request will return a CreateTaskResult immediately, and the actual result can be retrieved later via tasks/result.

Task augmentation is subject to capability negotiation - receivers MUST declare support for task augmentation of specific request types in their capabilities.

_Meta Object Optional null Associated meta-data, if available.
Return Value
Type Description
Dictionary Dictionary containing the result of the tool call.

tools/list(Cursor)

Lists available MCP server tools.

Authentication
Required: No
Arguments
Name Type Use Default Value Description
Cursor String Optional null Cursor for pagination.
Return Value
Type Description
Dictionary Dictionary containing the list of tools.

Types

This Web Service encodes named types as JSON dictionary objects. The following subsections list the named typed and their corresponding properties.

IdentityResponse

Properties
Name Type Description
Success Boolean Indicates if the operation was successful.
Message String Message associated with the response.
Id String Identifier of the identity.
Provider String Trust Provider of the identity.
State Nullable IdentityState

State of the identity. Possible values:

  • "Created" - Created
  • "Approved" - Approved
  • "Rejected" - Rejected
  • "Obsoleted" - Obsoleted
  • "Compromised" - Compromised
Created Nullable Date & Time Date and time when the identity was created. (∞,∞)
Updated Nullable Date & Time Date and time when the identity was last updated. (∞,∞)
From Nullable Date & Time Date when the identity becomes valid. (∞,∞)
To Nullable Date & Time Date when the identity becomes invalid. (∞,∞)
Properties Array of IdentityProperty Conceptual properties associated with the digital identity.
Attachments Array of IdentityAttachment Attachments associated with the digital identity.
ClientKeyName String Name of the client key used to sign the request.
ClientPubKey BASE64-encoded binaryByte[] Public key of the client, used to sign the request.
ClientSignature BASE64-encoded binaryByte[] Signature of the request, generated by the client.

ContractResponse

Properties
Name Type Description
Contract Dictionary Current state of smart contract.
Success Boolean Indicates if the operation was successful.
Message String Message associated with the response.

IdentityApplicationAttributesResponse

Properties
Name Type Description
Success Boolean Indicates if the operation was successful.
Message String Message associated with the response.
PeerReview Nullable Boolean If peer-review is allowed as a mechanism to approve ID applications.
NrReviewers Nullable 32-bit signed integer Number of peer reviewers required to get an ID approved using peer review. [0,∞)
NrPhotos Nullable 32-bit signed integer Number of photos required in a peer-review. [0,∞)
Iso3166 Nullable Boolean If ISO 3166 country codes are mandated in peer-review.
RequiredProperties Array of String Required properties in an ID application for peer-review.

PeerReviewProvidersResponse

Properties
Name Type Description
Providers Array of PeerReviewProvider Peer review providers.
Success Boolean Indicates if the operation was successful.
Message String Message associated with the response.

PetitionResponse

Properties
Name Type Description
PetitionId String Petition identifier.
QuickResponse Dictionary Requested object available, either in cache or via earlier granted authorization.
Success Boolean Indicates if the operation was successful.
Message String Message associated with the response.

GenericResponse

Properties
Name Type Description
Success Boolean Indicates if the operation was successful.
Message String Message associated with the response.

PromptMessage

Properties
Name Type Description
Role McpRole

Role of recipient of message. Possible values:

  • "Assistant" - Message is for the assistant.
  • "User" - Message is from the user.
Content Object Content of message.
IsEncoded Boolean If the content has been encoded.
Encoded Dictionary Encoded content.

IdentityProperty

Properties
Name Type Description
Name String
Value String

IdentityAttachment

Properties
Name Type Description
Id String
LegalId String
ContentType String
FileName String
Url String
Signature BASE64-encoded binaryByte[]
Timestamp Date & Time

Byte[]

Properties
Name Type Description
Length 32-bit signed integer
LongLength 64-bit signed integer
Rank 32-bit signed integer
SyncRoot Object
IsReadOnly Boolean
IsFixedSize Boolean
IsSynchronized Boolean

PeerReviewProvider

Properties
Name Type Description
Id String Identifier of the particular service provider.
Type String Type name of service provider.
Name String Displayable name of the service provider.
IconUrl String Icon for the service provider.
IconWidth 32-bit signed integer Width of icon, in pixels.
IconHeight 32-bit signed integer Height of icon, in pixels.
LegalId String Identifier of Legal Identity of which peer reviews can be petitioned.
External Boolean If legal identity is external (true) or belongs to the server (false). Internal providers (false) must be selected before being petitioned.

Byte[]

Properties
Name Type Description
Length 32-bit signed integer
LongLength 64-bit signed integer
Rank 32-bit signed integer
SyncRoot Object
IsReadOnly Boolean
IsFixedSize Boolean
IsSynchronized Boolean