Type Definitions

This page provides detailed information about the type definitions used in the Trust Engine SDK.

`createWallet`

Options

userID

string

required

Unique identifier for the user.

Response

message

string

A success message.

details

object

An object containing the details of the created wallet.

Show child attributes

walletAddress

string

The address of the new wallet.

chain

string

The blockchain the wallet was created on.

transactionId

string

The ID of the transaction that created the wallet.

explorerUrl

string

A URL to view the transaction on a block explorer.

userID

string

User ID connected to the wallet address

`registerFile`

Options

file

File

required

The file to register.

contentTitle

string

required

The title of the content.

walletAddress

string

required

The address of the wallet to register the file with.

walletType

'self' | 'managed'

required

The type of wallet to use.

metadata

string

Additional metadata to store with the file.

signTransaction

(transaction: Transaction) => Promise<Transaction>

A function to sign a transaction. Usually a function from your wallet provider (Phantom, Metamask, etc. )

Response

The response from registering a file. This can vary depending on whether the wallet type is 'self' or 'managed'.

For Managed Wallets (200 OK)

message

string

A success message.

details

object

An object containing the details of the registration.

Show child attributes

status

string

The status of the registration.

transactionId

string

The ID of the transaction that registered the file.

contentRegistrationPDA

string

The Program Derived Address for the registration.

contentHash

string

The SHA256 hash of the file content.

ipfsCid

string

The IPFS CID of the file.

explorerUrl

string

A URL to view the transaction on a block explorer.

For Self Wallets (202 Accepted)

message

string

A success message.

details

object

An object containing the details of the registration.

Show child attributes

status

string

The status of the registration.

transaction

string

A base64 encoded transaction that needs to be signed by the client.

ipfsCid

string

The IPFS CID of the file.

contentRegistrationPDA

string

The Program Derived Address for the registration.

contentHash

string

The SHA256 hash of the file content.

`searchFile`

Parameters

file

File

required

The file to search for.

walletAddress

string

Optional wallet address to filter search results to specific registrations.

Response

searchMode

string

The type of search performed.

message

string

A message indicating the search results.

searchCriteria

object

The search parameters that were used.

Show child attributes

contentHash

string

The content hash that was searched for.

totalResults

number

Number of registration records found.

registrations

Array<object>

An array of objects, where each object contains the details of a registration record.

Show child attributes

title

string

The chosen title of the registration

contentHash

string

The SHA256 hash of the file content.

pdaAddress

string

The Program Derived Address for the registration.

ipfsCid

string

The IPFS Content Identifier for metadata storage.

registeredBy

string

The wallet address that registered the file.

userID

string | null

The user ID associated with the creator of the file (null if no relation found).

timestamp

string

ISO timestamp when file was registered.

status

string

Status of the registration.

explorerUrl

string

Link to view on Solana Explorer.

metadata

string

Optional metadata about the file from the user

identity_data

object

Identity data they decided to reveal about themselves

`linkWallet`

Options

userID

string

required

The user’s ID.

walletAddress

string

required

The user’s wallet address.

Response

message

string

A success message.

details

object

An object containing the details of the user-key relation.

Show child attributes

userID

string

The user’s ID.

walletAddress

string

The user’s wallet address.

status

string

The transaction status.

transactionId

string

The ID of the transaction that stored the user-key relation.

explorerUrl

string

A URL to view the transaction on a block explorer.

`submitTransaction`

Options

transaction

string

required

A base64 encoded transaction.

Response

message

string

A success message.

details

object

An object containing the details of the transaction.

Show child attributes

transactionId

string

The ID of the transaction.

explorerUrl

string

A URL to view the transaction on a block explorer.

`verifyIdentity`

Options

walletAddress

string

required

Valid Solana wallet address (Base58 format). Must have an existing user-key relation in the system.

disclosures

IdentityDisclosures

required

Object specifying which identity fields to request verification for. All 7 fields must be explicitly provided with boolean values. At least one field must be set to true.

Show child attributes

issuing_state

boolean

Country/state that issued the ID document.

name

boolean

Full name from ID document.

nationality

boolean

Nationality/citizenship.

date_of_birth

boolean

Date of birth.

passport_number

boolean

Document/passport number.

gender

boolean

Gender from ID document.

expiry_date

boolean

Document expiration date.

Response

New Session Created (201)

message

string

Confirmation that the identity verification session was created.

details

object

Session information and verification instructions.

Show child attributes

qrCodeUrl

string

URL for identity verification that can be opened in Self.xyz app.

walletAddress

string

The wallet address for this verification session.

selectedDisclosures

object

Object showing which identity fields were requested (only shows true values).

status

string

Current verification status: "pending".

createdAt

string

ISO timestamp when the session was created.

expiresAt

string

ISO timestamp when the session expires (24 hours from creation).

instructions

string

User-friendly instructions for completing verification.

Existing Session Found (200)

message

string

Message indicating an existing pending session was found.

details

object

Existing session information.

Show child attributes

qrCodeUrl

string

URL for identity verification.

walletAddress

string

The wallet address for this verification session.

requestedDisclosures

object

All disclosure fields with boolean values.

status

string

Current verification status: "pending".

createdAt

string

ISO timestamp when the session was created.

expiresAt

string

ISO timestamp when the session expires.

instructions

string

Instructions for the existing session.

`checkIdentityStatus`

Parameters

walletAddress

string

required

Valid Solana wallet address (Base58 format) to check verification status for.

Response

message

string

Confirmation that the session was retrieved successfully.

details

object

Complete session information and verification data.

Show child attributes

walletAddress

string

The wallet address for this verification session.

status

'pending' | 'verified' | 'failed' | 'expired'

Current verification status.

createdAt

string

ISO timestamp when the session was created.

expiresAt

string

ISO timestamp when the session expires (24 hours from creation).

verifiedAt

string | null

ISO timestamp when verification was completed (null if not yet verified).

requestedDisclosures

object

Object showing which identity fields were requested for verification.

Show child attributes

issuing_state

boolean

Whether issuing state was requested.

name

boolean

Whether name was requested.

nationality

boolean

Whether nationality was requested.

date_of_birth

boolean

Whether date of birth was requested.

passport_number

boolean

Whether passport number was requested.

gender

boolean

Whether gender was requested.

expiry_date

boolean

Whether expiry date was requested.

verifiedData

object | null

Contains the actual verified identity data (only present when status is ‘verified’).

Show child attributes

verified_issuing_state

string | null

Country/state that issued the ID document.

verified_name

string | null

Full name from the ID document.

verified_nationality

string | null

Nationality/citizenship.

verified_date_of_birth

string | null

Date of birth from the document.

verified_passport_number

string | null

Document/passport number.

verified_gender

string | null

Gender from the ID document.

verified_expiry_date

string | null

Document expiration date.

self_user_id

string

Unique identifier from Self.xyz verification system.

`findWallet`

Options

userID

string

The user’s ID.

walletAddress

string

The user’s wallet address.

Response

success

boolean

Whether the request was successful.

message

string

A message describing the result of the request.

details

object

An object containing the details of the found wallet.

Show child attributes

searchType

string

The type of search that was performed.

searchValue

string

The value that was searched for.

relation

object

An object containing the details of the wallet relation.

Show child attributes

userId

string

The user’s ID.

walletAddress

string

The user’s wallet address.

createdAt

string

The date the relation was created.

relationPDA

string

The Program Derived Address for the relation.

Getting Started

Functions

Types

Types

Type Definitions

`createWallet`

Options

Response

`registerFile`

Options

Response

For Managed Wallets (200 OK)

For Self Wallets (202 Accepted)

`searchFile`

Parameters

Response

`linkWallet`

Options

Response

`submitTransaction`

Options

Response

`verifyIdentity`

Options

Response

New Session Created (201)

Existing Session Found (200)

`checkIdentityStatus`

Parameters

Response

`findWallet`

Options

Response

Getting Started

Functions

Types

​Type Definitions

​createWallet

​Options

​Response

​registerFile

​Options

​Response

​For Managed Wallets (200 OK)

​For Self Wallets (202 Accepted)

​searchFile

​Parameters

​Response

​linkWallet

​Options

​Response

​submitTransaction

​Options

​Response

​verifyIdentity

​Options

​Response

​New Session Created (201)

​Existing Session Found (200)

​checkIdentityStatus

​Parameters

​Response

​findWallet

​Options

​Response

Type Definitions

`createWallet`

Options

Response

`registerFile`

Options

Response

For Managed Wallets (200 OK)

For Self Wallets (202 Accepted)

`searchFile`

Parameters

Response

`linkWallet`

Options

Response

`submitTransaction`

Options

Response

`verifyIdentity`

Options

Response

New Session Created (201)

Existing Session Found (200)

`checkIdentityStatus`

Parameters

Response

`findWallet`

Options

Response