Enoki API Specification

Create zkLogin nonce

Generates a nonce used in the zkLogin OAuth flow. Using this API is not required, you can also construct a nonce client-side if desired.

Request Body

network?string

The Sui network you wish to use. Defaults to mainnet.

Default"mainnet"

Value in"testnet" | "mainnet" | "devnet"

ephemeralPublicKeystring

The ephemeral public key created during the zkLogin process, encoded as a base64 string.

additionalEpochs?number

The amount of epochs that you would like to have the nonce be valid for.

Default2

Range0 <= value <= 30

Response Body

curl -X POST "https://api.enoki.mystenlabs.com/v1/zklogin/nonce" \
  -H "Content-Type: application/json" \
  -d '{
    "ephemeralPublicKey": "string"
  }'

curl -X POST "https://api.enoki.mystenlabs.com/v1/zklogin/nonce" \  -H "Content-Type: application/json" \  -d '{    "ephemeralPublicKey": "string"  }'

{
  "data": {
    "nonce": "string",
    "randomness": "string",
    "epoch": 0,
    "maxEpoch": 0,
    "estimatedExpiration": 0
  }
}

Create zkLogin ZKP

Creates a zero-knowledge proof, which is used to submit transactions to Sui.

Header Parameters

zklogin-jwtstring

The JWT of the user signed in with zkLogin.

Request Body

network?string

The Sui network you wish to use. Defaults to mainnet.

Default"mainnet"

Value in"testnet" | "mainnet" | "devnet"

ephemeralPublicKeystring

The ephemeral public key created during the zkLogin process, encoded as a base64 string.

maxEpochinteger

The maxEpoch created during the zkLogin process.

Range0 <= value

randomnessstring

The randomness created during the zkLogin process.

Response Body

curl -X POST "https://api.enoki.mystenlabs.com/v1/zklogin/zkp" \
  -H "zklogin-jwt: string" \
  -H "Content-Type: application/json" \
  -d '{
    "ephemeralPublicKey": "string",
    "maxEpoch": 0,
    "randomness": "string"
  }'

curl -X POST "https://api.enoki.mystenlabs.com/v1/zklogin/zkp" \  -H "zklogin-jwt: string" \  -H "Content-Type: application/json" \  -d '{    "ephemeralPublicKey": "string",    "maxEpoch": 0,    "randomness": "string"  }'

{
  "data": {
    "proofPoints": null,
    "issBase64Details": null,
    "headerBase64": null,
    "addressSeed": "string"
  }
}

Create sponsored transaction

Creates sponsored transaction

Header Parameters

zklogin-jwt?string

The JWT of the user signed in with zkLogin.

Request Body

network?string

The Sui network you wish to use. Defaults to mainnet.

Default"mainnet"

Value in"testnet" | "mainnet" | "devnet"

transactionBlockKindBytesstring

Bytes of the transaction with the onlyTransactionKind flag set to true.

sender?string

The address sending the transaction. Include this parameter if not including the zklogin-jwt header. This option is only supported when calling the API from a backend service using a private key.

allowedAddresses?array<string>

List of Sui addresses that can be present in the transaction. These addresses are combined with the list configured in the Enoki Developer Portal. Transactions attempting to refer to or transfer assets outside of these addresses are rejected.

allowedMoveCallTargets?array<string>

List of permitted Move targets the sponsored user's transactions can call.

Response Body

curl -X POST "https://api.enoki.mystenlabs.com/v1/transaction-blocks/sponsor" \
  -H "zklogin-jwt: string" \
  -H "Content-Type: application/json" \
  -d '{
    "transactionBlockKindBytes": "string"
  }'

curl -X POST "https://api.enoki.mystenlabs.com/v1/transaction-blocks/sponsor" \  -H "zklogin-jwt: string" \  -H "Content-Type: application/json" \  -d '{    "transactionBlockKindBytes": "string"  }'

{
  "data": {
    "digest": "string",
    "bytes": "string"
  }
}

Submits a sponsored transaction for execution

Submits a transaction created from /transaction-blocks/sponsor for execution.

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

digeststring

The digest of the previously-created sponsored transaction block to execute.

Request Body

signaturestring

User signature of the transaction.

Response Body

curl -X POST "https://api.enoki.mystenlabs.com/v1/transaction-blocks/sponsor/string" \
  -H "Content-Type: application/json" \
  -d '{
    "signature": "string"
  }'

curl -X POST "https://api.enoki.mystenlabs.com/v1/transaction-blocks/sponsor/string" \  -H "Content-Type: application/json" \  -d '{    "signature": "string"  }'

{
  "data": {
    "digest": "string"
  }
}

Get address for zkLogin user

Returns the address and salt value for the given JWT. If the JWT is not valid, the API will return an error code.

Authorization

AuthorizationBearer <token>

In: header

Header Parameters

zklogin-jwtstring

The JWT of the user signed in with zkLogin.

Response Body

curl -X GET "https://api.enoki.mystenlabs.com/v1/zklogin" \
  -H "zklogin-jwt: string"

curl -X GET "https://api.enoki.mystenlabs.com/v1/zklogin" \  -H "zklogin-jwt: string"

{
  "data": {
    "salt": "string",
    "address": "string",
    "publicKey": "string"
  }
}

Get addresses for zkLogin user

Returns the addresses for a given JWT. If the JWT is not valid, the API will return an error code.

Authorization

AuthorizationBearer <token>

In: header

Header Parameters

zklogin-jwtstring

The JWT of the user signed in with zkLogin.

Response Body

curl -X GET "https://api.enoki.mystenlabs.com/v1/zklogin/addresses" \
  -H "zklogin-jwt: string"

curl -X GET "https://api.enoki.mystenlabs.com/v1/zklogin/addresses" \  -H "zklogin-jwt: string"

{
  "data": {
    "addresses": [
      {
        "clientId": "string",
        "salt": "string",
        "address": "string",
        "publicKey": "string",
        "legacy": true
      }
    ]
  }
}

Get app metadata

Returns the public metadata (configured in the Enoki Developer Portal) of the app associated with the API key.

Authorization

AuthorizationBearer <token>

In: header

Response Body

curl -X GET "https://api.enoki.mystenlabs.com/v1/app"

curl -X GET "https://api.enoki.mystenlabs.com/v1/app"

{
  "data": {
    "allowedOrigins": [
      "https://example.com"
    ],
    "authenticationProviders": [
      {
        "providerType": "google",
        "clientId": "..."
      }
    ],
    "domains": [
      {
        "nftId": "string",
        "name": "string",
        "network": "testnet"
      }
    ]
  }
}

Get a list of subnames for an address

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

network?string

The network subnames are registered on.

Default"mainnet"

Value in"testnet" | "mainnet"

domain?string

The domain name the subname is on.

address?string

The address to resolve subnames for

Response Body

curl -X GET "https://api.enoki.mystenlabs.com/v1/subnames?network=testnet&domain=string&address=string"

curl -X GET "https://api.enoki.mystenlabs.com/v1/subnames?network=testnet&domain=string&address=string"

{
  "data": {
    "subnames": [
      {
        "name": "string",
        "status": "PENDING",
        "createdAt": "2025-08-06T14:30:00.000Z"
      }
    ]
  }
}

Create a subname

Initiates the creation of a subname. The subname request is added to a processing queue and will be created asynchronously, typically within a few seconds. Note: A successful response from this API does not guarantee that the subname has been created yet. To check the status of the subname, use the get subname API or resolve the name directly on Sui.

Authorization

AuthorizationBearer <token>

In: header

Header Parameters

zklogin-jwt?string

The JWT of the user signed in with zkLogin.

Request Body

domainstring

The domain name to create the subname under.

network?string

The network the domain and subname are registered on.

Default"mainnet"

Value in"testnet" | "mainnet"

subnamestring

The subname to create.

targetAddress?string

The address the new subname will resolve to

Response Body

curl -X POST "https://api.enoki.mystenlabs.com/v1/subnames" \
  -H "zklogin-jwt: string" \
  -H "Content-Type: application/json" \
  -d '{
    "domain": "string",
    "subname": "string"
  }'

curl -X POST "https://api.enoki.mystenlabs.com/v1/subnames" \  -H "zklogin-jwt: string" \  -H "Content-Type: application/json" \  -d '{    "domain": "string",    "subname": "string"  }'

{
  "data": {
    "name": "string",
    "status": "PENDING",
    "createdAt": "2025-08-06T14:30:00.000Z"
  }
}

Delete a subname

Initiates the deletion of a subname. The subname request is added to a processing queue and will be deleted asynchronously, typically within a few seconds. Note: A successful response from this API does not guarantee that the subname has been deleted yet. To check the status of the subname, use the get subname API or resolve the name directly on Sui.

Authorization

AuthorizationBearer <token>

In: header

Request Body

domainstring

The domain name the subname is on.

network?string

The network the domain and subname are registered on.

Default"mainnet"

Value in"testnet" | "mainnet"

subnamestring

The subname to delete.

targetAddress?string

The address the new subname will resolve to

Response Body

curl -X DELETE "https://api.enoki.mystenlabs.com/v1/subnames" \
  -H "Content-Type: application/json" \
  -d '{
    "domain": "string",
    "subname": "string"
  }'

curl -X DELETE "https://api.enoki.mystenlabs.com/v1/subnames" \  -H "Content-Type: application/json" \  -d '{    "domain": "string",    "subname": "string"  }'

{
  "data": {
    "name": "string",
    "status": "PENDING",
    "createdAt": "2025-08-06T14:30:00.000Z"
  }
}

Enoki API Specification

200

200

200

200

200

200

200

200

202

202