Issue & Transfer

to issue or issue+transfer SRR

POST <base_url>/port/api/v1/commerce/srrs

Please replace <base_url> as explained here.

Precaution

Multiple issuance

Feel free to include more than one issuance in a single request via the payload array. The minimum number of issue requests is one. Though there is no fixed upper limit for the number of issue requests you can submit at one time, we recommend limiting batches to no more than 250 issue requests for optimal processing.

issue to issuer

If payload[*].to is not given, your SRR will be issued to your luw address

Headers

Name

Type

Description

commerce-api-key*

string

Commerce API Key

issuer-address*

string

Contract Address of API Key owner

Request Body

Name

Type

Description

requestId

string

A requestId given by the caller, to ensure requests are only processed once. If the requestId is known and processed before, api will not process this call again, and respond with an error. A good practice is using random UUID.

*requestId must be unique for a given issuer-address. As a result any duplicate combination of requestId and issuer-address is instantly rejected with no impact on either.

payload*

array

Array of issue requests. Further constraints explained above.

payload[*].externalId*

string

An ID to identify the record in your system. We recommend to use UUID, but it can use any string as long it is unique in your system.

payload[*].metadata*

object

The metadata to be issued as a complex object. Detailed schema specification can be found here.

The API accepts versions 2.0 and higher.

payload[*].artistAddress*

string

The ethereum address of the artist of the artwork.

payload[*].isPrimaryIssuer*

boolean

If you are the primary issuer of this NFT, set this to true.

payload[*].lockExternalTransfer*

boolean

If you want to prevent your NFTs to be transferred on decentralized marketplaces, set this to true.

payload[*].to

string

Ethereum address target the NFT should be sent to after minting (Issue on Buyer).

If none is given the NFT will be minted into your LUW by default.

payload[*].attachmentFiles

Array<object>

Attachment files that will be included in SRR.

payload[*].attachmentFiles[*].name

string

The name of file.

This is used for when the file is downloaded or shown. The extension is recommended to be the same as the actual uploaded file.

payload[*].attachmentFiles[*].category

string

Please refer to this page to understand the difference among the categories.

Please note that contract terms and thumbnail are NOT attachment files. The URL for contract terms and thumbnail are needed for metadata. (See metadata attribute)

payload[*].attachmentFiles[*].url

string

The URL must be under Startbahn's GCS bucket. Use the finalUrl field returned by the signed URL endpoint, or a URL that Startbahn has pre-provisioned for you. Any other URL is rejected without issuing the SRR.

For each attachmentFiles entry, the API resolves the URL to its GCS path, reads the precomputed SHA-256 from the storage object metadata, and folds {category, hash} entries into metadata.digitalComponents (artwork category) or metadata.attachmentFiles (other categories) before issuance. You do not need to populate those metadata sub-fields yourself.

payload[*].collectionAddress

string

The address of collection that the SRR will belong to. This collection must be owned by the caller issuer-address.

payload[*].externalUrls

Array<string>

Deprecated. Use the external_url field in metadata.

To remain backward compatible the external URLs is still allowed and is simply passing the first string in the array to the metadata as external_url). This mapping is redundant and will be removed.

The API responds with 201. see Response Body results[*].status for details of each entry.

Body Attribute

Description

Format

results

results of the request

Array

results[*].srr

Minimal identifying details of the issued SRR. Richer information (issuer, artist, collection details, on-chain metadata, history, ownership) must be queried from the subgraph once the transaction is mined.

object

results[*].srr.tokenId

NFT token ID of the SRR.

string

results[*].srr.metadataCID

IPFS CID of the SRR metadata. Resolve via the Startrail IPFS CDN gateway: https://cdn.startrail.io/ipfs/<cid>. See IPFS CDN gateway.

string

results[*].srr.metadataURL

Convenience HTTPS URL that resolves the SRR metadata via the Startrail IPFS CDN gateway. Same content as metadataCID resolved through https://cdn.startrail.io/ipfs/.

string

results[*].srr.collectionContractAddress

Collection contract address the SRR belongs to. null if the SRR was not issued under a custom collection.

string | null

results[*].externalId

ID to identify the SRR. Defined by the client when calling.

string

results[*].status

waiting_for_mining – wait for completion of blockchain mining. The status (and any further SRR data) can then be confirmed via the subgraph or less favorably via the Get SRR by Token Id REST endpoint.

string

Response shape change

The response intentionally returns only the minimum identifiers needed to track the issued SRR (tokenId, metadataCID, metadataURL, collectionContractAddress). Fields previously returned by this endpoint such as srr.issuer, srr.artist, srr.collection.{name,symbol}, srr.isPrimaryIssuer, srr.issuedAt, srr.metadata.{json,originalJson,digest}, srr.createdAt and srr.updatedAt are no longer part of the issuance response.

To read SRR data after issuance:

Use the subgraph for issuer, artist, collection, ownership, history and provenance information (authoritative source).
Use the Startrail IPFS CDN gateway (https://cdn.startrail.io/ipfs/<cid>) to fetch the SRR metadata JSON, attachment files and images by their CID.

{
  "results": [
    {
      "status": "waiting_for_mining",
      "srr": {
        "tokenId": "227890056407",
        "metadataCID": "bafkreiabepvyxyetkcb3xbjo3ocuyfo6psv3rc3yj34hequwcsilyvjima",
        "metadataURL": "https://cdn.startrail.io/ipfs/bafkreiabepvyxyetkcb3xbjo3ocuyfo6psv3rc3yj34hequwcsilyvjima",
        "collectionContractAddress": "0x7942627305545AF0e6c826d54cC9b2c5D190A874"
      },
      "externalId": "c0456840-5bdf-4375-a6ce-106697b7dfb7"
    }
  ]
}

The API responds with 400 if request body invalid or some validation errors that can be instantly detected.

// If the metadata is same with another previous SRR
{
  "statusCode": 400,
  "message": {
    "results": [
      {
        "status": "failed",
        "externalId": "c0456840-5bdf-4375-a6ce-106697b7dfb7",
        "message": "DUPLICATE_METADATA"
      }
    ]
  }
}

{
  "statusCode": 400,
  "message": {
    "results": [
      {
        "status": "failed",
        "externalId": "c0456840-5bdf-4375-a6ce-106697b7dfb7",
        "message": "DUPLICATE_CHIP"
      }
    ]
  }
}


{
    "statusCode": 400,
    "message": "Request Content Error: Current request already logged with status successful"
}


{
    "statusCode": 400,
    "message": {
        "results": [
            {
                "status": "failed",
                "externalId": "bulk20122fdredcd2dfve",
                "message": "UNKNOWN_ERROR: external ID: bulk20122fdredcd2dfve."
            }
        ]
    }
}

{
  "statusCode": 400,
  "message": {
    "results": [
      {
        "status": "failed",
        "externalId": "c0456840-5bdf-4375-a6ce-106697b7dfb7",
        "message": "UNKNOWN_ARTIST"
      }
    ]
  }
}

// If metadata with issuer and artist combination is already sent
{
  "statusCode": 400,
  "message": "Request Content Error: Current request already logged with status successful"
}

// DTO validation error
{
    "statusCode": 400,
    "message": [
        "payload.0.metadata is invalid. Check it against the metadata JSON schema. Details:  should have required property 'title' ({\"missingProperty\":\"title\"}).",
        "payload.0.artistAddress must be a valid Ethereum addresses",
        "payload.0.externalId should not be empty",
        "payload.0.externalId must be a string"
    ]
}

Multiple issuance

In case of multiple/bulk issuance as soon as one case failed, the rest of the payload will be definitely failed as well.

Example of duplicated metadata

{
    "statusCode": 400,
    "message": {
        "results": [
            {
                "status": "failed",
                "externalId": "anId",
                "message": "DUPLICATE_METADATA"
            },
            {
                "status": "failed",
                "externalId": "anId",
                "message": "SRR_NOT_CREATED: Not created because there is SRR in the same batch that error"
            }
        ]
    }
}

Example of DTO validation error

{
    "statusCode": 400,
    "message": [
        "payload.1.metadata is invalid. Check it against the metadata JSON schema. Details:  should have required property 'title' ({\"missingProperty\":\"title\"}).",
        "payload.1.artistAddress must be a valid Ethereum addresses",
        "payload.1.externalId should not be empty",
        "payload.1.externalId must be a string"
    ]
}

The API responds with 5xx if there are other issues, such as deeper validation errors.

// For example in case of collection ownership issue
{
  "statusCode": 500,
  "message": "STARTRAIL_ERROR: <reason>"
}

// In case there is unknown error. Please contact us.
{
  "statusCode": 500,
  "message": "UNKNOWN_ERROR: external ID: xxxx"
}

Swagger Endpoint (Test Environment)

Swagger to test

Required Permissions

Check the parent page.

Request Body Example

{
  "requestId": "0004f572-7769-4b8b-8108-a13a36cd88d4",
  "payload": [
    {
      "externalId": "0004f572-7769-4b8b-8108-a13a36cd88d4",
      "metadata": {
        "$schema": "https://api.startrail.io/api/v1/schema/registry-record-metadata.v2.1.schema.json",
        "$schemaIntegrity": "sha256-15f8e99eb9d4292287282942db2f2de9bbcc4761c555c6f7da23feec010c1221",
        "title": {
          "en": "A title",
          "ja": "タイトル",
          "zh": "一个标题"
        },
        "size": {
          "width": 200,
          "height": 400,
          "depth": 12.4,
          "unit": "pixel",
          "flexibleDescription": {
            "en": "flexibleDescription comes here",
            "ja": "自由だーーー"
          }
        },
        "medium": {
          "en": "Oil on canvas",
          "ja": "キャンバスに油彩",
          "zh": "布面油画"
        },
        "edition": {
          "uniqueness": "unique work",
          "proofType": "ED",
          "number": 1,
          "totalNumber": 3,
          "note": {
            "en": "some extra notes in 1 or more languages"
          }
        },
        "contractTerms": {
          "royaltyRate": 15.7,
          "fileURL": "https://startrail.io/whitepaper/startrail_wp_en_v1.1.pdf"
        },
        "note": {
          "en": "note",
          "zh": "注意"
        },
        "thumbnailURL": "https://storage.googleapis.com/opensea-prod.appspot.com/puffs/3.png",
        "yearOfCreation": {
          "en": "around 2010-2020",
          "ja": "2010年から2020年頃"
        },
        "isDigital": true,
        "name": "some nft name",
        "description": "some nft description",
        "image": "https://storage.googleapis.com/opensea-prod.appspot.com/puffs/3.png",
        "external_url": "https://openseacreatures.io/3"
      },
      "artistAddress": "0x36E9f4C26357FDb14AdF939a12AdBba92a209C01",
      "isPrimaryIssuer": true,
      "lockExternalTransfer": false,
      "to": "0x36E9f4C26357FDb14AdF939a12AdBba92a209C01",
      "collectionAddress": "0xfbF4C1A1eb4258aE0F74807f6c1e854918DC8ed3",
      "attachmentFiles": [
        {
          "name": "image-example.jpg",
          "url": "https://static-files-stg.startrail.startbahn.jp/srr-images/image-example.jpg",
          "category": "artwork"
        },
        {
          "name": "certificate-example.jpg",
          "url": "https://static-files-stg.startrail.startbahn.jp/srr-images/certificate-example.jpg",
          "category": "certificate"
        },
        {
          "name": "for_authenticity.jpg",
          "url": "https://static-files-stg.startrail.startbahn.jp/srr-images/for_authenticity.jpg",
          "category": "for_authenticity"
        },
        {
          "name": "installation.jpg",
          "url": "https://static-files-stg.startrail.startbahn.jp/srr-images/installation.jpg",
          "category": "installation"
        }
      ]
    }
  ]
}

Code Example

Check parent page.

If you have a TAG for a physical artwork please add

chipUIDs and startbahnCertICTagUIDs both at the same time and they both need to contain the same value. The value is an array containing the list of the Chip UIDs. For example

"startbahnCertICTagUIDs": [
    "1234567890abcdef"
],
"chipUIDs": [
    "1234567890abcdef"
],

PreviousFile Information Metadata NextWebhook Setup

Last updated 8 days ago

Was this helpful?