Skip to content
Documentation/Canton SDK/Token Standard APIs Allocation Instruction OpenAPI ReferenceView on Canton SDK
Canton SDK/Token Standard APIs Allocation Instruction OpenAPI Reference

Allocation Instruction OpenAPI Reference

Deprecated

This Splice documentation site is deprecated. Use the current Canton Network docs.

Open current docs

Allocation Instruction OpenAPI Reference

POST /registry/allocation-instruction/v1/allocation-factory

Get the factory and choice context for creating allocations using the AllocationFactory_Allocate choice.

Example request:

POST /registry/allocation-instruction/v1/allocation-factory HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "choiceArguments": {},
    "excludeDebugFields": true
}
Status Codes:
  • 200 OK

    ok

    Example response:

    HTTP/1.1 200 OK
    Content-Type: application/json
    
    {
        "factoryId": "string",
        "choiceContext": {
            "choiceContextData": {},
            "disclosedContracts": [
                {
                    "templateId": "string",
                    "contractId": "string",
                    "createdEventBlob": "string",
                    "synchronizerId": "string",
                    "debugPackageName": "string",
                    "debugPayload": {},
                    "debugCreatedAt": "2026-06-04T17:18:55.929896"
                }
            ]
        }
    }
    
  • 400 Bad Request

    bad request

    Example response:

    HTTP/1.1 400 Bad Request
    Content-Type: application/json
    
    {
        "error": "string"
    }
    
  • 404 Not Found

    not found

    Example response:

    HTTP/1.1 404 Not Found
    Content-Type: application/json
    
    {
        "error": "string"
    }
    

Comments