Universal Registrar

Create a DID URL and associated resource

Changed on Apr 1, 2026

This endpoint creates a DID URL and associated resource. As input it takes an existing DID, a relative DID URL, a resource, plus optional DID registration options and secrets needed to create the DID URL. The output is a state object that represents the current state of the DID URL creation process.

See the DID Registration specification for additional details.

post/createResource

Request

Base URL
/1.0/ (relative, and the document was published on a file host, not at the API’s origin)
Auth
none declared
TypeScript
https://skmtc.dev/decentralized-identity/apis/universal-registrar/docs/createResource/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

didstring required

This input field indicates the DID that is the target of the DID URL create operation.

relativeDidUrlstring required

This input field indicates a relative DID URL that is the target of the DID URL create operation.

contentstring

This input field contains Base64-encoded data that is the content of the resource associated with the DID URL.

Example request

{
  "options": {
    "clientSecretMode": true,
    "network": "testnet"
  },
  "secret": {
    "seed": "72WGp7NgFR1Oqdi8zlt7jQQ434XR0cNQ",
    "verificationMethod": [
      {
        "id": "did:indy:sovrin:WRfXPg8dantKVubE3HX8pw#key-1",
        "type": "JsonWebKey2020",
        "privateKeyJwk": {
          "kty": "OKP",
          "crv": "Ed25519",
          "d": "NzJXR3A3TmdGUjFPcWRpOHpsdDdqUVE0MzRYUjBjTlE",
          "x": "jpIKKU2b77lNXKTNW2NGvw1GUMjU6v_l_tLJAH5uYz0"
        }
      }
    ]
  },
  "did": "did:indy:sovrin:WRfXPg8dantKVubE3HX8pw",
  "relativeDidUrl": "/resources/123",
  "content": "SGVsbG8gV29ybGQ="
}

Response

The request was successful, but the DID URL may not be fully created yet, as indicated by the "didState.state" and "jobId" output fields. Additional state information plus metadata are available in the response body.

didRegistrationMetadataobject

contentMetadataobject

Example response

{
  "didUrlState": {
    "secret": {
      "verificationMethod": [
        {
          "id": "did:indy:sovrin:WRfXPg8dantKVubE3HX8pw#key-1",
          "type": "JsonWebKey2020",
          "privateKeyJwk": {
            "kty": "OKP",
            "crv": "Ed25519",
            "d": "NzJXR3A3TmdGUjFPcWRpOHpsdDdqUVE0MzRYUjBjTlE",
            "x": "jpIKKU2b77lNXKTNW2NGvw1GUMjU6v_l_tLJAH5uYz0"
          }
        }
      ]
    }
  }
}

Changes

Apr 1, 2026bf85477559de Revision changes
- breaking
  added subschema #1 subschema #2 subschema #3 to the //// response property oneOf list for the response status
- breaking
  added subschema #1 subschema #2 subschema #3 to the //// response property oneOf list for the response status
- breaking
  added subschema #1 subschema #2 subschema #3 to the //// response property oneOf list for the response status
- breaking
  added subschema #1 subschema #2 subschema #3 to the //// response property oneOf list for the response status
- breaking
  the //// response's property type changed from string to no type for status
- breaking
  the //// response's property type changed from string to no type for status
- breaking
  the //// response's property type changed from string to no type for status
- breaking
  the //// response's property type changed from string to no type for status
Apr 1, 2026175d66d8fd37 Revision changes
- breaking
  the //// request property type changed from string to no type
- info
  added subschema #1 subschema #2 subschema #3 to the //// request property oneOf list

Operation history (10 revisions)