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": "2025-08-21T13:48:50.766699"
            }
        ]
    }
}

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"
}

Allocation Instruction OpenAPI Reference

Comments